3 * This source code is part of
7 * GROningen MAchine for Chemical Simulations
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.
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.
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.
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.
29 * For more info, check our website at http://www.gromacs.org
33 * Declares option settings objects for basic option types.
35 * Together with options.h, this header forms the part of the public API
36 * that most classes will use to provide options.
38 * \author Teemu Murtola <teemu.murtola@cbr.su.se>
40 * \ingroup module_options
42 #ifndef GMX_OPTIONS_BASICOPTIONS_H
43 #define GMX_OPTIONS_BASICOPTIONS_H
47 #include "../utility/gmxassert.h"
49 #include "abstractoption.h"
50 #include "basicoptioninfo.h"
55 class IntegerOptionStorage;
56 class DoubleOptionStorage;
57 class StringOptionStorage;
59 /*! \addtogroup module_options
64 * Specifies an option that provides boolean values.
69 using gmx::BooleanOption;
70 options.addOption(BooleanOption("pbc").store(&bPBC));
73 * Public methods in this class do not throw.
77 class BooleanOption : public OptionTemplate<bool, BooleanOption>
80 //! OptionInfo subclass corresponding to this option type.
81 typedef BooleanOptionInfo InfoType;
83 //! Initializes an option with the given name.
84 explicit BooleanOption(const char *name) : MyBase(name) {}
87 //! Creates a BooleanOptionStorage object.
88 virtual AbstractOptionStoragePointer createStorage() const;
92 * Specifies an option that provides integer values.
96 using gmx::IntegerOption;
99 options.addOption(IntegerOption("rcut").store(&rcut));
100 // Vector-valued option
101 int box[3] = {1, 1, 1}; // Default value
102 options.addOption(IntegerOption("box").store(box).vector());
105 * Public methods in this class do not throw.
109 class IntegerOption : public OptionTemplate<int, IntegerOption>
112 //! OptionInfo subclass corresponding to this option type.
113 typedef IntegerOptionInfo InfoType;
115 //! Initializes an option with the given name.
116 explicit IntegerOption(const char *name) : MyBase(name) {}
119 * Sets the option to return a vector value.
121 * A vector value returns a fixed number of values, the default being
122 * three (can be changed with valueCount()). However, it also accepts
123 * a single value, in which case the value is used to fill the whole
126 MyClass &vector() { setVector(); return me(); }
129 //! Creates an IntegerOptionStorage object.
130 virtual AbstractOptionStoragePointer createStorage() const;
133 * Needed to initialize IntegerOptionStorage from this class without
134 * otherwise unnecessary accessors.
136 friend class IntegerOptionStorage;
140 * Specifies an option that provides floating-point (double) values.
142 * Public methods in this class do not throw.
146 class DoubleOption : public OptionTemplate<double, DoubleOption>
149 //! OptionInfo subclass corresponding to this option type.
150 typedef DoubleOptionInfo InfoType;
152 //! Initializes an option with the given name.
153 explicit DoubleOption(const char *name) : MyBase(name), bTime_(false)
157 //! \copydoc IntegerOption::vector()
158 MyClass &vector() { setVector(); return me(); }
160 * Marks this option as providing a time value whose unit can be changed.
162 * By itself, this option does nothing. It marks the option as a time
163 * value such that TimeUnitManager::scaleTimeOptions() can process it.
164 * In typical cases, Gromacs scales the time options just before
165 * Options::finish() has been called, so the option value is only
166 * available after all option values have been processed.
167 * All values in the program are in ps (including any default value);
168 * user-provided values are scaled according to the time unit set in
171 MyClass &timeValue() { bTime_ = true; return me(); }
174 //! Creates a DoubleOptionStorage object.
175 virtual AbstractOptionStoragePointer createStorage() const;
180 * Needed to initialize DoubleOptionStorage from this class without
181 * otherwise unnecessary accessors.
183 friend class DoubleOptionStorage;
187 * Specifies an option that provides string values.
191 using gmx::StringOption;
194 options.addOption(StringOption("str").store(&str));
195 // Option that only accepts predefined values
196 const char * const allowed[] = { "atom", "residue", "molecule", NULL };
199 options.addOption(StringOption("type").enumValue(allowed).store(&str)
200 .storeEnumIndex(&type));
203 * Public methods in this class do not throw.
207 class StringOption : public OptionTemplate<std::string, StringOption>
210 //! OptionInfo subclass corresponding to this option type.
211 typedef StringOptionInfo InfoType;
213 //! Initializes an option with the given name.
214 explicit StringOption(const char *name)
215 : MyBase(name), enumValues_(NULL), defaultEnumIndex_(-1),
216 enumIndexStore_(NULL)
221 * Sets the option to only accept one of a fixed set of strings.
223 * \param[in] values Array of strings to accept, a NULL pointer
224 * following the last string.
226 * Also accepts prefixes of the strings; if a prefix matches more than
227 * one of the possible strings, the shortest one is used (in a tie, the
230 * It is not possible to provide multiple values for an option with
231 * this property set, i.e., valueCount() and similar attributes cannot
234 * The strings are copied once the option is created.
236 MyClass &enumValue(const char *const *values)
237 { enumValues_ = values; return me(); }
239 * Sets the default value using an index into the enumeration table.
241 * Cannot be specified without enumValue().
243 MyClass &defaultEnumIndex(int index)
245 GMX_RELEASE_ASSERT(index >= 0, "Invalid enumeration index");
246 defaultEnumIndex_ = index;
250 * Stores the index of the selected value into the provided memory
253 * The index (zero-based) of the selected value in the array \p values
254 * provided to enumValues() is written into \p *store after the
255 * option gets its value. If the option has not been provided,
256 * and there is no default value, -1 is stored.
258 * Cannot be specified without enumValue().
260 MyClass &storeEnumIndex(int *store)
261 { enumIndexStore_ = store; return me(); }
264 //! Creates a StringOptionStorage object.
265 virtual AbstractOptionStoragePointer createStorage() const;
266 virtual std::string createDescription() const;
268 const char *const *enumValues_;
269 int defaultEnumIndex_;
270 int *enumIndexStore_;
273 * Needed to initialize StringOptionStorage from this class without
274 * otherwise unnecessary accessors.
276 friend class StringOptionStorage;