ValueParameterGroup Class Reference

Search for all occurrences

---

Detailed Description

ValueParameterGroup represents an object consisting of a list of named and typed parameters (see awSupport::Parameter).

Each instance of this class also has a name and type;

#include <ValueParameterGroup.h>

Inheritance diagram for ValueParameterGroup:

List of all members.

Public Types
typedef aw::map < awString::IString, ValueParameterRef >	ParameterList
Public Member Functions
	ValueParameterGroup (const awString::IString &name, const awString::IString &type, const awString::IString &className)
	ValueParameterGroup (const ValueParameterGroup &src)
virtual ParameterGroupRef	clone () const
virtual const awString::IString &	getOwnedObjectType () const
virtual ParameterRef	createParameter (const awString::IString &name, Parameter::Type type, const awString::IString &valueAsString)
virtual bool	addParameter (const ParameterRef &param)
ValueParameterRef	getNativeParameterByName (const awString::IString &name) const
virtual ParameterRef	getParameterByName (const awString::IString &name) const
virtual int	getParameterCount () const
virtual bool	removeParameter (const ParameterRef &param)
virtual bool	removeAllParameters ()
virtual ParameterIteratorRef	getIterator () const
virtual ValueParameterIteratorRef	getNativeIterator () const
virtual ParameterGroupRef	getConnectedParameterGroup (const awString::IString &name) const
bool	forceParameterDouble (const awString::IString &name, const double value)
	Shortcut for forcing a double or matrix parameter:
bool	forceParameterAffineMatrix (const awString::IString &name, const awLinear::AffineMatrix &value)
virtual bool	operator== (const ParameterGroup &other) const
	Two parameter groups are equal if they have the same name, the same type, the same number of parameters, and the same parameters.
virtual bool	isEquivalent (const ParameterGroup &other) const
	Same as operator==, except that two parameter groups that have different names are considered equivalent.
bool	isEquivalent (const ValueParameterGroup &other) const
Static Public Attributes
static awRTB::SignalArg < ValueParameterGroup * >	sigParameterGroupDeleted
	If you want to know when this ValueParameterGroup is deleted, connect yourself to this signal.
Protected Member Functions
virtual	~ValueParameterGroup ()

---

Member Typedef Documentation

typedef aw::map<awString::IString, ValueParameterRef> ParameterList

Search for all occurrences

---

Constructor & Destructor Documentation

ValueParameterGroup	(	const awString::IString &	name,
		const awString::IString &	type,
		const awString::IString &	className
	)

ValueParameterGroup

(

const ValueParameterGroup &

src

)

virtual ~ValueParameterGroup

(

)

[protected, virtual]

---

Member Function Documentation

virtual ParameterGroupRef clone

(

)

const [virtual]

Search for all occurrences

Implements ParameterGroup.

Reimplemented in ObjectAssociations, and ObjectProperties.

virtual const awString::IString& getOwnedObjectType

(

)

const [virtual]

Search for all occurrences

Reimplemented from ParameterGroup.

virtual ParameterRef createParameter	(	const awString::IString &	name,
		Parameter::Type	type,
		const awString::IString &	valueAsString
	)		[virtual]

Search for all occurrences

Implements ParameterGroup.

virtual bool addParameter

(

const ParameterRef &

param

)

[virtual]

Search for all occurrences

Implements ParameterGroup.

ValueParameterRef getNativeParameterByName

(

const awString::IString &

name

)

const

Search for all occurrences

virtual ParameterRef getParameterByName

(

const awString::IString &

name

)

const [virtual]

Search for all occurrences

Reimplemented from ParameterGroup.

virtual int getParameterCount

(

)

const [virtual]

Search for all occurrences

Implements ParameterGroup.

virtual bool removeParameter

(

const ParameterRef &

param

)

[virtual]

Search for all occurrences

Implements ParameterGroup.

virtual bool removeAllParameters

(

)

[virtual]

Search for all occurrences

Implements ParameterGroup.

virtual ParameterIteratorRef getIterator

(

)

const [virtual]

Search for all occurrences

Implements ParameterGroup.

virtual ValueParameterIteratorRef getNativeIterator

(

)

const [virtual]

Search for all occurrences

virtual ParameterGroupRef getConnectedParameterGroup

(

const awString::IString &

name

)

const [virtual]

Search for all occurrences

Implements ParameterGroup.

bool forceParameterDouble	(	const awString::IString &	name,
		const double	value
	)

Search for all occurrences

Shortcut for forcing a double or matrix parameter:

bool forceParameterAffineMatrix	(	const awString::IString &	name,
		const awLinear::AffineMatrix &	value
	)

Search for all occurrences

virtual bool operator==

(

const ParameterGroup &

other

)

const [virtual]

Two parameter groups are equal if they have the same name, the same type, the same number of parameters, and the same parameters.

Implements ParameterGroup.

virtual bool isEquivalent

(

const ParameterGroup &

other

)

const [virtual]

Search for all occurrences

Same as operator==, except that two parameter groups that have different names are considered equivalent.

Implements ParameterGroup.

bool isEquivalent

(

const ValueParameterGroup &

other

)

const

Search for all occurrences

---

Member Data Documentation

awRTB::SignalArg<ValueParameterGroup*> sigParameterGroupDeleted [static]

Search for all occurrences

If you want to know when this ValueParameterGroup is deleted, connect yourself to this signal.

This member is not exported through SWIG as currently we do not export any of the awRTB classes.