Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions
gmx::OptionTemplate< T, U > Class Template Reference

#include <gromacs/options/abstractoption.h>

+ Inheritance diagram for gmx::OptionTemplate< T, U >:
+ Collaboration diagram for gmx::OptionTemplate< T, U >:

Description

template<typename T, class U>
class gmx::OptionTemplate< T, U >

Templated base class for constructing concrete option settings classes.

Template Parameters
TAssignable type that stores a single option value.
UType of the derived class.

This template is used as a base class like this:

class ConcreteOption : public OptionTemplate<int, ConcreteOption>
{
*

All public functions in this class return *this casted to a reference to U. They do not throw.

For examples of how to use classes derived from this class, see the class documentation for Options.

Public Types

typedef T ValueType
 Type that stores a single option value.
 
typedef U MyClass
 Alias for the derived class type.
 

Public Member Functions

MyClassdescription (const char *descr)
 Sets a description for the option. More...
 
MyClasshidden (bool bHidden=true)
 Hides the option from normal help output.
 
MyClassrequired (bool bRequired=true)
 Requires the option to be specified explicitly. More...
 
MyClassallowMultiple (bool bMulti=true)
 Allows the option to be specified multiple times.
 
MyClassvalueCount (int count)
 Requires exactly count values for the option.
 
MyClassmultiValue (bool bMulti=true)
 Allows any number of values for the option.
 
MyClassdefaultValue (const T &defaultValue)
 Sets a default value for the option. More...
 
MyClassdefaultValueIfSet (const T &defaultValue)
 Sets a default value for the option when it is set. More...
 
MyClassstore (T *store)
 Stores value(s) in memory pointed by store. More...
 
MyClassstoreCount (int *countptr)
 Stores number of values in the value pointed by countptr. More...
 
MyClassstoreVector (std::vector< T > *store)
 Stores option values in the provided vector. More...
 
MyClassstoreIsSet (bool *store)
 Stores whether the option was explicitly set. More...
 

Member Function Documentation

template<typename T, class U>
MyClass& gmx::OptionTemplate< T, U >::defaultValue ( const T &  defaultValue)
inline

Sets a default value for the option.

Parameters
[in]defaultValueDefault 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.

template<typename T, class U>
MyClass& gmx::OptionTemplate< T, U >::defaultValueIfSet ( const T &  defaultValue)
inline

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

Parameters
[in]defaultValueDefault 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.

template<typename T, class U>
MyClass& gmx::OptionTemplate< T, U >::description ( const char *  descr)
inline

Sets a description for the option.

Parameters
[in]descrDescription to set.

String in descr is copied when the option is created.

template<typename T, class U>
MyClass& gmx::OptionTemplate< T, U >::required ( bool  bRequired = true)
inline

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.

template<typename T, class U>
MyClass& gmx::OptionTemplate< T, U >::store ( T *  store)
inline

Stores value(s) in memory pointed by store.

Parameters
[in]storeStorage 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.

template<typename T, class U>
MyClass& gmx::OptionTemplate< T, U >::storeCount ( int *  countptr)
inline

Stores number of values in the value pointed by countptr.

Parameters
[in]countptrStorage 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.

template<typename T, class U>
MyClass& gmx::OptionTemplate< T, U >::storeIsSet ( bool *  store)
inline

Stores whether the option was explicitly set.

Parameters
[in]storeVariable 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.

template<typename T, class U>
MyClass& gmx::OptionTemplate< T, U >::storeVector ( std::vector< T > *  store)
inline

Stores option values in the provided vector.

Parameters
[in]storeVector 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: