src/gromacs/trajectoryanalysis/modules.cpp

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Implements registerTrajectoryAnalysisModules().
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_trajectoryanalysis
  37  */
  38 #include "gromacs/trajectoryanalysis/modules.h"
  39
  40 #include "gromacs/commandline/cmdlinemodule.h"
  41 #include "gromacs/commandline/cmdlinemodulemanager.h"
  42 #include "gromacs/trajectoryanalysis/cmdlinerunner.h"
  43
  44 #include "modules/angle.h"
  45 #include "modules/distance.h"
  46 #include "modules/select.h"
  47
  48 namespace gmx
  49 {
  50
  51 namespace
  52 {
  53
  54 /*! \internal \brief
  55  * Base class for trajectory analysis module command-line wrappers.
  56  *
  57  * This class exists to avoid multiple identical copies of the \p run() method
  58  * to be generated for the TrajAnalysisCmdLineWrapper template classes.
  59  *
  60  * \ingroup module_trajectoryanalysis
  61  */
  62 class AbstractTrajAnalysisCmdLineWrapper : public CommandLineModuleInterface
  63 {
  64     public:
  65         virtual const char *name() const = 0;
  66         virtual const char *shortDescription() const = 0;
  67
  68         virtual int run(int argc, char *argv[]);
  69         virtual void writeHelp(const HelpWriterContext &context) const;
  70
  71     protected:
  72         //! Creates the analysis module for this wrapper.
  73         virtual TrajectoryAnalysisModulePointer createModule() const = 0;
  74 };
  75
  76 int AbstractTrajAnalysisCmdLineWrapper::run(int argc, char *argv[])
  77 {
  78     TrajectoryAnalysisModulePointer module(createModule());
  79     TrajectoryAnalysisCommandLineRunner runner(module.get());
  80     runner.setPrintCopyright(false);
  81     return runner.run(argc, argv);
  82 }
  83
  84 void AbstractTrajAnalysisCmdLineWrapper::writeHelp(const HelpWriterContext &context) const
  85 {
  86     TrajectoryAnalysisModulePointer module(createModule());
  87     TrajectoryAnalysisCommandLineRunner runner(module.get());
  88     runner.writeHelp(context);
  89 }
  90
  91 /*! \internal \brief
  92  * Template for command-line wrapper of a trajectory analysis module.
  93  *
  94  * \tparam Module  Trajectory analysis module to wrap.
  95  *
  96  * \p Module should be default-constructible, derive from
  97  * TrajectoryAnalysisModule, and have a static public members
  98  * \c "const char name[]" and \c "const char shortDescription[]".
  99  *
 100  * \ingroup module_trajectoryanalysis
 101  */
 102 template <class Module>
 103 class TrajAnalysisCmdLineWrapper : public AbstractTrajAnalysisCmdLineWrapper
 104 {
 105     public:
 106         virtual const char *name() const
 107         {
 108             return Module::name;
 109         }
 110         virtual const char *shortDescription() const
 111         {
 112             return Module::shortDescription;
 113         }
 114         virtual TrajectoryAnalysisModulePointer createModule() const
 115         {
 116             return TrajectoryAnalysisModulePointer(new Module);
 117         }
 118 };
 119
 120 } // namespace
 121
 122 void registerTrajectoryAnalysisModules(CommandLineModuleManager *manager)
 123 {
 124     using namespace gmx::analysismodules;
 125     manager->registerModule<TrajAnalysisCmdLineWrapper<Angle> >();
 126     manager->registerModule<TrajAnalysisCmdLineWrapper<Distance> >();
 127     manager->registerModule<TrajAnalysisCmdLineWrapper<Select> >();
 128 }
 129
 130 } // namespace gmx