src/sip/trajectoryanalysis/runnercommon.sip

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015, 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
  36 // These classes belong to gromacs.Selection, but will remain here until
  37 // t_trxframe and t_pbc are split from TrajectoryAnalysis
  38 class SelectionCollection /NoDefaultCtors/ {
  39 %TypeHeaderCode
  40 #include <gromacs/selection/selectioncollection.h>
  41 %End
  42 public:
  43     SelectionCollection();
  44     void evaluate(t_trxframe *fr, t_pbc *pbc);
  45     void evaluateFinal(int nframes);
  46 };
  47
  48 class ITopologyProvider;
  49 class SelectionOptionBehavior : public IOptionsBehavior /NoDefaultCtors/ {
  50 %TypeHeaderCode
  51 #include <gromacs/selection/selectionoptionbehavior.h>
  52 using gmx::SelectionOptionBehavior;
  53 using gmx::ITopologyProvider;
  54 %End
  55 public:
  56     SelectionOptionBehavior(SelectionCollection *selections,
  57                             ITopologyProvider   *topologyProvider);
  58     void initOptions(IOptionsContainer *options);
  59     virtual void initBehavior(Options *options);
  60     virtual void optionsFinishing(Options *options);
  61     virtual void optionsFinished();
  62 };
  63
  64 class TrajectoryAnalysisRunnerCommon /NoDefaultCtors/ {
  65 %TypeHeaderCode
  66 #include <gromacs/trajectoryanalysis/runnercommon.h>
  67 %End
  68 public:
  69     explicit TrajectoryAnalysisRunnerCommon(TrajectoryAnalysisSettings *settings);
  70     ~TrajectoryAnalysisRunnerCommon();
  71
  72     ITopologyProvider *topologyProvider();
  73
  74     void initOptions(IOptionsContainer *options, TimeUnitBehavior *timeUnitBehavior);
  75     void optionsFinished();
  76     void initTopology();
  77     void initFirstFrame();
  78     void initFrameIndexGroup();
  79     bool readNextFrame();
  80     void initFrame();
  81
  82     bool hasTrajectory() const;
  83     const TopologyInformation &topologyInformation() const;
  84     t_trxframe                &frame() const;
  85 };