Description

Converts, validates, and stores integer values.

Public Member Functions
	Int64OptionStorage (const Int64Option &settings)
	Initializes the storage from option settings. More...

virtual OptionInfo &	optionInfo ()
	Returns an option info object corresponding to this option.

virtual std::string	typeString () const
	Returns a short string describing the type of the option.

virtual std::string	formatSingleValue (const gmx_int64_t &value) const
	Formats a single value as a string. More...

Public Member Functions inherited from gmx::OptionStorageTemplate< gmx_int64_t >
virtual int	valueCount () const
	Returns the number of option values added so far. More...

virtual std::string	formatValue (int i) const
	Returns the i'th value formatted as a string. More...

Public Member Functions inherited from gmx::AbstractOptionStorage
bool	isSet () const
	Returns true if the option has been set.

bool	isBoolean () const
	Returns true if the option is a boolean option. More...

bool	isHidden () const
	Returns true if the option is a hidden option.

bool	isRequired () const
	Returns true if the option is required.

bool	isVector () const
	Returns true if the option is vector-valued.

const std::string &	name () const
	Returns the name of the option.

const std::string &	description () const
	Returns the description of the option set by the calling code.

bool	defaultValueIfSetExists () const
	Returns true if defaultValueIfSet() value is specified.

int	minValueCount () const
	Returns the minimum number of values required in one set.

int	maxValueCount () const
	Returns the maximum allowed number of values in one set (-1 = no limit).

virtual std::string	formatExtraDescription () const
	Formats additional description for the option. More...

std::string	formatDefaultValueIfSet () const
	Returns the default value if set for the option as a string. More...

void	startSource ()
	Starts adding values from a new source for the option. More...

void	startSet ()
	Starts adding a new set of values for the option. More...

void	appendValue (const std::string &value)
	Adds a new value for the option, converting it from a string. More...

void	finishSet ()
	Performs validation and/or actions once a set of values has been added. More...

void	finish ()
	Performs validation and/or actions once all values have been added. More...

Additional Inherited Members
Public Types inherited from gmx::OptionStorageTemplate< gmx_int64_t >
typedef OptionStorageTemplate < gmx_int64_t >	MyBase
	Alias for the template class for use in base classes.

typedef std::vector< gmx_int64_t >	ValueList
	Type of the container that contains the current values.

Protected Member Functions inherited from gmx::OptionStorageTemplate< gmx_int64_t >
	OptionStorageTemplate (const OptionTemplate< gmx_int64_t, U > &settings, OptionFlags staticFlags=OptionFlags())
	Initializes the storage from option settings. More...

	OptionStorageTemplate (const AbstractOption &settings)
	Initializes the storage from base option settings. More...

virtual void	clearSet ()
	Removes all values from temporary storage for a set. More...

virtual void	processSetValues (ValueList *values)
	Processes values for a set after all have been converted. More...

virtual void	processSet ()
	Performs validation and/or actions once a set of values has been added. More...

virtual void	processAll ()
	Performs validation and/or actions once all values have been added. More...

void	clear ()
	Removes all values from the storage. More...

void	addValue (const gmx_int64_t &value)
	Adds a value to a temporary storage. More...

void	commitValues ()
	Commits values added with addValue(). More...

virtual void	refreshValues ()
	Updates alternative store locations. More...

void	setDefaultValue (const gmx_int64_t &value)
	Sets the default value for the option. More...

void	setDefaultValueIfSet (const gmx_int64_t &value)
	Sets the default value if set for the option. More...

ValueList &	values ()
	Provides derived classes access to the current list of values. More...

const ValueList &	values () const
	Provides derived classes access to the current list of values.

Protected Member Functions inherited from gmx::AbstractOptionStorage
	AbstractOptionStorage (const AbstractOption &settings, OptionFlags staticFlags)
	Initializes the storage object from the settings object. More...

void	markAsSet ()
	Marks the option as set.

bool	hasFlag (OptionFlag flag) const
	Returns true if the given flag is set.

void	setFlag (OptionFlag flag)
	Sets the given flag.

void	clearFlag (OptionFlag flag)
	Clears the given flag.

void	setMinValueCount (int count)
	Sets a new minimum number of values required in one set. More...

void	setMaxValueCount (int count)
	Sets a new maximum number of values required in one set. More...

Static Protected Attributes inherited from gmx::AbstractOptionStorage
static const int	DefaultValueIfSetIndex = -1
	Index used with formatValue() for formatting default value if set.

Constructor & Destructor Documentation

gmx::Int64OptionStorage::Int64OptionStorage ( const Int64Option & settings )

inlineexplicit

Initializes the storage from option settings.

Parameters

[in] settings Storage settings.

Member Function Documentation

std::string gmx::Int64OptionStorage::formatSingleValue ( const gmx_int64_t & value ) const

virtual

Formats a single value as a string.

Parameters

[in] value Value to format.

Returns: value formatted as a string.

The derived class must provide this method to format values a strings. Called by formatValue() to do the actual formatting.

Implements gmx::OptionStorageTemplate< gmx_int64_t >.

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

src/gromacs/options/basicoptionstorage.h
src/gromacs/options/basicoptions.cpp

Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation