gmx::Int64Option Class Reference

#include <gromacs/options/basicoptions.h>

Inheritance diagram for gmx::Int64Option:

Collaboration diagram for gmx::Int64Option:

Description

Specifies an option that provides 64-bit integer values.

Public methods in this class do not throw.

See Also

IntegerOption

Public Types
typedef Int64OptionInfo	InfoType
	OptionInfo subclass corresponding to this option type.
Public Types inherited from gmx::OptionTemplate< int64_t, Int64Option >
typedef int64_t	ValueType
	Type that stores a single option value.
typedef Int64Option	MyClass
	Alias for the derived class type.

Public Member Functions
	Int64Option (const char *name)
	Initializes an option with the given name.
Public Member Functions inherited from gmx::OptionTemplate< int64_t, Int64Option >
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 int64_t &defaultValue)
	Sets a default value for the option. More...
MyClass &	defaultValueIfSet (const int64_t &defaultValue)
	Sets a default value for the option when it is set. More...
MyClass &	store (int64_t *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< int64_t > *store)
	Stores option values in the provided vector. More...
MyClass &	storeIsSet (bool *store)
	Stores whether the option was explicitly set. More...

Friends
class	Int64OptionStorage
	Needed to initialize Int64OptionStorage from this class without otherwise unnecessary accessors.

Additional Inherited Members
Protected Types inherited from gmx::OptionTemplate< int64_t, Int64Option >
typedef OptionTemplate < int64_t, Int64Option >	MyBase
	Alias for the template class for use in base classes.
Protected Member Functions inherited from gmx::OptionTemplate< int64_t, Int64Option >
const int64_t *	defaultValue () const
	Returns a pointer to user-specified default value, or NULL if there is none.
const int64_t *	defaultValueIfSet () const
	Returns a pointer to user-specified default value, or NULL if there is none.
int64_t *	store () const
	Returns a pointer to the storage location, or NULL if none specified.
std::vector< int64_t > *	storeVector () const
	Returns a pointer to the storage vector, or NULL if none specified.
	OptionTemplate (const char *name)
	Initializes the name and default values for an option.
MyClass &	me ()
	Returns *this casted into MyClass to reduce typing.
Protected Member Functions inherited from gmx::AbstractOption
	AbstractOption (const char *name)
	Initializes the name and default values for an option.
void	setDescription (const char *descr)
	Sets the description for the option.
void	setStoreIsSet (bool *store)
	Sets the storage location for whether the option is set.
void	setFlag (OptionFlag flag)
	Sets a flag for the option.
void	clearFlag (OptionFlag flag)
	Clears a flag for the option.
void	setFlag (OptionFlag flag, bool bSet)
	Sets or clears a flag for the option.
bool	isVector () const
	Returns true if the option is vector-valued.
void	setVector ()
	Sets the option to be vector-valued. More...
void	setValueCount (int count)
	Sets the required number of values for the option.
Protected Attributes inherited from gmx::AbstractOption
int	minValueCount_
	Minimum number of values required for the option.
int	maxValueCount_
	Maximum number of values allowed for the option.

---

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

• api/legacy/include/gromacs/options/basicoptions.h
• src/gromacs/options/basicoptions.cpp