ParameterGroup Class Reference

Class representing a group of parameters of a Node. More...

#include <ParameterGroup.h>

Inheritance diagram for ParameterGroup:

Collaboration diagram for ParameterGroup:

List of all members.

Public Member Functions

ParameterGroup (const QString &name="")

Constructor of the ParameterGroup class.

virtual ~ParameterGroup ()

Destructor of the ParameterGroup class.

virtual void setEnabled (bool enabled)

Sets whether the controls for editing the parameter group in the UI should be enabled.

virtual void setNode (Node *node)

Sets the node to which this parameter group belongs.

virtual AbstractParameter * clone ()

Creates an exact copy of the parameter.

virtual bool isGroup () const

Returns whether the parameter object derived from this class is a parameter group.

virtual void reset ()

Resets the parameters contained in the group to their default values.

void disconnectParameters (QObject *receiver)

Disconnects all signals from parameters contained in the group from slots of the given receiver object.

void clear ()

Clears the parameter group by emptying the parameter data structures.

void destroyAllParameters ()

Destroys all parameters in the group.

QList< Parameter * > filterParameters (QString searchText, bool diveInChildGroups, bool getAll=false) const

Returns a list of parameters whose names contain the given search text.

bool containsGroup (const QString &name) const

Returns whether the group contains a group with the given name.

bool contains (const QString &name) const

Returns whether the group contains a parameter with the given name.

bool contains (Parameter *parameter) const

Returns whether the group contains the given parameter.

bool contains (Parameter::Type parameterType) const

Returns whether the group contains parameters of the given type.

bool contains (Parameter::PinType pinType) const

Returns whether the group contains parameters of the given pin type.

bool contains (Parameter::PinType pinType, bool connected) const

Returns whether the group contains parameters of the given pin type and of the given connection status.

bool isEmpty () const

Returns whether the group contains parameters or not.

void addParameter (AbstractParameter *parameter, bool prepend=false)

Adds the given parameter to the group of parameters.

Parameter * getParameter (const QString &name) const

Returns the parameter with the given name.

Parameter * removeParameter (const QString &name)

Removes and deletes the parameter with the given name from the parameter group.

Parameter * removeParameter (Parameter *parameter)

Removes and deletes the given parameter from the parameter group.

void removeParameterGroup (const QString &name)

Removes and deletes the given parameter group from the parameter group.

ParameterGroup * getParameterGroup (const QString &name, bool recursive=true) const

Returns the parameter group with the given name.

AbstractParameter::List * getParameterList ()

Returns a pointer to the list of parameters and parameter groups that are contained in this group.

AbstractParameter::Map * getParameterMap ()

Returns a pointer to the map of parameters and parameter groups that are contained in this group.

Private Attributes

AbstractParameter::List m_parameterList

The list of parameters or parameter groups contained in this group.

AbstractParameter::Map m_parameterMap

The map of parameters or parameter groups contained in this group.

Detailed Description

Class representing a group of parameters of a Node.

Constructor & Destructor Documentation

ParameterGroup::ParameterGroup ( const QString & name = "" )

Constructor of the ParameterGroup class.

Constructors and Destructors.

Parameters:

name

The name of the parameter group.

Constructor of the ParameterGroup class.

Parameters:

name

The name of the parameter group.

ParameterGroup::~ParameterGroup ( ) [virtual]

Destructor of the ParameterGroup class.

Member Function Documentation

void ParameterGroup::setEnabled ( bool enabled ) [virtual]

Sets whether the controls for editing the parameter group in the UI should be enabled.

Public Functions.

Recursively sets the enabled state for all parameters and parameter groups contained in this group.

Parameters:

enabled

The value for the parameters' enabled flags.

Sets whether the controls for editing the parameter group in the UI should be enabled.

Recursively sets the enabled state for all parameters and parameter groups contained in this group.

Parameters:

enabled

The value for the parameters' enabled flags.

Reimplemented from AbstractParameter.

void ParameterGroup::setNode ( Node * node ) [virtual]

Sets the node to which this parameter group belongs.

Recursively sets the node for all parameters and parameter groups contained in this group.

Parameters:

node

The node to which the parameter group belongs.

Reimplemented from AbstractParameter.

AbstractParameter * ParameterGroup::clone ( ) [virtual]

Creates an exact copy of the parameter.

Returns:: An exact copy of the parameter.

Implements AbstractParameter.

bool ParameterGroup::isGroup ( ) const [virtual]

Returns whether the parameter object derived from this class is a parameter group.

Returns:: True if the parameter object is a parameter group, otherwise False.

Implements AbstractParameter.

void ParameterGroup::reset ( ) [virtual]

Resets the parameters contained in the group to their default values.

Implements AbstractParameter.

void ParameterGroup::disconnectParameters ( QObject * receiver )

Disconnects all signals from parameters contained in the group from slots of the given receiver object.

Parameters:

receiver

The object to disconnect the contained parameters from.

void ParameterGroup::clear ( )

Clears the parameter group by emptying the parameter data structures.

void ParameterGroup::destroyAllParameters ( )

Destroys all parameters in the group.

QList< Parameter * > ParameterGroup::filterParameters	(	QString	searchText,
		bool	diveInChildGroups,
		bool	getAll = `false`
	)			const

Returns a list of parameters whose names contain the given search text.

Parameters:

	searchText	The text to match the parameter names against.
	diveInChildGroups	Flag to control whether to also process child groups.
	getAll	Retrieves all parameters.

Returns:: A list of parameters whose names contain the given search text.

Parameters:

	searchText	The text to match the parameter names against.
	diveInChildGroups	Flag to control whether to also process child groups.

Returns:: A list of parameters whose names contain the given search text.

bool ParameterGroup::containsGroup ( const QString & name ) const

Returns whether the group contains a group with the given name.

Parameters:

name

The group name to find in the group.

Returns:: True if the group contains a group with the given name, otherwise False.

bool ParameterGroup::contains ( const QString & name ) const

Returns whether the group contains a parameter with the given name.

Parameters:

name

The parameter name to find in the group.

Returns:: True if the group contains a parameter with the given name, otherwise False.

bool ParameterGroup::contains ( Parameter * parameter ) const

Returns whether the group contains the given parameter.

Parameters:

parameter

The parameter to find in the group.

Returns:: True if the group contains the given parameter, otherwise False.

bool ParameterGroup::contains ( Parameter::Type parameterType ) const

Returns whether the group contains parameters of the given type.

Parameters:

parameterType

The parameter type to find in the group.

Returns:: True if the group contains parameters of the given type, otherwise False.

bool ParameterGroup::contains ( Parameter::PinType pinType ) const

Returns whether the group contains parameters of the given pin type.

Parameters:

pinType

The pin type of parameters to look for in the group.

Returns:: True if the group contains parameters of the given pin type, otherwise False.

bool ParameterGroup::contains	(	Parameter::PinType	pinType,
		bool	connected
	)			const

Returns whether the group contains parameters of the given pin type and of the given connection status.

Parameters:

	pinType	The pin type of parameters to look for in the group.
	connected	The connection status of parameters to look for in the group.

Returns:: True if the group contains parameters of the given pin type and of the given connection status, otherwise False.

bool ParameterGroup::isEmpty ( ) const

Returns whether the group contains parameters or not.

void ParameterGroup::addParameter	(	AbstractParameter *	parameter,
		bool	prepend = `false`
	)

Adds the given parameter to the group of parameters.

Adds the given parameter to the list of parameters.

Parameters:

	parameter	The parameter to add.
	prepend	Flag to control whether to insert the parameter at the beginning of the parameter list.

Parameter * ParameterGroup::getParameter ( const QString & name ) const

Returns the parameter with the given name.

Parameters:

name

The name of the parameter to return.

Returns:: The parameter with the given name.

Parameter * ParameterGroup::removeParameter ( const QString & name )

Removes and deletes the parameter with the given name from the parameter group.

Parameters:

name

The name of the parameter to remove and delete.

Returns:: 0.

Parameter * ParameterGroup::removeParameter ( Parameter * parameter )

Removes and deletes the given parameter from the parameter group.

Parameters:

parameter

The parameter to remove and delete.

Returns:: 0.

void ParameterGroup::removeParameterGroup ( const QString & name )

Removes and deletes the given parameter group from the parameter group.

Parameters:

parameter

The parameter group to remove and delete.

ParameterGroup * ParameterGroup::getParameterGroup	(	const QString &	name,
		bool	recursive = `true`
	)			const

Returns the parameter group with the given name.

Parameters:

name

The name of the parameter group to return.

Returns:: The parameter group with the given name.

AbstractParameter::List * ParameterGroup::getParameterList ( )

Returns a pointer to the list of parameters and parameter groups that are contained in this group.

Returns:: A pointer to the list of parameters of this group.

AbstractParameter::Map * ParameterGroup::getParameterMap ( )

Returns a pointer to the map of parameters and parameter groups that are contained in this group.

Returns:: A pointer to the map of parameters of this group.

Member Data Documentation

AbstractParameter::List ParameterGroup::m_parameterList [private]

The list of parameters or parameter groups contained in this group.

AbstractParameter::Map ParameterGroup::m_parameterMap [private]

The map of parameters or parameter groups contained in this group.

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


Public Member Functions
	ParameterGroup (const QString &name="")
	Constructor of the ParameterGroup class.
virtual	~ParameterGroup ()
	Destructor of the ParameterGroup class.
virtual void	setEnabled (bool enabled)
	Sets whether the controls for editing the parameter group in the UI should be enabled.
virtual void	setNode (Node *node)
	Sets the node to which this parameter group belongs.
virtual AbstractParameter *	clone ()
	Creates an exact copy of the parameter.
virtual bool	isGroup () const
	Returns whether the parameter object derived from this class is a parameter group.
virtual void	reset ()
	Resets the parameters contained in the group to their default values.
void	disconnectParameters (QObject *receiver)
	Disconnects all signals from parameters contained in the group from slots of the given receiver object.
void	clear ()
	Clears the parameter group by emptying the parameter data structures.
void	destroyAllParameters ()
	Destroys all parameters in the group.
QList< Parameter * >	filterParameters (QString searchText, bool diveInChildGroups, bool getAll=false) const
	Returns a list of parameters whose names contain the given search text.
bool	containsGroup (const QString &name) const
	Returns whether the group contains a group with the given name.
bool	contains (const QString &name) const
	Returns whether the group contains a parameter with the given name.
bool	contains (Parameter *parameter) const
	Returns whether the group contains the given parameter.
bool	contains (Parameter::Type parameterType) const
	Returns whether the group contains parameters of the given type.
bool	contains (Parameter::PinType pinType) const
	Returns whether the group contains parameters of the given pin type.
bool	contains (Parameter::PinType pinType, bool connected) const
	Returns whether the group contains parameters of the given pin type and of the given connection status.
bool	isEmpty () const
	Returns whether the group contains parameters or not.
void	addParameter (AbstractParameter *parameter, bool prepend=false)
	Adds the given parameter to the group of parameters.
Parameter *	getParameter (const QString &name) const
	Returns the parameter with the given name.
Parameter *	removeParameter (const QString &name)
	Removes and deletes the parameter with the given name from the parameter group.
Parameter *	removeParameter (Parameter *parameter)
	Removes and deletes the given parameter from the parameter group.
void	removeParameterGroup (const QString &name)
	Removes and deletes the given parameter group from the parameter group.
ParameterGroup *	getParameterGroup (const QString &name, bool recursive=true) const
	Returns the parameter group with the given name.
AbstractParameter::List *	getParameterList ()
	Returns a pointer to the list of parameters and parameter groups that are contained in this group.
AbstractParameter::Map *	getParameterMap ()
	Returns a pointer to the map of parameters and parameter groups that are contained in this group.
Private Attributes
AbstractParameter::List	m_parameterList
	The list of parameters or parameter groups contained in this group.
AbstractParameter::Map	m_parameterMap
	The map of parameters or parameter groups contained in this group.