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/trajectoryanalysis/cmdlinerunner.h"
  45
  46 #include "modules/angle.h"
  47 #include "modules/distance.h"
  48 #include "modules/freevolume.h"
  49 #include "modules/select.h"
  50
  51 namespace gmx
  52 {
  53
  54 namespace
  55 {
  56
  57 /*! \brief
  58  * Convenience method for registering a command-line module for trajectory
  59  * analysis.
  60  *
  61  * \tparam ModuleType  Trajectory analysis module to wrap.
  62  *
  63  * \p ModuleType should be default-constructible, derive from
  64  * TrajectoryAnalysisModule, and have static public members
  65  * \c "const char name[]" and \c "const char shortDescription[]".
  66  *
  67  * \ingroup module_trajectoryanalysis
  68  */
  69 template <class ModuleType>
  70 void registerModule(CommandLineModuleManager *manager)
  71 {
  72     TrajectoryAnalysisCommandLineRunner::registerModule<ModuleType>(
  73             manager, ModuleType::name, ModuleType::shortDescription);
  74 }
  75
  76 }   // namespace
  77
  78 void registerTrajectoryAnalysisModules(CommandLineModuleManager *manager)
  79 {
  80     using namespace gmx::analysismodules;
  81     registerModule<Angle>(manager);
  82     registerModule<Distance>(manager);
  83     registerModule<FreeVolume>(manager);
  84     registerModule<Select>(manager);
  85 }
  86
  87 } // namespace gmx