src/gromacs/trajectoryanalysis/cmdlinerunner.h

   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 /*! \file
  36  * \brief
  37  * Declares gmx::TrajectoryAnalysisCommandLineRunner.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_trajectoryanalysis
  42  */
  43 #ifndef GMX_TRAJECTORYANALYSIS_CMDLINERUNNER_H
  44 #define GMX_TRAJECTORYANALYSIS_CMDLINERUNNER_H
  45
  46 #include "../utility/common.h"
  47
  48 namespace gmx
  49 {
  50
  51 class HelpWriterContext;
  52 class TrajectoryAnalysisModule;
  53
  54 /*! \brief
  55  * Runner class for command-line analysis tools.
  56  *
  57  * This class implements a command-line analysis program, given a
  58  * TrajectoryAnalysisModule object.  It takes care of converting command-line
  59  * parameters to a form understood by the module, as well as parsing common
  60  * options, initializing and evaluating selections, and looping over trajectory
  61  * frames.
  62  *
  63  * \inpublicapi
  64  * \ingroup module_trajectoryanalysis
  65  */
  66 class TrajectoryAnalysisCommandLineRunner
  67 {
  68     public:
  69         /*! \brief
  70          * Create a new runner with the provided module.
  71          *
  72          * \param  module  Analysis module to run using the runner.
  73          * \throws std::bad_alloc if out of memory.
  74          *
  75          * The caller should ensure that the provided module is not destroyed
  76          * while the runner exists.
  77          */
  78         TrajectoryAnalysisCommandLineRunner(TrajectoryAnalysisModule *module);
  79         ~TrajectoryAnalysisCommandLineRunner();
  80
  81         /*! \brief
  82          * Sets whether the runner will print the copyright header.
  83          *
  84          * \param[in] bPrint  Whether to print the copyright header.
  85          *
  86          * By default, the copyright header is printed.
  87          * This is used internally when executing the runner in a context where
  88          * the copyright has already been printed at a higher level.
  89          *
  90          * Does not throw.
  91          */
  92         void setPrintCopyright(bool bPrint);
  93         /*! \brief
  94          * Sets the default debugging level for selections.
  95          *
  96          * This is intended only for use by internal debugging tools.
  97          *
  98          * Does not throw.
  99          *
 100          * \see SelectionCollection::setDebugLevel()
 101          */
 102         void setSelectionDebugLevel(int debuglevel);
 103         /*! \brief
 104          * Parses options from the given command line and runs the analysis.
 105          *
 106          * \throws  multiple  Exceptions are used to indicate errors.
 107          * \returns Zero on success.
 108          */
 109         int run(int argc, char *argv[]);
 110         /*! \brief
 111          * Prints help for the module, including common options from the runner.
 112          *
 113          * \param[in] context  Context object for writing the help.
 114          * \throws    std::bad_alloc if out of memory.
 115          * \throws    FileIOError on any I/O error.
 116          */
 117         void writeHelp(const HelpWriterContext &context);
 118
 119     private:
 120         class Impl;
 121
 122         PrivateImplPointer<Impl> impl_;
 123 };
 124
 125 } // namespace gmx
 126
 127 #endif