src/python/sip/options/options.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 OptionManagerInterface /NoDefaultCtors/ {
  37 %TypeHeaderCode
  38 #include <string>
  39
  40 #include <gromacs/options/options.h>
  41 using gmx::OptionManagerInterface;
  42 %End
  43
  44 protected:
  45     virtual ~OptionManagerInterface();
  46 };
  47
  48 class Options {
  49 %TypeHeaderCode
  50 #include <string>
  51
  52 #include <gromacs/options/options.h>
  53 using gmx::Options;
  54 %End
  55
  56 public:
  57     Options(const char *name, const char *title);
  58     const std::string &name() const;
  59     const std::string &title() const;
  60     const std::string &description() const;
  61     void setDescription (const std::string &desc);
  62     void addManager (OptionManagerInterface *manager);
  63     void addSubSection (Options *section);
  64     void addOption(const AbstractOption &settings);
  65
  66     bool isSet(const char *name) const;
  67     void finish();
  68 private:
  69     Options(const Options &other);
  70 };