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
  67         virtual int run(int argc, char *argv[]);
  68
  69     protected:
  70         //! Creates the analysis module for this wrapper.
  71         virtual TrajectoryAnalysisModulePointer createModule() = 0;
  72 };
  73
  74 int AbstractTrajAnalysisCmdLineWrapper::run(int argc, char *argv[])
  75 {
  76     TrajectoryAnalysisModulePointer module(createModule());
  77     TrajectoryAnalysisCommandLineRunner runner(module.get());
  78     runner.setPrintCopyright(false);
  79     return runner.run(argc, argv);
  80 }
  81
  82 /*! \internal \brief
  83  * Template for command-line wrapper of a trajectory analysis module.
  84  *
  85  * \tparam Module  Trajectory analysis module to wrap.
  86  *
  87  * \p Module should be default-constructible, derive from
  88  * TrajectoryAnalysisModule, and have a static public member
  89  * \c "const char name[]".
  90  *
  91  * \ingroup module_trajectoryanalysis
  92  */
  93 template <class Module>
  94 class TrajAnalysisCmdLineWrapper : public AbstractTrajAnalysisCmdLineWrapper
  95 {
  96     public:
  97         virtual const char *name() const
  98         {
  99             return Module::name;
 100         }
 101         virtual TrajectoryAnalysisModulePointer createModule()
 102         {
 103             return TrajectoryAnalysisModulePointer(new Module);
 104         }
 105 };
 106
 107 } // namespace
 108
 109 void registerTrajectoryAnalysisModules(CommandLineModuleManager *manager)
 110 {
 111     using namespace gmx::analysismodules;
 112     manager->registerModule<TrajAnalysisCmdLineWrapper<Angle> >();
 113     manager->registerModule<TrajAnalysisCmdLineWrapper<Distance> >();
 114     manager->registerModule<TrajAnalysisCmdLineWrapper<Select> >();
 115 }
 116
 117 } // namespace gmx