src/gromacs/trajectoryanalysis/runnercommon.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2010,2011,2012,2013,2014, by the GROMACS development team, led by
   5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   6  * and including many others, as listed in the AUTHORS file in the
   7  * top-level source 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 /*! \internal \file
  36  * \brief
  37  * Declares gmx::TrajectoryAnalysisRunnerCommon.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_trajectoryanalysis
  41  */
  42 #ifndef GMX_TRAJECTORYANALYSIS_RUNNERCOMMON_H
  43 #define GMX_TRAJECTORYANALYSIS_RUNNERCOMMON_H
  44
  45 #include "gromacs/utility/common.h"
  46
  47 struct t_trxframe;
  48
  49 namespace gmx
  50 {
  51
  52 class Options;
  53 class SelectionCollection;
  54 class TopologyInformation;
  55 class TrajectoryAnalysisSettings;
  56
  57 /*! \internal
  58  * \brief
  59  * Implements common trajectory analysis runner functionality.
  60  *
  61  * As there is currently only one runner (TrajectoryAnalysisCommandLineRunner),
  62  * the division of responsibilities is not yet very clear.
  63  *
  64  * \ingroup module_trajectoryanalysis
  65  */
  66 class TrajectoryAnalysisRunnerCommon
  67 {
  68     public:
  69         /*! \brief
  70          * Initializes a new runner helper.
  71          *
  72          * \param    settings  Settings object to use.
  73          */
  74         explicit TrajectoryAnalysisRunnerCommon(TrajectoryAnalysisSettings *settings);
  75         ~TrajectoryAnalysisRunnerCommon();
  76
  77         /*! \brief
  78          * Initializes common options for trajectory analysis.
  79          *
  80          * \param[in,out] options  Options object to add the options to.
  81          */
  82         void initOptions(Options *options);
  83         //! Scales time option values according to the time unit set.
  84         void scaleTimeOptions(Options *options);
  85         /*! \brief
  86          * Processes common option values after they have been parsed.
  87          *
  88          * \param[in,out] options Options object in which options are stored.
  89          */
  90         void optionsFinished(Options *options);
  91         //! Initialize index groups for selections.
  92         void initIndexGroups(SelectionCollection *selections,
  93                              bool                 bUseDefaults);
  94         //! Free memory allocated for index groups.
  95         void doneIndexGroups(SelectionCollection *selections);
  96         //! Load topology information if provided and/or required.
  97         void initTopology(SelectionCollection *selections);
  98         /*! \brief
  99          * Reads the first frame from the trajectory.
 100          *
 101          * After this call, frame() returns the first frame.
 102          */
 103         void initFirstFrame();
 104         /*! \brief
 105          * Reads the next frame from the trajectory.
 106          *
 107          * \returns false if there were no more frames.
 108          *
 109          * After this call, frame() returns the newly loaded frame.
 110          */
 111         bool readNextFrame();
 112         /*! \brief
 113          * Performs common initialization for the currently loaded frame.
 114          *
 115          * Currently, makes molecules whole if requested.
 116          */
 117         void initFrame();
 118
 119         //! Returns true if input data comes from a trajectory.
 120         bool hasTrajectory() const;
 121         //! Returns the topology information object.
 122         const TopologyInformation &topologyInformation() const;
 123         //! Returns the currently loaded frame.
 124         t_trxframe                &frame() const;
 125
 126     private:
 127         class Impl;
 128
 129         PrivateImplPointer<Impl> impl_;
 130 };
 131
 132 } // namespace gmx
 133
 134 #endif