Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::EnumOptionStorage Class Reference

#include <gromacs/options/basicoptionstorage.h>

+ Inheritance diagram for gmx::EnumOptionStorage:
+ Collaboration diagram for gmx::EnumOptionStorage:

Description

Converts, validates, and stores enum values.

Public Member Functions

 EnumOptionStorage (const AbstractOption &settings, const char *const *enumValues, int count, int defaultValue, int defaultValueIfSet, StorePointer store)
 Initializes the storage from option settings. More...
 
OptionInfooptionInfo () 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 formatExtraDescription () const override
 Formats additional description for the option. More...
 
std::string formatSingleValue (const int &value) const override
 Formats a single value as a string. More...
 
Any normalizeValue (const int &value) const override
 Converts a single value to normalized type. More...
 
const std::vector< std::string > & allowedValues () const
 Returns the set of allowed values for this option. More...
 
- Public Member Functions inherited from gmx::OptionStorageTemplate< int >
int valueCount () const override
 Returns the number of option values added so far. More...
 
std::vector< AnydefaultValues () 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).
 
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< int >
typedef
OptionStorageTemplateSimple
< int > 
MyBase
 Alias for the template class for use in base classes.
 
- Public Types inherited from gmx::OptionStorageTemplate< int >
typedef OptionStorageTemplate
< int > 
MyBase
 Alias for the template class for use in base classes.
 
typedef std::vector< int > ValueList
 Type of the container that contains the current values.
 
- Protected Types inherited from gmx::OptionStorageTemplateSimple< int >
typedef
OptionValueConverterSimple
< int > 
ConverterType
 Alias for the converter parameter type for initConverter().
 
- Protected Types inherited from gmx::OptionStorageTemplate< int >
typedef std::unique_ptr
< IOptionValueStore< int > > 
StorePointer
 Smart pointer for managing the final storage interface.
 
- Protected Member Functions inherited from gmx::OptionStorageTemplateSimple< int >
 OptionStorageTemplateSimple (const OptionTemplate< int, U > &settings, OptionFlags staticFlags=OptionFlags())
 Initializes the storage.
 
 OptionStorageTemplateSimple (const AbstractOption &settings, typename OptionStorageTemplate< int >::StorePointer store)
 Initializes the storage.
 
std::vector< AnynormalizeValues (const std::vector< Any > &values) const override
 
virtual int processValue (const int &value) const
 Post-processes a value after conversion to the output type. More...
 
- Protected Member Functions inherited from gmx::OptionStorageTemplate< int >
 OptionStorageTemplate (const OptionTemplate< int, 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 int &value)
 Adds a value to a temporary storage. More...
 
void commitValues ()
 Commits values added with addValue(). More...
 
void setDefaultValue (const int &value)
 Sets the default value for the option. More...
 
void setDefaultValueIfSet (const int &value)
 Sets the default value if set for the option. More...
 
ArrayRef< int > values ()
 Provides derived classes access to the current list of values. More...
 
ArrayRef< const int > 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...
 

Constructor & Destructor Documentation

gmx::EnumOptionStorage::EnumOptionStorage ( const AbstractOption settings,
const char *const *  enumValues,
int  count,
int  defaultValue,
int  defaultValueIfSet,
StorePointer  store 
)

Initializes the storage from option settings.

Parameters
[in]settingsBasic storage settings.
[in]enumValuesAllowed values.
[in]countNumber of elements in enumValues, or -1 if enumValues is NULL-terminated.
[in]defaultValueDefault value, or -1 if no default.
[in]defaultValueIfSetDefault value if set, or -1 if none.
[in]storeStorage to convert the values to/from int.

This constructor takes more parameters than other storage parameters because the front-end option type is a template, and as such cannot be passed here without exposing also this header as an installed header.

Member Function Documentation

const std::vector<std::string>& gmx::EnumOptionStorage::allowedValues ( ) const
inline

Returns the set of allowed values for this option.

std::string gmx::EnumOptionStorage::formatExtraDescription ( ) const
overridevirtual

Formats additional description for the option.

If this method returns a non-empty string, it is appended to the plain description when printing help texts. The default implementation returns an empty string.

Reimplemented from gmx::AbstractOptionStorage.

std::string gmx::EnumOptionStorage::formatSingleValue ( const int &  value) const
overridevirtual

Formats a single value as a string.

Parameters
[in]valueValue to format.
Returns
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< int >.

Any gmx::EnumOptionStorage::normalizeValue ( const int &  value) const
overridevirtual

Converts a single value to normalized type.

Parameters
[in]valueValue after conversion.
Returns
Value to store for the option.

This can be overridden to serialize a different type than T when using the option with KeyValueTreeObject.

Reimplemented from gmx::OptionStorageTemplateSimple< int >.


The documentation for this class was generated from the following files: