FREE::CtrlProfile::ProfileParameters Class Reference
[Controller profile]

Class providing the possibility to store and retrieve parameter definitions of a profile. More...

#include <freProfileParameters.h>

Inheritance diagram for FREE::CtrlProfile::ProfileParameters:

[legend]

Collaboration diagram for FREE::CtrlProfile::ProfileParameters:

[legend]

List of all members.

Public Types
typedef XMLKeyedCollectionBase < std::string, Parameter, ProfileParameterIdentifier > ::ElementsCountType	ElementsCountType
Public Member Functions
Parameter *	AddParameter (const std::string &sParameterName, const Parameter::ParameterValueType &valueType, const std::string &sHint="", const unsigned int &iSize=1, const std::string &sDefaultValue="", const int &iLayerCount=1, const bool &bDynamic=false, const unsigned int &iGroup=1, const DataAccessType &accessType=DAAny)
bool	ParameterExists (const std::string &sParameterName) const
	ProfileParameters ()
	ProfileParameters (const ProfileParameters &rParameters)
virtual	~ProfileParameters ()
Protected Member Functions
virtual void	SubElementLoadProcessing (const std::string &rsXMLSubTag, const std::string &rsXMLSubElement, const std::string &rsXMLSubData)

---

Detailed Description

Class providing the possibility to store and retrieve parameter definitions of a profile.

Definition at line 44 of file freProfileParameters.h.

---

Member Typedef Documentation

typedef XMLKeyedCollectionBase<std::string, Parameter, ProfileParameterIdentifier>::ElementsCountType FREE::CtrlProfile::ProfileParameters::ElementsCountType

Reimplemented from FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >.

Definition at line 47 of file freProfileParameters.h.

---

Constructor & Destructor Documentation

FREE::CtrlProfile::ProfileParameters::ProfileParameters

(

)

Definition at line 85 of file freProfileParameters.cxx.

References FREE::cXML_CP_Parameters, FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::Reset(), and FREE::XMLStreamObject::SetXMLTag().

Here is the call graph for this function:

FREE::CtrlProfile::ProfileParameters::ProfileParameters

(

const ProfileParameters &

rParameters

)

Copy constructor

Definition at line 92 of file freProfileParameters.cxx.

References FREE::cXML_CP_Parameters, and FREE::XMLStreamObject::SetXMLTag().

Here is the call graph for this function:

FREE::CtrlProfile::ProfileParameters::~ProfileParameters

(

)

[virtual]

Definition at line 99 of file freProfileParameters.cxx.

References FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::Reset().

Here is the call graph for this function:

---

Member Function Documentation

Parameter * FREE::CtrlProfile::ProfileParameters::AddParameter	(	const std::string &	sParameterName,
		const Parameter::ParameterValueType &	valueType,
		const std::string &	sHint = "",
		const unsigned int &	iSize = 1,
		const std::string &	sDefaultValue = "",
		const int &	iLayerCount = 1,
		const bool &	bDynamic = false,
		const unsigned int &	iGroup = 1,
		const DataAccessType &	accessType = DAAny
	)

Function adds a new parameter to the setup, if parameter already exists, it will pe replaced.

Remarks:

For more information concernign the parameter attributes see parameter documentation.

Parameters:

[in]	sParameterName	Name of the new parameter.
[in]	valueType	Value type of the parameter (e.g. string, bool...)
[in]	sHint	Hint describing the nature/usage of the parameter.
[in]	iSize	Number of the values the parameter can store.
[in]	sDefaultValue	The default value of the parameter. If != "" and number of layers is fixed, it will be used to generate default layers filled with the value; the number of default layers is equal to LayerCount.
[in]	iLayerCount	Indicates the number of layers the parameter can have (-1 means any number).
[in]	bDynamic	Indicates if the parameter is dynamic over different resolution levels.
[in]	iGroup	Indicates if the parameter is within a semantic group (0: optional; 1: required; other: depends).
[in]	accessType	Type of access the parameter offers.

Returns:

Pointer to the added/changed parameter.

Implementation of FREE::CtrlProfile::ProfileParameters //////////////////////

Definition at line 36 of file freProfileParameters.cxx.

References FREE::SmartCollectionBase< TXMLElement >::AddElement(), FREE::KeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::GetElement(), and FREE::CtrlProfile::Parameter::New().

Here is the call graph for this function:

bool FREE::CtrlProfile::ProfileParameters::ParameterExists

(

const std::string &

sParameterName

)

const

Returns if the parameter exists in the set of defined component parameters.

Parameters:

[in]

sParameterName

Name of the parameter, that shoud be checked for existance.

Definition at line 79 of file freProfileParameters.cxx.

References FREE::KeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::GetElementIndex(), and FREE::CollectionBase< TXMLElement, itk::SmartPointer< TXMLElement > >::NULL_Index.

Referenced by FREE::CtrlProfile::ProfileOption::ProfileMatchesOption().

Here is the call graph for this function:

void FREE::CtrlProfile::ProfileParameters::SubElementLoadProcessing	(	const std::string &	rsXMLSubTag,
		const std::string &	rsXMLSubElement,
		const std::string &	rsXMLSubData
	)			[protected, virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 106 of file freProfileParameters.cxx.

References FREE::SmartCollectionBase< TXMLElement >::AddElement(), catchAllNPassMacro, FREE::cXML_CP_Parameter, FREE::XMLStreamObject::cXML_Text, FREE::CtrlProfile::Parameter::New(), and throwExceptionMacro.

Here is the call graph for this function:

---

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

• freProfileParameters.h
• freProfileParameters.cxx

---