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

#include <gromacs/options/basicoptions.h>

+ Inheritance diagram for gmx::DoubleOptionInfo:
+ Collaboration diagram for gmx::DoubleOptionInfo:

Description

Wrapper class for accessing floating-point option information.

Public Member Functions

 DoubleOptionInfo (DoubleOptionStorage *option)
 Creates an option info object for the given option.
 
bool isTime () const
 Whether the option specifies a time value.
 
void setScaleFactor (double factor)
 Sets a scale factor for user-provided values. More...
 
template<class InfoType >
bool isType () const
 Test whether the option is of a particular type. More...
 
template<class InfoType >
InfoType * toType ()
 Convert the info object to a particular type if the type is correct. More...
 
template<class InfoType >
const InfoType * toType () const
 Convert the info object to a particular type if the type is correct. More...
 
bool isSet () const
 Returns true if the option has been set.
 
bool isHidden () const
 Returns true if the option is a hidden option.
 
bool isRequired () const
 Returns true if the option is required.
 
int minValueCount () const
 Returns the minimum number of values that this option accepts.
 
int maxValueCount () const
 Returns the maximum number of values that this option accepts.
 
const std::string & name () const
 Returns the name of the option.
 
std::string type () const
 Returns the type of the option as a string.
 
std::string formatDescription () const
 Returns the description of the option.
 
std::vector< AnydefaultValues () const
 Returns the default value(s) of the option. More...
 
std::vector< std::string > defaultValuesAsStrings () const
 Returns the default value(s) of the option as strings. More...
 
std::vector< AnynormalizeValues (const std::vector< Any > &values) const
 Converts given values to native representation for this option. More...
 

Member Function Documentation

std::vector< Any > gmx::OptionInfo::defaultValues ( ) const
inherited

Returns the default value(s) of the option.

The returned values should all be of the same type, but returning each as a separate any is currently simpler.

Currently, this can only be called before option values have been assigned.

std::vector< std::string > gmx::OptionInfo::defaultValuesAsStrings ( ) const
inherited

Returns the default value(s) of the option as strings.

If there is no default value, but defaultValueIfSet() is set, that is returned instead.

Currently, this can only be called before option values have been assigned.

template<class InfoType >
bool gmx::OptionInfo::isType ( ) const
inlineinherited

Test whether the option is of a particular type.

Template Parameters
InfoTypeOption type to test for. Should be a class derived from OptionInfo.
std::vector< Any > gmx::OptionInfo::normalizeValues ( const std::vector< Any > &  values) const
inherited

Converts given values to native representation for this option.

For example, strings are parsed to the type that is actually used to store the options.

The return value only depends on the option type, not on the current value of the option, and the current value in the option is not changed.

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

template<class InfoType >
InfoType* gmx::OptionInfo::toType ( )
inlineinherited

Convert the info object to a particular type if the type is correct.

Template Parameters
InfoTypeOption type to convert to. Should be a class derived from OptionInfo.
Return values
thisconverted to a pointer to InfoType, or NULL if the conversion is not possible.
template<class InfoType >
const InfoType* gmx::OptionInfo::toType ( ) const
inlineinherited

Convert the info object to a particular type if the type is correct.

Template Parameters
InfoTypeOption type to convert to. Should be a class derived from OptionInfo.
Return values
thisconverted to a pointer to InfoType, or NULL if the conversion is not possible.

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