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 TrajectoryAnalysisModule;
  48
  49 /*! \brief
  50  * Runner class for command-line analysis tools.
  51  *
  52  * This class implements a command-line analysis program, given a
  53  * TrajectoryAnalysisModule object.  It takes care of converting command-line
  54  * parameters to a form understood by the module, as well as parsing common
  55  * options, initializing and evaluating selections, and looping over trajectory
  56  * frames.
  57  *
  58  * \inpublicapi
  59  * \ingroup module_trajectoryanalysis
  60  */
  61 class TrajectoryAnalysisCommandLineRunner
  62 {
  63     public:
  64         /*! \brief
  65          * Create a new runner with the provided module.
  66          *
  67          * \param  module  Analysis module to run using the runner.
  68          * \throws std::bad_alloc if out of memory.
  69          *
  70          * The caller should ensure that the provided module is not destroyed
  71          * while the runner exists.
  72          */
  73         TrajectoryAnalysisCommandLineRunner(TrajectoryAnalysisModule *module);
  74         ~TrajectoryAnalysisCommandLineRunner();
  75
  76         /*! \brief
  77          * Sets whether the runner will print the copyright header.
  78          *
  79          * \param[in] bPrint  Whether to print the copyright header.
  80          *
  81          * By default, the copyright header is printed.
  82          * This is used internally when executing the runner in a context where
  83          * the copyright has already been printed at a higher level.
  84          *
  85          * Does not throw.
  86          */
  87         void setPrintCopyright(bool bPrint);
  88         /*! \brief
  89          * Sets the default debugging level for selections.
  90          *
  91          * This is intended only for use by internal debugging tools.
  92          *
  93          * Does not throw.
  94          *
  95          * \see SelectionCollection::setDebugLevel()
  96          */
  97         void setSelectionDebugLevel(int debuglevel);
  98         /*! \brief
  99          * Parses options from the given command line and runs the analysis.
 100          *
 101          * \throws  multiple  Exceptions are used to indicate errors.
 102          * \returns Zero on success.
 103          */
 104         int run(int argc, char *argv[]);
 105
 106     private:
 107         class Impl;
 108
 109         PrivateImplPointer<Impl> _impl;
 110 };
 111
 112 } // namespace gmx
 113
 114 #endif