3 * This source code is part of
7 * GROningen MAchine for Chemical Simulations
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.
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.
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.
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.
29 * For more info, check our website at http://www.gromacs.org
33 * Declares gmx::TrajectoryAnalysisCommandLineRunner.
35 * \author Teemu Murtola <teemu.murtola@cbr.su.se>
37 * \ingroup module_trajectoryanalysis
39 #ifndef GMX_TRAJECTORYANALYSIS_CMDLINERUNNER_H
40 #define GMX_TRAJECTORYANALYSIS_CMDLINERUNNER_H
45 class TrajectoryAnalysisModule;
48 * Runner class for command-line analysis tools.
50 * This class implements a command-line analysis program, given a
51 * TrajectoryAnalysisModule object. It takes care of converting command-line
52 * parameters to a form understood by the module, as well as parsing common
53 * options, initializing and evaluating selections, and looping over trajectory
57 * \ingroup module_trajectoryanalysis
59 class TrajectoryAnalysisCommandLineRunner
63 * Create a new runner with the provided module.
65 * The caller should ensure that the provided module is not destroyed
66 * while the runner exists.
68 TrajectoryAnalysisCommandLineRunner(TrajectoryAnalysisModule *module);
69 ~TrajectoryAnalysisCommandLineRunner();
72 * Sets the default debugging level for selections.
74 * This is intended only for use by internal debugging tools.
76 * \see SelectionCollection::setDebugLevel()
78 void setSelectionDebugLevel(int debuglevel);
80 * Parses options from the given command line and runs the analysis.
82 int run(int argc, char *argv[]);
89 // Disallow copy and assign.
90 TrajectoryAnalysisCommandLineRunner(const TrajectoryAnalysisCommandLineRunner &);
91 void operator =(const TrajectoryAnalysisCommandLineRunner &);