|
Gromacs
2022.2
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Gromacs
2022.2
|
#include <gromacs/options/basicoptions.h>
Inheritance diagram for gmx::FloatOptionInfo: Collaboration diagram for gmx::FloatOptionInfo:Wrapper class for accessing floating-point option information.
Public Member Functions | |
| FloatOptionInfo (FloatOptionStorage *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... | |
| Public Member Functions inherited from gmx::OptionInfo | |
| 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< Any > | defaultValues () 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< Any > | normalizeValues (const std::vector< Any > &values) const |
| Converts given values to native representation for this option. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from gmx::OptionInfo | |
| OptionInfo (AbstractOptionStorage *option) | |
| Wraps a given option object. More... | |
| AbstractOptionStorage & | option () |
| Returns the wrapped option storage object. | |
| const AbstractOptionStorage & | option () const |
| Returns the wrapped option storage object. | |
| void gmx::FloatOptionInfo::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.
1.8.5