Gromacs  2016.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Static Protected Attributes
gmx::AbstractOptionStorage Class Referenceabstract

#include <gromacs/options/abstractoptionstorage.h>

+ Inheritance diagram for gmx::AbstractOptionStorage:

Description

Abstract base class for converting, validating, and storing option values.

This class should normally not be subclassed directly, but the OptionStorageTemplate should be used instead. The templated class provides basic functionality for most of the pure virtual methods, and also integrates well with option setting objects derived from OptionTemplate.

Public Member Functions

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 OptionInfooptionInfo ()=0
 Returns an option info object corresponding to this option.
 
virtual std::string typeString () const =0
 Returns a short string describing the type of the option.
 
virtual std::string formatExtraDescription () const
 Formats additional description for the option. More...
 
virtual int valueCount () const =0
 Returns the number of option values added so far.
 
virtual std::string formatValue (int i) const =0
 Returns the i'th value formatted as a string. 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...
 

Protected Member Functions

 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...
 
virtual void clearSet ()=0
 Removes all values from temporary storage for a set. More...
 
virtual void convertValue (const std::string &value)=0
 Adds a new value, converting it from a string. More...
 
virtual void processSet ()=0
 Performs validation and/or actions once a set of values has been added. More...
 
virtual void processAll ()=0
 Performs validation and/or actions once all values have been added. More...
 

Static Protected Attributes

static const int DefaultValueIfSetIndex = -1
 Index used with formatValue() for formatting default value if set.
 

Constructor & Destructor Documentation

gmx::AbstractOptionStorage::AbstractOptionStorage ( const AbstractOption settings,
OptionFlags  staticFlags 
)
protected

Initializes the storage object from the settings object.

Parameters
[in]settingsOption settings.
[in]staticFlagsOption flags that are always set and specify generic behavior of the option.
Exceptions
APIErrorif invalid settings have been provided.

Member Function Documentation

void gmx::AbstractOptionStorage::appendValue ( const std::string &  value)

Adds a new value for the option, converting it from a string.

Parameters
[in]valueString value to convert.
Exceptions
InvalidInputErrorif value cannot be converted, or if there are too many values.

This method should only be called between startSet() and finishSet().

virtual void gmx::AbstractOptionStorage::clearSet ( )
protectedpure virtual

Removes all values from temporary storage for a set.

This function is always called before starting to add values to a set, allowing the storage to clear its internal buffers.

Should not throw.

Implemented in gmx::OptionStorageTemplate< T >, gmx::OptionStorageTemplate< double >, gmx::OptionStorageTemplate< std::string >, gmx::OptionStorageTemplate< float >, gmx::OptionStorageTemplate< gmx_int64_t >, gmx::OptionStorageTemplate< int >, gmx::OptionStorageTemplate< Selection >, and gmx::OptionStorageTemplate< bool >.

virtual void gmx::AbstractOptionStorage::convertValue ( const std::string &  value)
protectedpure virtual

Adds a new value, converting it from a string.

Parameters
[in]valueString value to convert.
Exceptions
InvalidInputErrorif value is not valid for this option or if there have been too many values in the set.

This method may be called multiple times if the underlying option is defined to accept multiple values.

See Also
OptionStorageTemplate::convertValue()

Implemented in gmx::OptionStorageTemplate< T >, gmx::OptionStorageTemplate< double >, gmx::OptionStorageTemplate< std::string >, gmx::OptionStorageTemplate< float >, gmx::OptionStorageTemplate< gmx_int64_t >, gmx::OptionStorageTemplate< int >, gmx::OptionStorageTemplate< Selection >, and gmx::OptionStorageTemplate< bool >.

void gmx::AbstractOptionStorage::finish ( )

Performs validation and/or actions once all values have been added.

Exceptions
InvalidInputErrorif the option is required but not set, or if all valid values together are invalid as a set.

This method should be called after all values have been provided with appendValue().

void gmx::AbstractOptionStorage::finishSet ( )

Performs validation and/or actions once a set of values has been added.

Exceptions
InvalidInputErrorif too few values have been provided, or if the valid values since previous startSet() are invalid as a set.

If the parameter is specified multiple times, finishSet() should be called after the values for each instance.

std::string gmx::AbstractOptionStorage::formatDefaultValueIfSet ( ) const
inline

Returns the default value if set for the option as a string.

See Also
OptionTemplate::defaultValueIfSet()
virtual std::string gmx::AbstractOptionStorage::formatExtraDescription ( ) const
inlinevirtual

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.

virtual std::string gmx::AbstractOptionStorage::formatValue ( int  i) const
pure virtual
bool gmx::AbstractOptionStorage::isBoolean ( ) const

Returns true if the option is a boolean option.

This is used to optionally support an alternative syntax where an option provided with no value sets the value to true and an option prefixed with "no" clears the value.

virtual void gmx::AbstractOptionStorage::processAll ( )
protectedpure virtual

Performs validation and/or actions once all values have been added.

Exceptions
InvalidInputErrorif all provided values are not valid as a set.

This method is always called once.

If the method throws, implementation should take care to leave the option in a consistent, meaningful state. However, currently none of the implementations actually throw in any situation where the option may be left in an inconsistent state.

Implemented in gmx::OptionStorageTemplate< T >, gmx::OptionStorageTemplate< double >, gmx::OptionStorageTemplate< std::string >, gmx::OptionStorageTemplate< float >, gmx::OptionStorageTemplate< gmx_int64_t >, gmx::OptionStorageTemplate< int >, gmx::OptionStorageTemplate< Selection >, and gmx::OptionStorageTemplate< bool >.

virtual void gmx::AbstractOptionStorage::processSet ( )
protectedpure virtual

Performs validation and/or actions once a set of values has been added.

Exceptions
InvalidInputErrorif the values in the set are not valid as a whole.

This method may be called multiple times if the underlying option can be specified multiple times. This method is not currently called if one of the convertValue() calls throwed.

Todo:
Improve the call semantics.
See Also
OptionStorageTemplate::processSetValues()

Implemented in gmx::OptionStorageTemplate< T >, gmx::OptionStorageTemplate< double >, gmx::OptionStorageTemplate< std::string >, gmx::OptionStorageTemplate< float >, gmx::OptionStorageTemplate< gmx_int64_t >, gmx::OptionStorageTemplate< int >, gmx::OptionStorageTemplate< Selection >, and gmx::OptionStorageTemplate< bool >.

void gmx::AbstractOptionStorage::setMaxValueCount ( int  count)
protected

Sets a new maximum number of values required in one set.

Parameters
[in]countNew maximum number of values (must be > 0, or -1 for no limit).
Exceptions
InvalidInputErrorif already provided values violate the limit.

If values have already been provided, it is checked that there are not too many.

Cannot be called for options with efOption_MultipleTimes set, because it is impossible to check the requirement after the values have been set. If attempted, will assert.

void gmx::AbstractOptionStorage::setMinValueCount ( int  count)
protected

Sets a new minimum number of values required in one set.

Parameters
[in]countNew minimum number of values (must be > 0).
Exceptions
InvalidInputErrorif already provided values violate the limit.

If values have already been provided, it is checked that there are enough.

Cannot be called for options with efOption_MultipleTimes set, because it is impossible to check the requirement after the values have been set. If attempted, will assert.

void gmx::AbstractOptionStorage::startSet ( )

Starts adding a new set of values for the option.

Exceptions
InvalidInputErrorif option is specified multiple times, but is not specified to accept it.

If the parameter is specified multiple times, startSet() should be called before the values for each instance.

Strong exception safety guarantee.

void gmx::AbstractOptionStorage::startSource ( )

Starts adding values from a new source for the option.

This marks the vurrent value of the option as a default value, causing next call to startSet() to clear it. This allows values from the new source to overwrite old values.

This method does not throw.


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