src/gromacs/options/filenameoptionstorage.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  10  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  11  * Copyright (c) 2001-2009, The GROMACS development team,
  12  * check out http://www.gromacs.org for more information.
  13
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * If you want to redistribute modifications, please consider that
  20  * scientific software is very special. Version control is crucial -
  21  * bugs must be traceable. We will be happy to consider code for
  22  * inclusion in the official distribution, but derived work must not
  23  * be called official GROMACS. Details are found in the README & COPYING
  24  * files - if they are missing, get the official version at www.gromacs.org.
  25  *
  26  * To help us fund GROMACS development, we humbly ask that you cite
  27  * the papers on the package - you can find them in the top README file.
  28  *
  29  * For more info, check our website at http://www.gromacs.org
  30  */
  31 /*! \internal \file
  32  * \brief
  33  * Declares gmx::FileNameOptionStorage.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_options
  37  */
  38 #ifndef GMX_OPTIONS_FILENAMEOPTIONSTORAGE_H
  39 #define GMX_OPTIONS_FILENAMEOPTIONSTORAGE_H
  40
  41 #include <string>
  42
  43 #include "filenameoption.h"
  44 #include "filenameoptioninfo.h"
  45 #include "optionfiletype.h"
  46 #include "optionstoragetemplate.h"
  47
  48 namespace gmx
  49 {
  50
  51 class FileNameOption;
  52
  53 /*! \internal \brief
  54  * Converts, validates, and stores file names.
  55  */
  56 class FileNameOptionStorage : public OptionStorageTemplate<std::string>
  57 {
  58     public:
  59         //! \copydoc StringOptionStorage::StringOptionStorage()
  60         explicit FileNameOptionStorage(const FileNameOption &settings);
  61
  62         virtual OptionInfo &optionInfo() { return info_; }
  63         virtual const char *typeString() const { return "file"; }
  64         virtual std::string formatSingleValue(const std::string &value) const;
  65
  66         //! \copydoc FileNameOptionInfo::isInputFile()
  67         bool isInputFile() const { return bRead_ && !bWrite_; }
  68         //! \copydoc FileNameOptionInfo::isOutputFile()
  69         bool isOutputFile() const { return !bRead_ && bWrite_; }
  70         //! \copydoc FileNameOptionInfo::isInputOutputFile()
  71         bool isInputOutputFile() const { return bRead_ && bWrite_; }
  72         //! \copydoc FileNameOptionInfo::isLibraryFile()
  73         bool isLibraryFile() const { return bLibrary_; }
  74
  75     private:
  76         virtual void convertValue(const std::string &value);
  77
  78         FileNameOptionInfo      info_;
  79         OptionFileType          filetype_;
  80         bool                    bRead_;
  81         bool                    bWrite_;
  82         bool                    bLibrary_;
  83 };
  84
  85 } // namespace gmx
  86
  87 #endif