2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
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.
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.
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.
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.
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.
37 * Implements registerTrajectoryAnalysisModules().
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_trajectoryanalysis
46 #include "gromacs/commandline/cmdlinemodulemanager.h"
47 #include "gromacs/trajectoryanalysis/cmdlinerunner.h"
49 #include "modules/angle.h"
50 #include "modules/distance.h"
51 #include "modules/freevolume.h"
52 #include "modules/sasa.h"
53 #include "modules/select.h"
62 * Convenience method for registering a command-line module for trajectory
65 * \tparam ModuleInfo Info about trajectory analysis module to wrap.
67 * \p ModuleInfo should have static public members
68 * `const char name[]`, `const char shortDescription[]`, and
69 * `gmx::TrajectoryAnalysisModulePointer create()`.
71 * \ingroup module_trajectoryanalysis
73 template <class ModuleInfo>
74 void registerModule(CommandLineModuleManager *manager,
75 CommandLineModuleGroup group)
77 TrajectoryAnalysisCommandLineRunner::registerModule(
78 manager, ModuleInfo::name, ModuleInfo::shortDescription,
80 group.addModule(ModuleInfo::name);
86 void registerTrajectoryAnalysisModules(CommandLineModuleManager *manager)
88 using namespace gmx::analysismodules;
89 CommandLineModuleGroup group = manager->addModuleGroup("Trajectory analysis");
90 registerModule<AngleInfo>(manager, group);
91 registerModule<DistanceInfo>(manager, group);
92 registerModule<FreeVolumeInfo>(manager, group);
93 registerModule<SasaInfo>(manager, group);
94 registerModule<SelectInfo>(manager, group);