src/python/sip/selection/selection.sip

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 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
  36 class SelectionPosition /NoDefaultCtors/ {
  37 %TypeHeaderCode
  38 #include "gromacs/selection/selection.h"
  39 using namespace gmx;
  40 %End
  41
  42 public:
  43 //  e_index_t type();
  44 //  const rvec& x();
  45 //  const rvec& v();
  46 //  const rvec& f();
  47     double mass();
  48     double charge();
  49     int atomCount();
  50 //  ConstArrayRef<int> atomIndices();
  51     bool selected();
  52     int refId();
  53     int mappedId();
  54 };
  55
  56 class Selection {
  57 %TypeHeaderCode
  58 #include "gromacs/selection/selection.h"
  59 using namespace gmx;
  60 %End
  61
  62 public:
  63     bool isValid();
  64     bool __eq__(const Selection&);
  65     bool __ne__(const Selection&);
  66     const char* name();
  67     const char* selectionText();
  68     bool isDynamic();
  69     bool hasOnlyAtoms();
  70     int atomCount();
  71 //  ConstArrayRef<int> atomIndices();
  72     int posCount();
  73     SelectionPosition position(int);
  74 //  ConstArrayRef<rvec> coordinates();
  75     bool hasVelocities();
  76 //  ConstArrayRef<rvec> velocities();
  77     bool hasForces();
  78 //  ConstArrayRef<rvec> forces();
  79 //  ConstArrayRef<real> masses();
  80 //  ConstArrayRef<real> charges();
  81 //  ConstArrayRef<int> refIds();
  82 //  ConstArrayRef<int> mappedIds();
  83     bool isCoveredFractionDynamic();
  84     double coveredFraction();
  85 //  bool initCoveredFraction(e_coverfrac_t);
  86     void setEvaluateVelocities(bool);
  87     void setEvaluateForces(bool);
  88     void setOriginalId(int, int);
  89 };