src/gromacs/trajectoryanalysis/modules.cpp

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * directory and at http://www.gromacs.org.
   8  *
   9  * GROMACS is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 2.1
  12  * of the License, or (at your option) any later version.
  13  *
  14  * GROMACS is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with GROMACS; if not, see
  21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  23  *
  24  * If you want to redistribute modifications to GROMACS, please
  25  * consider that scientific software is very special. Version
  26  * control is crucial - bugs must be traceable. We will be happy to
  27  * consider code for inclusion in the official distribution, but
  28  * derived work must not be called official GROMACS. Details are found
  29  * in the README & COPYING files - if they are missing, get the
  30  * official version at http://www.gromacs.org.
  31  *
  32  * To help us fund GROMACS development, we humbly ask that you cite
  33  * the research papers on the package. Check out http://www.gromacs.org.
  34  */
  35 /*! \internal \file
  36  * \brief
  37  * Implements registerTrajectoryAnalysisModules().
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_trajectoryanalysis
  41  */
  42 #include "gromacs/trajectoryanalysis/modules.h"
  43
  44 #include "gromacs/commandline/cmdlinemodule.h"
  45 #include "gromacs/commandline/cmdlinemodulemanager.h"
  46 #include "gromacs/trajectoryanalysis/cmdlinerunner.h"
  47
  48 #include "modules/angle.h"
  49 #include "modules/distance.h"
  50 #include "modules/freevolume.h"
  51 #include "modules/select.h"
  52
  53 namespace gmx
  54 {
  55
  56 namespace
  57 {
  58
  59 /*! \internal \brief
  60  * Base class for trajectory analysis module command-line wrappers.
  61  *
  62  * This class exists to avoid multiple identical copies of the \p run() method
  63  * to be generated for the TrajAnalysisCmdLineWrapper template classes.
  64  *
  65  * \ingroup module_trajectoryanalysis
  66  */
  67 class AbstractTrajAnalysisCmdLineWrapper : public CommandLineModuleInterface
  68 {
  69     public:
  70         virtual const char *name() const             = 0;
  71         virtual const char *shortDescription() const = 0;
  72
  73         virtual int run(int argc, char *argv[]);
  74         virtual void writeHelp(const HelpWriterContext &context) const;
  75
  76     protected:
  77         //! Creates the analysis module for this wrapper.
  78         virtual TrajectoryAnalysisModulePointer createModule() const = 0;
  79 };
  80
  81 int AbstractTrajAnalysisCmdLineWrapper::run(int argc, char *argv[])
  82 {
  83     TrajectoryAnalysisModulePointer     module(createModule());
  84     TrajectoryAnalysisCommandLineRunner runner(module.get());
  85     runner.setPrintCopyright(false);
  86     return runner.run(argc, argv);
  87 }
  88
  89 void AbstractTrajAnalysisCmdLineWrapper::writeHelp(const HelpWriterContext &context) const
  90 {
  91     TrajectoryAnalysisModulePointer     module(createModule());
  92     TrajectoryAnalysisCommandLineRunner runner(module.get());
  93     runner.writeHelp(context);
  94 }
  95
  96 /*! \internal \brief
  97  * Template for command-line wrapper of a trajectory analysis module.
  98  *
  99  * \tparam Module  Trajectory analysis module to wrap.
 100  *
 101  * \p Module should be default-constructible, derive from
 102  * TrajectoryAnalysisModule, and have a static public members
 103  * \c "const char name[]" and \c "const char shortDescription[]".
 104  *
 105  * \ingroup module_trajectoryanalysis
 106  */
 107 template <class Module>
 108 class TrajAnalysisCmdLineWrapper : public AbstractTrajAnalysisCmdLineWrapper
 109 {
 110     public:
 111         virtual const char *name() const
 112         {
 113             return Module::name;
 114         }
 115         virtual const char *shortDescription() const
 116         {
 117             return Module::shortDescription;
 118         }
 119         virtual TrajectoryAnalysisModulePointer createModule() const
 120         {
 121             return TrajectoryAnalysisModulePointer(new Module);
 122         }
 123 };
 124
 125 }   // namespace
 126
 127 void registerTrajectoryAnalysisModules(CommandLineModuleManager *manager)
 128 {
 129     using namespace gmx::analysismodules;
 130     manager->registerModule<TrajAnalysisCmdLineWrapper<Angle> >();
 131     manager->registerModule<TrajAnalysisCmdLineWrapper<Distance> >();
 132     manager->registerModule<TrajAnalysisCmdLineWrapper<FreeVolume> >();
 133     manager->registerModule<TrajAnalysisCmdLineWrapper<Select> >();
 134 }
 135
 136 } // namespace gmx