src/gromacs/trajectoryanalysis/cmdlinerunner.h

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