src/gromacs/selection/selectionfileoptionstorage.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::SelectionFileOptionStorage.
  34  *
  35  * \author Teemu Murtola <teemu.murtola@cbr.su.se>
  36  * \ingroup module_selection
  37  */
  38 #ifndef GMX_SELECTION_SELECTIONFILEOPTIONSTORAGE_H
  39 #define GMX_SELECTION_SELECTIONFILEOPTIONSTORAGE_H
  40
  41 #include "../options/abstractoptionstorage.h"
  42 #include "selectionfileoption.h"
  43
  44 namespace gmx
  45 {
  46
  47 class SelectionFileOption;
  48 class SelectionOptionManager;
  49
  50 /*! \internal \brief
  51  * Implementation for a special option for reading selections from files.
  52  *
  53  * \ingroup module_selection
  54  */
  55 class SelectionFileOptionStorage : public AbstractOptionStorage
  56 {
  57     public:
  58         /*! \brief
  59          * Initializes the storage from option settings.
  60          *
  61          * \param[in] settings   Storage settings.
  62          */
  63         SelectionFileOptionStorage(const SelectionFileOption &settings);
  64
  65         virtual OptionInfo &optionInfo() { return info_; }
  66         virtual const char *typeString() const { return "file"; }
  67         virtual int valueCount() const { return 0; }
  68         virtual std::string formatValue(int /*i*/) const { return ""; }
  69
  70         //! \copydoc SelectionFileOptionInfo::setManager()
  71         void setManager(SelectionOptionManager *manager)
  72         {
  73             manager_ = manager;
  74         }
  75
  76     private:
  77         virtual void clearSet();
  78         virtual void convertValue(const std::string &value);
  79         virtual void processSet();
  80         virtual void processAll() {}
  81
  82         SelectionFileOptionInfo info_;
  83         SelectionOptionManager *manager_;
  84         bool                    bValueParsed_;
  85 };
  86
  87 } // namespace gmx
  88
  89 #endif