/*
+ * This file is part of the GROMACS molecular simulation package.
*
- * This source code is part of
+ * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
*
- * G R O M A C S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
*
- * GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
*
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
*/
/*! \internal \file
* \brief
* Implements registerTrajectoryAnalysisModules().
*
- * \author Teemu Murtola <teemu.murtola@cbr.su.se>
+ * \author Teemu Murtola <teemu.murtola@gmail.com>
* \ingroup module_trajectoryanalysis
*/
-#include "gromacs/trajectoryanalysis/modules.h"
+#include "gmxpre.h"
+
+#include "modules.h"
-#include "gromacs/commandline/cmdlinemodule.h"
#include "gromacs/commandline/cmdlinemodulemanager.h"
#include "gromacs/trajectoryanalysis/cmdlinerunner.h"
#include "modules/angle.h"
#include "modules/distance.h"
+#include "modules/freevolume.h"
+#include "modules/sasa.h"
#include "modules/select.h"
namespace gmx
namespace
{
-/*! \internal \brief
- * Base class for trajectory analysis module command-line wrappers.
- *
- * This class exists to avoid multiple identical copies of the \p run() method
- * to be generated for the TrajAnalysisCmdLineWrapper template classes.
- *
- * \ingroup module_trajectoryanalysis
- */
-class AbstractTrajAnalysisCmdLineWrapper : public CommandLineModuleInterface
-{
- public:
- virtual const char *name() const = 0;
- virtual const char *shortDescription() const = 0;
-
- virtual int run(int argc, char *argv[]);
- virtual void writeHelp(File *file) const;
-
- protected:
- //! Creates the analysis module for this wrapper.
- virtual TrajectoryAnalysisModulePointer createModule() const = 0;
-};
-
-int AbstractTrajAnalysisCmdLineWrapper::run(int argc, char *argv[])
-{
- TrajectoryAnalysisModulePointer module(createModule());
- TrajectoryAnalysisCommandLineRunner runner(module.get());
- runner.setPrintCopyright(false);
- return runner.run(argc, argv);
-}
-
-void AbstractTrajAnalysisCmdLineWrapper::writeHelp(File *file) const
-{
- TrajectoryAnalysisModulePointer module(createModule());
- TrajectoryAnalysisCommandLineRunner runner(module.get());
- runner.writeHelp(file);
-}
-
-/*! \internal \brief
- * Template for command-line wrapper of a trajectory analysis module.
+/*! \brief
+ * Convenience method for registering a command-line module for trajectory
+ * analysis.
*
- * \tparam Module Trajectory analysis module to wrap.
+ * \tparam ModuleInfo Info about trajectory analysis module to wrap.
*
- * \p Module should be default-constructible, derive from
- * TrajectoryAnalysisModule, and have a static public members
- * \c "const char name[]" and \c "const char shortDescription[]".
+ * \p ModuleInfo should have static public members
+ * `const char name[]`, `const char shortDescription[]`, and
+ * `gmx::TrajectoryAnalysisModulePointer create()`.
*
* \ingroup module_trajectoryanalysis
*/
-template <class Module>
-class TrajAnalysisCmdLineWrapper : public AbstractTrajAnalysisCmdLineWrapper
+template <class ModuleInfo>
+void registerModule(CommandLineModuleManager *manager,
+ CommandLineModuleGroup group)
{
- public:
- virtual const char *name() const
- {
- return Module::name;
- }
- virtual const char *shortDescription() const
- {
- return Module::shortDescription;
- }
- virtual TrajectoryAnalysisModulePointer createModule() const
- {
- return TrajectoryAnalysisModulePointer(new Module);
- }
-};
+ TrajectoryAnalysisCommandLineRunner::registerModule(
+ manager, ModuleInfo::name, ModuleInfo::shortDescription,
+ &ModuleInfo::create);
+ group.addModule(ModuleInfo::name);
+}
-} // namespace
+} // namespace
+//! \cond libapi
void registerTrajectoryAnalysisModules(CommandLineModuleManager *manager)
{
using namespace gmx::analysismodules;
- manager->registerModule<TrajAnalysisCmdLineWrapper<Angle> >();
- manager->registerModule<TrajAnalysisCmdLineWrapper<Distance> >();
- manager->registerModule<TrajAnalysisCmdLineWrapper<Select> >();
+ CommandLineModuleGroup group = manager->addModuleGroup("Trajectory analysis");
+ registerModule<AngleInfo>(manager, group);
+ registerModule<DistanceInfo>(manager, group);
+ registerModule<FreeVolumeInfo>(manager, group);
+ registerModule<SasaInfo>(manager, group);
+ registerModule<SelectInfo>(manager, group);
}
+//! \endcond
} // namespace gmx
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff