src/python/sip/options/abstractoption.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 AbstractOption /NoDefaultCtors,Abstract/ {
  37 %TypeHeaderCode
  38 #include <gromacs/options/abstractoption.h>
  39 using gmx::AbstractOption;
  40 %End
  41 };
  42
  43 template<T, U> class OptionTemplate : AbstractOption /NoDefaultCtors/ {
  44 %TypeHeaderCode
  45 #include <gromacs/options/abstractoption.h>
  46 using namespace gmx;
  47 %End
  48 public:
  49     U& description(const char * /KeepReference/);
  50     U& hidden(bool = true);
  51     U& required(bool = true);
  52     U& allowMultiple(bool = true);
  53     // FIXME
  54     // These function do not work, because they store pointer to argument, which then is garbage collected in python.
  55     // Different combinations of Factory, KeepReference and Transfer annotations do not help.
  56     // Use third argument of PyOptionsHolder's methods instead.
  57     U& defaultValue(const T&);
  58     U& defaultValueIfSet(const T&);
  59 };