src/gromacs/selection/selectionfileoptionstorage.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2012, by the GROMACS development team, led by
   5  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   6  * others, as listed in the AUTHORS file in the top-level source
   7  * 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 /*! \internal \file
  36  * \brief
  37  * Declares gmx::SelectionFileOptionStorage.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \ingroup module_selection
  41  */
  42 #ifndef GMX_SELECTION_SELECTIONFILEOPTIONSTORAGE_H
  43 #define GMX_SELECTION_SELECTIONFILEOPTIONSTORAGE_H
  44
  45 #include "../options/abstractoptionstorage.h"
  46 #include "selectionfileoption.h"
  47
  48 namespace gmx
  49 {
  50
  51 class SelectionFileOption;
  52 class SelectionOptionManager;
  53
  54 /*! \internal \brief
  55  * Implementation for a special option for reading selections from files.
  56  *
  57  * \ingroup module_selection
  58  */
  59 class SelectionFileOptionStorage : public AbstractOptionStorage
  60 {
  61     public:
  62         /*! \brief
  63          * Initializes the storage from option settings.
  64          *
  65          * \param[in] settings   Storage settings.
  66          */
  67         SelectionFileOptionStorage(const SelectionFileOption &settings);
  68
  69         virtual OptionInfo &optionInfo() { return info_; }
  70         virtual const char *typeString() const { return "file"; }
  71         virtual int valueCount() const { return 0; }
  72         virtual std::string formatValue(int /*i*/) const { return ""; }
  73
  74         //! \copydoc SelectionFileOptionInfo::setManager()
  75         void setManager(SelectionOptionManager *manager)
  76         {
  77             manager_ = manager;
  78         }
  79
  80     private:
  81         virtual void clearSet();
  82         virtual void convertValue(const std::string &value);
  83         virtual void processSet();
  84         virtual void processAll() {}
  85
  86         SelectionFileOptionInfo info_;
  87         SelectionOptionManager *manager_;
  88         bool                    bValueParsed_;
  89 };
  90
  91 } // namespace gmx
  92
  93 #endif