Description of an enumeration parameter More...

Inheritance diagram for stromx::runtime::EnumParameter:

Public Member Functions
	EnumParameter (const unsigned int id, ParameterGroup *const group=0)

virtual const std::vector< EnumDescription > &	descriptions () const

virtual void	add (const EnumDescription &description)

virtual void	remove (const Enum &description)

Public Member Functions inherited from stromx::runtime::Parameter
	Parameter (const unsigned int id, const VariantHandle &variant, ParameterGroup *const group=0)

AccessMode	accessMode () const

void	setAccessMode (const AccessMode mode)

UpdateBehavior	updateBehavior () const

void	setUpdateBehavior (const UpdateBehavior behavior)

virtual const Parameter *	group () const

virtual const std::vector< const Parameter * > &	members () const

virtual Type	originalType () const

virtual Type	currentType () const

Public Member Functions inherited from stromx::runtime::Description
	Description (const unsigned int id, const VariantHandle &variant)

const std::string &	title () const

unsigned int	id () const

const VariantHandle &	variant () const

void	setTitle (const std::string &title)

const VariantHandle &	visualization () const

void	setVisualization (const VariantHandle &visualization)

virtual const Data &	max () const

virtual const Data &	min () const

virtual const Data &	step () const

virtual unsigned int	rows () const

virtual unsigned int	cols () const

Additional Inherited Members
Public Types inherited from stromx::runtime::Parameter
enum	AccessMode { NO_ACCESS, NONE_READ, NONE_WRITE, INITIALIZED_READ, INITIALIZED_WRITE, ACTIVATED_WRITE }

Public Types inherited from stromx::runtime::Description
enum	Type { NO_TYPE, PARAMETER, INPUT, OUTPUT }

enum	UpdateBehavior { PERSISTENT, PUSH, PULL, INTERNAL }

Detailed Description

Description of an enumeration parameter

Constructor & Destructor Documentation

stromx::runtime::EnumParameter::EnumParameter	(	const unsigned int	id,
		ParameterGroup *const	group = `0`
	)

Constructs an enumeration parameter.

void stromx::runtime::EnumParameter::add ( const EnumDescription & description )

virtual

Adds a description of a possible enumeration value.

Exceptions

WrongArgument If description with the same value has already been added.

virtual const std::vector<EnumDescription>& stromx::runtime::EnumParameter::descriptions ( ) const

inlinevirtual

Returns the possible values of an enumeration value or an empty vector.

void stromx::runtime::EnumParameter::remove ( const Enum & description )

virtual

Removes a value from the possible enumeration values.

Exceptions

WrongArgument If no description with the same value exists.

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