src/python/sip/trajectoryanalysis/analysisdata.sip

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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 class AbstractAnalysisData /NoDefaultCtors/ {
  36 %TypeHeaderCode
  37 #include <gromacs/analysisdata/abstractdata.h>
  38 %End
  39 public:
  40     bool isMultipoint() const;
  41     int dataSetCount() const;
  42     int columnCount(int dataSet) const;
  43     int columnCount() const;
  44     virtual int frameCount() const = 0;
  45     AnalysisDataFrameRef tryGetDataFrame(int index) const;
  46     AnalysisDataFrameRef getDataFrame(int index) const;
  47     bool requestStorage(int nframes);
  48 };
  49
  50 class AnalysisDataFrameRef /NoDefaultCtors/ {
  51 %TypeHeaderCode
  52 #include <gromacs/analysisdata/dataframe.h>
  53 %End
  54 public:
  55     bool isValid() const;
  56     //const AnalysidDataFrameHeader& header() const;
  57     int frameIndex() const;
  58     double x() const;
  59     double dx() const;
  60     int pointSetCount() const;
  61     AnalysisDataPointSetRef pointSet(int index) const;
  62     double y(int i) const;
  63     double dy(int i) const;
  64     bool present(int i) const;
  65     bool allPresent() const;
  66 };
  67
  68 class AnalysisDataFrameHeader /NoDefaultCtors/ {
  69 %TypeHeaderCode
  70 #include <gromacs/analysisdata/dataframe.h>
  71 %End
  72 public:
  73     bool isValid() const;
  74     int index() const;
  75     double x() const;
  76     double dx() const;
  77 };
  78
  79 class AnalysisDataPointSetRef /NoDefaultCtors/ {
  80 %TypeHeaderCode
  81 #include <gromacs/analysisdata/dataframe.h>
  82 %End
  83 public:
  84     const AnalysisDataFrameHeader& header() const;
  85     int frameIndex() const;
  86     double x() const;
  87     double dx() const;
  88     int dataSetIndex() const;
  89     int firstColumn() const;
  90     int columnCount() const;
  91     int lastColumn() const;
  92     //const std::vector<AnalysisDataValue>& values() const;
  93     double y(int i) const;
  94     double dy(int i) const;
  95     bool present(int i) const;
  96     bool allPresent() const;
  97 };