|
Gromacs
2026.0-dev-20251119-5f0a571d
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Gromacs
2026.0-dev-20251119-5f0a571d
|
#include <gromacs/options/basicoptions.h>
Inheritance diagram for gmx::StringOptionInfo: Collaboration diagram for gmx::StringOptionInfo:Wrapper class for accessing string option information.
Public Member Functions | |
| StringOptionInfo (StringOptionStorage *option) | |
| Creates an option info object for the given option. | |
| bool | isEnumerated () const |
| Whether this option accepts an enumerated set of values. More... | |
| const std::vector< std::string > & | allowedValues () const |
| Returns the set of allowed values for this option. 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. | |
| const std::vector< std::string > & gmx::StringOptionInfo::allowedValues | ( | ) | const |
Returns the set of allowed values for this option.
Returns an empty vector if isEnumerated() returns false.
| bool gmx::StringOptionInfo::isEnumerated | ( | ) | const |
Whether this option accepts an enumerated set of values.
Returns true if StringOption::enumValues() was used when creating this option.
1.8.5