2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2010,2011,2012,2013,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.
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.
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.
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.
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.
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.
37 * Declares storage classes for basic option types.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
40 * \ingroup module_options
42 #ifndef GMX_OPTIONS_BASICOPTIONSTORAGE_H
43 #define GMX_OPTIONS_BASICOPTIONSTORAGE_H
48 #include "basicoptions.h"
49 #include "optionstoragetemplate.h"
54 /*! \addtogroup module_options
59 * Converts, validates, and stores boolean values.
61 class BooleanOptionStorage : public OptionStorageTemplate<bool>
65 * Initializes the storage from option settings.
67 * \param[in] settings Storage settings.
69 explicit BooleanOptionStorage(const BooleanOption &settings)
70 : MyBase(settings), info_(this)
74 virtual OptionInfo &optionInfo() { return info_; }
75 virtual std::string typeString() const { return "bool"; }
76 virtual std::string formatSingleValue(const bool &value) const;
78 //! \copydoc BooleanOptionInfo::defaultValue()
79 bool defaultValue() const { return valueCount() > 0 && values()[0]; }
82 virtual void convertValue(const std::string &value);
84 BooleanOptionInfo info_;
88 * Converts, validates, and stores integer values.
90 class IntegerOptionStorage : public OptionStorageTemplate<int>
93 //! \copydoc BooleanOptionStorage::BooleanOptionStorage()
94 explicit IntegerOptionStorage(const IntegerOption &settings)
95 : MyBase(settings), info_(this)
99 virtual OptionInfo &optionInfo() { return info_; }
100 virtual std::string typeString() const
101 { return isVector() ? "vector" : "int"; }
102 virtual std::string formatSingleValue(const int &value) const;
105 virtual void convertValue(const std::string &value);
106 virtual void processSetValues(ValueList *values);
108 IntegerOptionInfo info_;
112 * Converts, validates, and stores integer values.
114 class Int64OptionStorage : public OptionStorageTemplate<gmx_int64_t>
117 //! \copydoc BooleanOptionStorage::BooleanOptionStorage()
118 explicit Int64OptionStorage(const Int64Option &settings)
119 : MyBase(settings), info_(this)
123 virtual OptionInfo &optionInfo() { return info_; }
124 virtual std::string typeString() const { return "int"; }
125 virtual std::string formatSingleValue(const gmx_int64_t &value) const;
128 virtual void convertValue(const std::string &value);
130 Int64OptionInfo info_;
134 * Converts, validates, and stores floating-point (double) values.
136 class DoubleOptionStorage : public OptionStorageTemplate<double>
139 //! \copydoc IntegerOptionStorage::IntegerOptionStorage()
140 explicit DoubleOptionStorage(const DoubleOption &settings);
142 virtual OptionInfo &optionInfo() { return info_; }
143 virtual std::string typeString() const;
144 virtual std::string formatSingleValue(const double &value) const;
146 //! \copydoc DoubleOptionInfo::isTime()
147 bool isTime() const { return bTime_; }
148 //! \copydoc DoubleOptionInfo::setScaleFactor()
149 void setScaleFactor(double factor);
152 virtual void convertValue(const std::string &value);
153 virtual void processSetValues(ValueList *values);
155 DoubleOptionInfo info_;
161 * Converts, validates, and stores floating-point (float) values.
163 class FloatOptionStorage : public OptionStorageTemplate<float>
166 //! \copydoc IntegerOptionStorage::IntegerOptionStorage()
167 explicit FloatOptionStorage(const FloatOption &settings);
169 virtual OptionInfo &optionInfo() { return info_; }
170 virtual std::string typeString() const;
171 virtual std::string formatSingleValue(const float &value) const;
173 //! \copydoc DoubleOptionStorage::isTime()
174 bool isTime() const { return bTime_; }
175 //! \copydoc DoubleOptionStorage::setScaleFactor()
176 void setScaleFactor(double factor);
179 virtual void convertValue(const std::string &value);
180 virtual void processSetValues(ValueList *values);
182 FloatOptionInfo info_;
188 * Converts, validates, and stores string values.
190 class StringOptionStorage : public OptionStorageTemplate<std::string>
193 //! \copydoc DoubleOptionStorage::DoubleOptionStorage()
194 explicit StringOptionStorage(const StringOption &settings);
196 virtual OptionInfo &optionInfo() { return info_; }
197 virtual std::string typeString() const
198 { return allowed_.empty() ? "string" : "enum"; }
199 virtual std::string formatExtraDescription() const;
200 virtual std::string formatSingleValue(const std::string &value) const;
202 //! \copydoc StringOptionInfo::allowedValues()
203 const ValueList &allowedValues() const { return allowed_; }
206 virtual void convertValue(const std::string &value);
207 virtual void refreshValues();
209 StringOptionInfo info_;
211 int *enumIndexStore_;