Description

Converts, validates, and stores selection values.

See Also: SelectionOptionManager

Public Member Functions
	SelectionOptionStorage (const SelectionOption &settings, SelectionOptionManager *manager)
	Initializes the storage from option settings. More...

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

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

std::string	formatSingleValue (const Selection &value) const override
	Formats a single value as a string. More...

std::vector< Any >	normalizeValues (const std::vector< Any > &values) const override
	Converts given values to native representation for this option. More...

void	addSelections (const SelectionList &selections, bool bFullValue)
	Adds selections to the storage. More...

bool	allowsOnlyAtoms () const
	Whether the option allows only atom-valued selections.

void	setAllowedValueCount (int count)
	Sets the number of selections allowed for the option. More...

void	setSelectionFlag (SelectionFlag flag, bool bSet)
	Alters flags for the selections created by this option. More...

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

std::vector< Any >	defaultValues () const override

std::vector< std::string >	defaultValuesAsStrings () const override

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...

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 Any &value)
	Adds a new value for the option. 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< Selection >
typedef OptionStorageTemplate < Selection >	MyBase
	Alias for the template class for use in base classes.

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

Protected Types inherited from gmx::OptionStorageTemplate< Selection >
typedef std::unique_ptr < IOptionValueStore< Selection > >	StorePointer
	Smart pointer for managing the final storage interface.

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

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

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

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

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

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

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

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

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

ArrayRef< Selection >	values ()
	Provides derived classes access to the current list of values. More...

ArrayRef< const Selection >	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...

Constructor & Destructor Documentation

gmx::SelectionOptionStorage::SelectionOptionStorage	(	const SelectionOption &	settings,
		SelectionOptionManager *	manager
	)

Initializes the storage from option settings.

Parameters

[in]	settings	Storage settings.
	manager	Manager for this object.

Member Function Documentation

void gmx::SelectionOptionStorage::addSelections	(	const SelectionList &	selections,
		bool	bFullValue
	)

Adds selections to the storage.

Parameters

[in]	selections	List of selections to add.
[in]	bFullValue	If true, the provided selections are the full value of the option, and additional checks are performed.

Exceptions

std::bad_alloc	if out of memory.
InvalidInputError	if There is an incorrect number of selections in `selections`. Any selection in `selections` is not allowed for this option.

This function is used to add selections from SelectionOptionManager. It is called with bFullValue set to false from SelectionOptionManager::convertOptionValue(), and bFullValue set to true when parsing requested selections.

std::string gmx::SelectionOptionStorage::formatSingleValue ( const Selection & value ) const

overridevirtual

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 defaultValuesAsStrings() to do the actual formatting.

Implements gmx::OptionStorageTemplate< Selection >.

std::vector< Any > gmx::SelectionOptionStorage::normalizeValues ( const std::vector< Any > & values ) const

overridevirtual

Converts given values to native representation for this option.

For example, strings are parsed to the type that is actually used to store the options.

The return value only depends on the option type, not on the current value of the option, and the current value in the option is not changed.

Implements gmx::AbstractOptionStorage.

void gmx::SelectionOptionStorage::setAllowedValueCount ( int count )

Sets the number of selections allowed for the option.

Parameters

[in] count Number of allowed selections.

Exceptions

std::bad_alloc	if out of memory.
InvalidInputError	if values have already been provided and their count does not match.

void gmx::SelectionOptionStorage::setSelectionFlag	(	SelectionFlag	flag,
		bool	bSet
	)

Alters flags for the selections created by this option.

Parameters

[in]	flag	Flag to change.
[in]	bSet	Whether to set or clear the flag.

Exceptions

std::bad_alloc	if out of memory.
InvalidInputError	if selections have already been provided and conflict with the given flags.

If selections have already been provided, it is checked that they match the limitations enforced by the flags. Pending requests are also affected.

Strong exception safety guarantee.

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

src/gromacs/selection/selectionoptionstorage.h
src/gromacs/selection/selectionoption.cpp

Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation