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 namespace gmx
  43 {
  44
  45 class TrajectoryAnalysisModule;
  46
  47 /*! \brief
  48  * Runner class for command-line analysis tools.
  49  *
  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
  54  * frames.
  55  *
  56  * \inpublicapi
  57  * \ingroup module_trajectoryanalysis
  58  */
  59 class TrajectoryAnalysisCommandLineRunner
  60 {
  61     public:
  62         /*! \brief
  63          * Create a new runner with the provided module.
  64          *
  65          * The caller should ensure that the provided module is not destroyed
  66          * while the runner exists.
  67          */
  68         TrajectoryAnalysisCommandLineRunner(TrajectoryAnalysisModule *module);
  69         ~TrajectoryAnalysisCommandLineRunner();
  70
  71         /*! \brief
  72          * Sets the default debugging level for selections.
  73          *
  74          * This is intended only for use by internal debugging tools.
  75          *
  76          * \see SelectionCollection::setDebugLevel()
  77          */
  78         void setSelectionDebugLevel(int debuglevel);
  79         /*! \brief
  80          * Parses options from the given command line and runs the analysis.
  81          */
  82         int run(int argc, char *argv[]);
  83
  84     private:
  85         class Impl;
  86
  87         Impl                *_impl;
  88
  89         // Disallow copy and assign.
  90         TrajectoryAnalysisCommandLineRunner(const TrajectoryAnalysisCommandLineRunner &);
  91         void operator =(const TrajectoryAnalysisCommandLineRunner &);
  92 };
  93
  94 } // namespace gmx
  95
  96 #endif