Inheritance diagram for Parameters:

Public Member Functions
	Parameters (const string &name, const string &description)

	Parameters (const Parameters &parameter)

const Parameters &	operator= (const Parameters &parameter)

Parameter *	add (Parameter *parameter)

Parameter *	getParameter (const string name)

ParameterIterator	begin ()

ParameterIterator	end ()

ParameterConstIterator	begin () const

ParameterConstIterator	end () const

virtual void	initialize ()=0

void	clear ()
	Clear/delete all parameters held by this container.

bool	isEnabled ()

bool	isEditable ()

void	setEnabled (bool value)

void	setEditable (bool value)

Public Member Functions inherited from Named
void	setName (const string &newName)
	Set the name of the object.

const string &	getName () const
	Get the name of the object.

bool	isName (const string &aName) const
	Determine whether name equals given name.

Public Member Functions inherited from Described
void	setDescription (const string &description)
	Set the Describe of the object.

const string	getDescription () const
	Get the Describe of the object.

bool	isDescribed () const
	Determine whether Describe is set, i.e object has a Describe.

bool	isDescription (const string &description) const
	Determine whether Describe equals given Describe.

bool	sameDescriptionAs (const Described &described) const
	Determine whether Describe equals that of given object.

Protected Attributes
ParameterVector	parameterVector

bool	_enabled

bool	_editable

Protected Attributes inherited from Named
string	_name

Protected Attributes inherited from Described
string	_description

Additional Inherited Members
Protected Member Functions inherited from Named
	Named (const string &aName=" ")
	Only derived class are Named.

Protected Member Functions inherited from Described
	Described (const string &aDescribe=" ")
	Only derived class are Described.

Detailed Description

Definition at line 20 of file Parameters.h.

Member Function Documentation

bool Parameters::isEditable ( )

inline

Get the "editable" state of this object.

The "editable" state dictates whether this object can be edited by user code, or via a GUI interface.

Definition at line 65 of file Parameters.h.

bool Parameters::isEnabled ( )

inline

Get the "enabled" state of this object.

The "enabled" state dictates whether this object is available for use.

Definition at line 56 of file Parameters.h.

void Parameters::setEditable ( bool value )

inline

Set the "editable" state of this object.

The "editable" state dictates whether this object can be edited by user code, or via a GUI interface.

Definition at line 83 of file Parameters.h.

void Parameters::setEnabled ( bool value )

inline

Set the "enabled" state of this object to the given value.

The "enabled" state dictates whether this object is available for use.

Definition at line 74 of file Parameters.h.

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