#include <gromacs/options/basicoptions.h>

Inheritance diagram for gmx::EnumOption< EnumType >:

Collaboration diagram for gmx::EnumOption< EnumType >:

Description

template<typename EnumType>
class gmx::EnumOption< EnumType >

Specifies an option that accepts an EnumerationArray of string values and writes the selected index into an enum variable.

Template Parameters

EnumType DataType of the variable that receives the values

Examples:

  enum class MyEnum { Atom, Res, Mol, Count } : int;
  EnumerationArray<MyEnum, const char *> myEnumNames = { "atom", "residue", "molecule" };
  MyEnum       value = MyEnum::Atom; // default value
  options.addOption(EnumOption<MyEnum>("type").enumValue(myEnumNames).store(&value));
* 

storeCount() is not currently implemented for this option type, and providing multiple default values through an array passed to store() does not work consistently in all cases. In the current implementation, the values of the enum type should correspond to indices in the array passed to enumValue(), i.e., be consecutive starting from zero. Only values corresponding to valid indices are accepted as parameters to, e.g., defaultValue(). However, other values can be used as the initial value of the variable (value in the above example), and those will be preserved if the option is not set.

Public methods in this class do not throw.

Public Types
typedef EnumOptionInfo	InfoType
	OptionInfo subclass corresponding to this option type.

typedef OptionTemplate < EnumType, EnumOption < EnumType > >	MyBase
	Short-hand for the base class.

typedef EnumType	ValueType
	Type that stores a single option value.

typedef EnumOption< EnumType >	MyClass
	Alias for the derived class type.

Public Member Functions
	EnumOption (const char *name)
	Initializes an option with the given name.

EnumOption &	enumValue (const EnumerationArray< EnumType, const char * > &values)
	Sets the option to only accept one of a fixed set of strings. More...

MyClass &	description (const char *descr)
	Sets a description for the option. More...

MyClass &	hidden (bool bHidden=true)
	Hides the option from normal help output.

MyClass &	required (bool bRequired=true)
	Requires the option to be specified explicitly. More...

MyClass &	allowMultiple (bool bMulti=true)
	Allows the option to be specified multiple times.

MyClass &	valueCount (int count)
	Requires exactly `count` values for the option.

MyClass &	multiValue (bool bMulti=true)
	Allows any number of values for the option.

MyClass &	defaultValue (const EnumType &defaultValue)
	Sets a default value for the option. More...

MyClass &	defaultValueIfSet (const EnumType &defaultValue)
	Sets a default value for the option when it is set. More...

MyClass &	store (EnumType *store)
	Stores value(s) in memory pointed by `store`. More...

MyClass &	storeCount (int *countptr)
	Stores number of values in the value pointed by `countptr`. More...

MyClass &	storeVector (std::vector< EnumType > *store)
	Stores option values in the provided vector. More...

MyClass &	storeIsSet (bool *store)
	Stores whether the option was explicitly set. More...

Member Function Documentation

MyClass& gmx::OptionTemplate< EnumType , EnumOption< EnumType > >::defaultValue ( const EnumType & defaultValue )

inlineinherited

Sets a default value for the option.

Parameters

[in] defaultValue Default value.

If the option is never set, the default value is copied to the assigned storage. Note that if the option is not set and there is no default value, the storage is not altered, which can also be used to provide a default value. The latter method has to be used if the option can take multiple values.

defaultValue is copied when the option is created.

MyClass& gmx::OptionTemplate< EnumType , EnumOption< EnumType > >::defaultValueIfSet ( const EnumType & defaultValue )

inlineinherited

Sets a default value for the option when it is set.

Parameters

[in] defaultValue Default value.

This value is used if the option is set, but no value is provided. If the option is never set, the value set with defaultValue() is used. Can only be used for options that accept a single value.

defaultValue is copied when the option is created.

MyClass& gmx::OptionTemplate< EnumType , EnumOption< EnumType > >::description ( const char * descr )

inlineinherited

Sets a description for the option.

Parameters

[in] descr Description to set.

String in descr is copied when the option is created.

template<typename EnumType >

EnumOption& gmx::EnumOption< EnumType >::enumValue ( const EnumerationArray< EnumType, const char * > & values )

inline

Sets the option to only accept one of a fixed set of strings.

Parameters

[in] values Array of strings to accept.

Also accepts prefixes of the strings; if a prefix matches more than one of the possible strings, the shortest one is used (in a tie, the first one is).

The strings are copied once the option is created.

MyClass& gmx::OptionTemplate< EnumType , EnumOption< EnumType > >::required ( bool bRequired = true )

inlineinherited

Requires the option to be specified explicitly.

Note that if you specify defaultValue() together with required(), the user is not required to explicitly provide the option. In this case, required() only affects possible help output.

MyClass& gmx::OptionTemplate< EnumType , EnumOption< EnumType > >::store ( EnumType * store )

inlineinherited

Stores value(s) in memory pointed by store.

Parameters

[in] store Storage for option value(s).

The caller is responsible for allocating enough memory such that the any allowed number of values fits into the array pointed by store. If there is no maximum allowed number or if the maximum is inconveniently large, storeVector() should be used.

For information on when values are available in the storage, see storeVector().

The pointer provided should remain valid as long as the associated Options object exists.

MyClass& gmx::OptionTemplate< EnumType , EnumOption< EnumType > >::storeCount ( int * countptr )

inlineinherited

Stores number of values in the value pointed by countptr.

Parameters

[in] countptr Storage for the number of values.

For information on when values are available in the storage, see storeVector().

The pointers provided should remain valid as long as the associated Options object exists.

MyClass& gmx::OptionTemplate< EnumType , EnumOption< EnumType > >::storeIsSet ( bool * store )

inlineinherited

Stores whether the option was explicitly set.

Parameters

[in] store Variable to store the flag in.

The value is set to false on creation of the option, and to true as soon as a value is assigned to the option. A default value does not set the flag to true, but assignment that uses defaultValueIfSet() does.

The pointer provided should remain valid as long as the associated Options object exists.

MyClass& gmx::OptionTemplate< EnumType , EnumOption< EnumType > >::storeVector ( std::vector< EnumType > * store )

inlineinherited

Stores option values in the provided vector.

Parameters

[in] store Vector to store option values in.

Values are added to the vector after each successful set of values is parsed. Note that for some options, the value may be changed later, and is only guaranteed to be correct after Options::finish() has been called.

The pointer provided should remain valid as long as the associated Options object exists.

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

api/legacy/include/gromacs/options/basicoptions.h

Description

template<typename EnumType> class gmx::EnumOption< EnumType >

Public Types

Public Member Functions

Member Function Documentation

template<typename EnumType>
class gmx::EnumOption< EnumType >