src/python/sip/options/filenameoption.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 %ModuleHeaderCode
  37 #include "gromacs/options/filenameoption.h"
  38 #include "gromacs/fileio/filenm.h"
  39 typedef gmx::OptionTemplate<std::string, gmx::FileNameOption> FileNameOptionTemplate;
  40 using namespace gmx; // needed for compilation of enum
  41 %End
  42
  43 typedef OptionTemplate<std::string, FileNameOption> FileNameOptionTemplate;
  44
  45 enum OptionFileType {
  46     eftUnknown, eftTopology, eftTrajectory, eftPDB,
  47     eftIndex, eftPlot, eftGenericData, eftOptionFileType_NR
  48 };
  49
  50 enum {
  51     efMDP,
  52     efTRX, efTRO, efTRN, efTRR, efCOMPRESSED, efXTC, efTNG,
  53     efEDR,
  54     efSTX, efSTO, efGRO, efG96, efPDB, efBRK, efENT, efESP, efPQR,
  55     efCPT,
  56     efLOG, efXVG, efOUT,
  57     efNDX,
  58     efTOP, efITP,
  59     efTPS, efTPR,
  60     efTEX, efRTP, efATP, efHDB,
  61     efDAT, efDLG,
  62     efMAP, efEPS, efMAT, efM2P,
  63     efMTX,
  64     efEDI,
  65     efCUB,
  66     efXPM,
  67     efRND,
  68     efNR
  69 };
  70
  71 class FileNameOption : FileNameOptionTemplate /NoDefaultCtors/ {
  72 %TypeHeaderCode
  73 #include "gromacs/options/filenameoption.h"
  74 using gmx::FileNameOption;
  75 %End
  76 public:
  77     FileNameOption& filetype(OptionFileType);
  78     FileNameOption& legacyType(int);
  79     FileNameOption& inputFile();
  80     FileNameOption& outputFile();
  81     FileNameOption& inputOutputFile();
  82     FileNameOption& readWriteFlags(bool, bool);
  83     FileNameOption& libraryFile(bool = true);
  84     FileNameOption& defaultBasename(const char* /KeepReference/);
  85     FileNameOption& defaultType(int);
  86 };