Gromacs
2024.4
|
#include <gromacs/options/basicoptionstorage.h>
Converts, validates, and stores integer values.
Public Member Functions | |
Int64OptionStorage (const Int64Option &settings) | |
Initializes the storage from option settings. More... | |
OptionInfo & | optionInfo () override |
Returns an option info object corresponding to this option. | |
std::string | typeString () const override |
Returns a short string describing the type of the option. | |
std::string | formatSingleValue (const int64_t &value) const override |
Formats a single value as a string. More... | |
Public Member Functions inherited from gmx::OptionStorageTemplate< int64_t > | |
int | valueCount () const override |
Returns the number of option values added so far. More... | |
std::vector< Any > | defaultValues () const override |
std::vector< std::string > | defaultValuesAsStrings () const override |
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... | |
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 Any &value) |
Adds a new value for the option. 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::OptionStorageTemplateSimple< int64_t > | |
typedef OptionStorageTemplateSimple < int64_t > | MyBase |
Alias for the template class for use in base classes. | |
Public Types inherited from gmx::OptionStorageTemplate< int64_t > | |
typedef OptionStorageTemplate < int64_t > | MyBase |
Alias for the template class for use in base classes. | |
typedef std::vector< int64_t > | ValueList |
Type of the container that contains the current values. | |
Protected Types inherited from gmx::OptionStorageTemplateSimple< int64_t > | |
typedef OptionValueConverterSimple < int64_t > | ConverterType |
Alias for the converter parameter type for initConverter(). | |
Protected Types inherited from gmx::OptionStorageTemplate< int64_t > | |
typedef std::unique_ptr < IOptionValueStore< int64_t > > | StorePointer |
Smart pointer for managing the final storage interface. | |
Protected Member Functions inherited from gmx::OptionStorageTemplateSimple< int64_t > | |
OptionStorageTemplateSimple (const OptionTemplate< int64_t, U > &settings, OptionFlags staticFlags=OptionFlags()) | |
Initializes the storage. | |
OptionStorageTemplateSimple (const AbstractOption &settings, typename OptionStorageTemplate< int64_t >::StorePointer store) | |
Initializes the storage. | |
std::vector< Any > | normalizeValues (const std::vector< Any > &values) const override |
virtual int64_t | processValue (const int64_t &value) const |
Post-processes a value after conversion to the output type. More... | |
virtual Any | normalizeValue (const int64_t &value) const |
Converts a single value to normalized type. More... | |
Protected Member Functions inherited from gmx::OptionStorageTemplate< int64_t > | |
OptionStorageTemplate (const OptionTemplate< int64_t, U > &settings, OptionFlags staticFlags=OptionFlags()) | |
Initializes the storage from option settings. More... | |
OptionStorageTemplate (const AbstractOption &settings, StorePointer store) | |
Initializes the storage from base option settings. More... | |
void | clearSet () override |
Removes all values from temporary storage for a set. More... | |
virtual void | processSetValues (ValueList *values) |
Processes values for a set after all have been converted. More... | |
void | processSet () override |
Performs validation and/or actions once a set of values has been added. More... | |
void | processAll () override |
Performs validation and/or actions once all values have been added. More... | |
void | addValue (const int64_t &value) |
Adds a value to a temporary storage. More... | |
void | commitValues () |
Commits values added with addValue(). More... | |
void | setDefaultValue (const int64_t &value) |
Sets the default value for the option. More... | |
void | setDefaultValueIfSet (const int64_t &value) |
Sets the default value if set for the option. More... | |
ArrayRef< int64_t > | values () |
Provides derived classes access to the current list of values. More... | |
ArrayRef< const int64_t > | 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... | |
|
inlineexplicit |
Initializes the storage from option settings.
[in] | settings | Storage settings. |
|
overridevirtual |
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 defaultValuesAsStrings() to do the actual formatting.
Implements gmx::OptionStorageTemplate< int64_t >.