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

#include <gromacs/selection/selectionfileoption.h>

+ Inheritance diagram for gmx::SelectionFileOptionInfo:
+ Collaboration diagram for gmx::SelectionFileOptionInfo:

Description

Wrapper class for accessing and modifying selection file option information.

Public Member Functions

 SelectionFileOptionInfo (SelectionFileOptionStorage *option)
 Creates option info object for given storage object. 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< 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...
 

Additional Inherited Members

- Protected Member Functions inherited from gmx::OptionInfo
 OptionInfo (AbstractOptionStorage *option)
 Wraps a given option object. More...
 
AbstractOptionStorageoption ()
 Returns the wrapped option storage object.
 
const AbstractOptionStorageoption () const
 Returns the wrapped option storage object.
 

Constructor & Destructor Documentation

gmx::SelectionFileOptionInfo::SelectionFileOptionInfo ( SelectionFileOptionStorage option)
explicit

Creates option info object for given storage object.

Does not throw.


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