src/sip/trajectoryanalysis/analysissettings.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 class TrajectoryAnalysisSettings {
  37 %TypeHeaderCode
  38 #include <gromacs/trajectoryanalysis/analysissettings.h>
  39 using namespace gmx;
  40 %End
  41
  42 public:
  43     enum {
  44         efRequireTop = 1,
  45         efUseTopX = 2,
  46         efNoUserPBC = 16,
  47         efNoUserRmPBC = 32
  48     };
  49
  50     TrajectoryAnalysisSettings();
  51     void setOptionsModuleSettings(ICommandLineOptionsModuleSettings *settings);
  52     /*
  53     const TimeUnitManager& timeUnitManager() const;
  54     TimeUnit timeUnit();
  55     const AnalysisDataPlotSettings& plotSettings() const;
  56     */
  57     unsigned long flags() const;
  58     bool hasFlag(unsigned long flag) const;
  59     bool hasPBC() const;
  60     bool hasRmPBC() const;
  61     int frflags() const;
  62     void setFlags(unsigned long flags);
  63     void setFlag(unsigned long flag, bool bSet = true);
  64     void setPBC(bool bPBC);
  65     void setRmPBC(bool bRmPBC);
  66     void setFrameFlags(int frflags);
  67     void setHelpText(const char *helpText);
  68     %MethodCode
  69         const char *const helpText[] = {a0};
  70         sipCpp->setHelpText(helpText);
  71     %End
  72 private:
  73     TrajectoryAnalysisSettings(const TrajectoryAnalysisSettings &other);
  74 };
  75
  76 class TopologyInformation {
  77 %TypeHeaderCode
  78 #include <gromacs/trajectoryanalysis/analysissettings.h>
  79 using namespace gmx;
  80 %End
  81 public:
  82     bool hasTopology() const;
  83     bool hasFullTopology() const;
  84     t_topology* topology() const;
  85 private:
  86     TopologyInformation(const TopologyInformation &other);
  87     ~TopologyInformation();
  88 };