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

#include <gromacs/options/basicoptionstorage.h>

+ Inheritance diagram for gmx::FloatOptionStorage:
+ Collaboration diagram for gmx::FloatOptionStorage:

Description

Converts, validates, and stores floating-point (float) values.

Public Member Functions

 FloatOptionStorage (const FloatOption &settings)
 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 formatSingleValue (const float &value) const override
 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< float >
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).
 
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< float >
typedef
OptionStorageTemplateSimple
< float > 
MyBase
 Alias for the template class for use in base classes.
 
- Public Types inherited from gmx::OptionStorageTemplate< float >
typedef OptionStorageTemplate
< float > 
MyBase
 Alias for the template class for use in base classes.
 
typedef std::vector< float > ValueList
 Type of the container that contains the current values.
 
- Protected Types inherited from gmx::OptionStorageTemplateSimple< float >
typedef
OptionValueConverterSimple
< float > 
ConverterType
 Alias for the converter parameter type for initConverter().
 
- Protected Types inherited from gmx::OptionStorageTemplate< float >
typedef std::unique_ptr
< IOptionValueStore< float > > 
StorePointer
 Smart pointer for managing the final storage interface.
 
- Protected Member Functions inherited from gmx::OptionStorageTemplateSimple< float >
 OptionStorageTemplateSimple (const OptionTemplate< float, U > &settings, OptionFlags staticFlags=OptionFlags())
 Initializes the storage.
 
 OptionStorageTemplateSimple (const AbstractOption &settings, typename OptionStorageTemplate< float >::StorePointer store)
 Initializes the storage.
 
std::vector< AnynormalizeValues (const std::vector< Any > &values) const override
 
virtual Any normalizeValue (const float &value) const
 Converts a single value to normalized type. More...
 
- Protected Member Functions inherited from gmx::OptionStorageTemplate< float >
 OptionStorageTemplate (const OptionTemplate< float, 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...
 
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 float &value)
 Adds a value to a temporary storage. More...
 
void commitValues ()
 Commits values added with addValue(). More...
 
void setDefaultValue (const float &value)
 Sets the default value for the option. More...
 
void setDefaultValueIfSet (const float &value)
 Sets the default value if set for the option. More...
 
ArrayRef< float > values ()
 Provides derived classes access to the current list of values. More...
 
ArrayRef< const float > 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::FloatOptionStorage::FloatOptionStorage ( const FloatOption settings)
explicit

Initializes the storage from option settings.

Parameters
[in]settingsStorage settings.

Member Function Documentation

std::string gmx::FloatOptionStorage::formatSingleValue ( const float &  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< float >.

bool gmx::FloatOptionStorage::isTime ( ) const
inline

Whether the option specifies a time value.

void gmx::FloatOptionStorage::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.


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