|
Gromacs
2016.6
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Gromacs
2016.6
|
#include <gromacs/options/basicoptionstorage.h>
Inheritance diagram for gmx::DoubleOptionStorage: Collaboration diagram for gmx::DoubleOptionStorage:Converts, validates, and stores floating-point (double) values.
Public Member Functions | |
| DoubleOptionStorage (const DoubleOption &settings) | |
| Initializes the storage from option settings. More... | |
| virtual OptionInfo & | optionInfo () |
| Returns an option info object corresponding to this option. | |
| virtual std::string | typeString () const |
| Returns a short string describing the type of the option. | |
| virtual std::string | formatSingleValue (const double &value) const |
| Formats a single value as a string. More... | |
| bool | isTime () const |
| Whether the option specifies a time value. More... | |
| void | setScaleFactor (double factor) |
| Sets a scale factor for user-provided values. More... | |
| Public Member Functions inherited from gmx::OptionStorageTemplate< double > | |
| virtual int | valueCount () const |
| Returns the number of option values added so far. More... | |
| virtual std::string | formatValue (int i) const |
| Returns the i'th value formatted as a string. More... | |
| Public Member Functions inherited from gmx::AbstractOptionStorage | |
| bool | isSet () const |
| Returns true if the option has been set. | |
| bool | isBoolean () const |
| Returns true if the option is a boolean option. More... | |
| bool | isHidden () const |
| Returns true if the option is a hidden option. | |
| bool | isRequired () const |
| Returns true if the option is required. | |
| bool | isVector () const |
| Returns true if the option is vector-valued. | |
| const std::string & | name () const |
| Returns the name of the option. | |
| const std::string & | description () const |
| Returns the description of the option set by the calling code. | |
| bool | defaultValueIfSetExists () const |
| Returns true if defaultValueIfSet() value is specified. | |
| int | minValueCount () const |
| Returns the minimum number of values required in one set. | |
| int | maxValueCount () const |
| Returns the maximum allowed number of values in one set (-1 = no limit). | |
| virtual std::string | formatExtraDescription () const |
| Formats additional description for the option. More... | |
| std::string | formatDefaultValueIfSet () const |
| Returns the default value if set for the option as a string. More... | |
| void | startSource () |
| Starts adding values from a new source for the option. More... | |
| void | startSet () |
| Starts adding a new set of values for the option. More... | |
| void | appendValue (const std::string &value) |
| Adds a new value for the option, converting it from a string. More... | |
| void | finishSet () |
| Performs validation and/or actions once a set of values has been added. More... | |
| void | finish () |
| Performs validation and/or actions once all values have been added. More... | |
Additional Inherited Members | |
| Public Types inherited from gmx::OptionStorageTemplate< double > | |
|
typedef OptionStorageTemplate < double > | MyBase |
| Alias for the template class for use in base classes. | |
| typedef std::vector< double > | ValueList |
| Type of the container that contains the current values. | |
| Protected Member Functions inherited from gmx::OptionStorageTemplate< double > | |
| OptionStorageTemplate (const OptionTemplate< double, U > &settings, OptionFlags staticFlags=OptionFlags()) | |
| Initializes the storage from option settings. More... | |
| OptionStorageTemplate (const AbstractOption &settings) | |
| Initializes the storage from base option settings. More... | |
| virtual void | clearSet () |
| Removes all values from temporary storage for a set. More... | |
| virtual void | processSet () |
| Performs validation and/or actions once a set of values has been added. More... | |
| virtual void | processAll () |
| Performs validation and/or actions once all values have been added. More... | |
| void | clear () |
| Removes all values from the storage. More... | |
| void | addValue (const double &value) |
| Adds a value to a temporary storage. More... | |
| void | commitValues () |
| Commits values added with addValue(). More... | |
| virtual void | refreshValues () |
| Updates alternative store locations. More... | |
| void | setDefaultValue (const double &value) |
| Sets the default value for the option. More... | |
| void | setDefaultValueIfSet (const double &value) |
| Sets the default value if set for the option. More... | |
| ValueList & | values () |
| Provides derived classes access to the current list of values. More... | |
| const ValueList & | values () const |
| Provides derived classes access to the current list of values. | |
| Protected Member Functions inherited from gmx::AbstractOptionStorage | |
| AbstractOptionStorage (const AbstractOption &settings, OptionFlags staticFlags) | |
| Initializes the storage object from the settings object. More... | |
| void | markAsSet () |
| Marks the option as set. | |
| bool | hasFlag (OptionFlag flag) const |
| Returns true if the given flag is set. | |
| void | setFlag (OptionFlag flag) |
| Sets the given flag. | |
| void | clearFlag (OptionFlag flag) |
| Clears the given flag. | |
| void | setMinValueCount (int count) |
| Sets a new minimum number of values required in one set. More... | |
| void | setMaxValueCount (int count) |
| Sets a new maximum number of values required in one set. More... | |
| Static Protected Attributes inherited from gmx::AbstractOptionStorage | |
| static const int | DefaultValueIfSetIndex = -1 |
| Index used with formatValue() for formatting default value if set. | |
|
explicit |
Initializes the storage from option settings.
| [in] | settings | Storage settings. |
|
virtual |
Formats a single value as a string.
| [in] | value | Value to format. |
value formatted as a string.The derived class must provide this method to format values a strings. Called by formatValue() to do the actual formatting.
Implements gmx::OptionStorageTemplate< double >.
|
inline |
Whether the option specifies a time value.
| void gmx::DoubleOptionStorage::setScaleFactor | ( | double | factor | ) |
Sets a scale factor for user-provided values.
Any user-provided value is scaled by the provided factor. Programmatically set default values are not scaled. If called multiple times, later calls override the previously set value. In other words, the scaling is not cumulative.
1.8.5