FREE::ParameterCollection Class Reference
[Setup]

Class providing the possibility to store and retrieve parameters for a section or component setup. More...

#include <freParameterCollection.h>

Inheritance diagram for FREE::ParameterCollection:

[legend]

Collaboration diagram for FREE::ParameterCollection:

[legend]

List of all members.

Public Types
typedef Parameter::Pointer	ParameterPointer
typedef std::vector < ParameterPointer >	ParametersType
typedef ParameterLayer::ValueCountType	ValueCountType
typedef Parameter::LayerCountType	LayerCountType
typedef ParametersType::size_type	ParameterCountType
Public Member Functions
Parameter *	AddParameter (const std::string &sParameterName, const ValueCountType iLayerSize=1, const LayerCountType iLayerCount=1)
void	DeleteParameter (const std::string &sParameterName)
void	DeleteParameter (const ParameterCountType index)
void	AddParameterLayer (const std::string &sParameterName, bool bCopyValue=true)
void	DeleteParameterLayer (const std::string &sParameterName, const LayerCountType iLayer)
virtual void	ResetParameters ()
virtual void	Reset ()
bool	ParameterExists (const std::string &sParameterName) const
ParameterCountType	Size () const
ValueCountType	ParameterSize (const std::string &sParameterName) const
LayerCountType	ParameterLayerCount (const std::string &sParameterName) const
ParameterCountType	GetParameterIndex (const std::string &sParameterName) const
std::string	GetParameterName (const ParameterCountType &index) const
bool	GetParameterValue (const std::string &sParameterName, std::string &value, const ValueCountType iItemPos=0, const LayerCountType iLayer=0) const
bool	GetParameterValue (const std::string &sParameterName, double &value, const ValueCountType iItemPos=0, const LayerCountType iLayer=0) const
bool	GetParameterValue (const std::string &sParameterName, int &value, const ValueCountType iItemPos=0, const LayerCountType iLayer=0) const
bool	GetParameterValue (const std::string &sParameterName, long &value, const ValueCountType iItemPos=0, const LayerCountType iLayer=0) const
bool	GetParameterValue (const std::string &sParameterName, unsigned long &value, const ValueCountType iItemPos=0, const LayerCountType iLayer=0) const
bool	GetParameterValue (const std::string &sParameterName, bool &value, const ValueCountType iItemPos=0, const LayerCountType iLayer=0) const
bool	GetParameterValueByIDPath (const IDPath &parameterID, std::string &value) const
bool	GetParameterValueByIDPath (const IDPath &parameterID, bool &value) const
bool	GetParameterValueByIDPath (const IDPath &parameterID, double &value) const
bool	GetParameterValueByIDPath (const IDPath &parameterID, int &value) const
bool	GetParameterValueByIDPath (const IDPath &parameterID, long &value) const
bool	GetParameterValueByIDPath (const IDPath &parameterID, unsigned long &value) const
bool	GetParameterDataString (const std::string &sParameterName, std::string &sData) const
Parameter *	GetParameter (const std::string &sParameterName) const
Parameter *	GetParameter (ParameterCountType index) const
bool	SetParameterValue (const std::string &sParameterName, const bool value, const ValueCountType iItemPos=0, const LayerCountType iLayer=0)
bool	SetParameterValue (const std::string &sParameterName, const double value, const ValueCountType iItemPos=0, const LayerCountType iLayer=0)
bool	SetParameterValue (const std::string &sParameterName, const int value, const ValueCountType iItemPos=0, const LayerCountType iLayer=0)
bool	SetParameterValue (const std::string &sParameterName, const long value, const ValueCountType iItemPos=0, const LayerCountType iLayer=0)
bool	SetParameterValue (const std::string &sParameterName, const unsigned long value, const ValueCountType iItemPos=0, const LayerCountType iLayer=0)
bool	SetParameterValue (const std::string &sParameterName, const std::string &value, const ValueCountType iItemPos=0, const LayerCountType iLayer=0)
bool	SetParameterValueByIDPath (const IDPath &parameterID, std::string &value)
bool	SetParameterValueByIDPath (const IDPath &parameterID, bool &value)
bool	SetParameterValueByIDPath (const IDPath &parameterID, double &value)
bool	SetParameterValueByIDPath (const IDPath &parameterID, int &value)
bool	SetParameterValueByIDPath (const IDPath &parameterID, long &value)
bool	SetParameterValueByIDPath (const IDPath &parameterID, unsigned long &value)
virtual ParameterCollection &	operator= (const ParameterCollection &rParameterCollection)
	ParameterCollection ()
	ParameterCollection (const ParameterCollection &rParameterCollection)
virtual	~ParameterCollection ()
Protected Member Functions
virtual void	SubElementLoadProcessing (const std::string &rsXMLSubTag, const std::string &rsXMLSubElement, const std::string &rsXMLSubData)
virtual std::string	SaveData (const unsigned int &iDepth, bool &bHasSubElements) const
Protected Attributes
ParametersType	m_Parameters

---

Detailed Description

Class providing the possibility to store and retrieve parameters for a section or component setup.

ParametersCollection is the base class for containing all information stored as parameters with a set of different values.

Definition at line 38 of file freParameterCollection.h.

---

Member Typedef Documentation

typedef Parameter::Pointer FREE::ParameterCollection::ParameterPointer

Definition at line 41 of file freParameterCollection.h.

typedef std::vector<ParameterPointer> FREE::ParameterCollection::ParametersType

Definition at line 42 of file freParameterCollection.h.

typedef ParameterLayer::ValueCountType FREE::ParameterCollection::ValueCountType

Definition at line 44 of file freParameterCollection.h.

typedef Parameter::LayerCountType FREE::ParameterCollection::LayerCountType

Definition at line 45 of file freParameterCollection.h.

typedef ParametersType::size_type FREE::ParameterCollection::ParameterCountType

Definition at line 46 of file freParameterCollection.h.

---

Constructor & Destructor Documentation

FREE::ParameterCollection::ParameterCollection

(

)

Definition at line 447 of file freParameterCollection.cxx.

References Reset().

Here is the call graph for this function:

FREE::ParameterCollection::ParameterCollection

(

const ParameterCollection &

rParameterCollection

)

Copy constructor

Definition at line 453 of file freParameterCollection.cxx.

FREE::ParameterCollection::~ParameterCollection

(

)

[virtual]

Definition at line 459 of file freParameterCollection.cxx.

References Reset().

Here is the call graph for this function:

---

Member Function Documentation

Parameter * FREE::ParameterCollection::AddParameter	(	const std::string &	sParameterName,
		const ValueCountType	iLayerSize = 1,
		const LayerCountType	iLayerCount = 1
	)

Function adds a new parameter to the setup, if parameter already exists, the item count will be changed in all layers.

Parameters:

[in]	sParameterName	Name of the new parameter.
[in]	iLayerSize	The number of values mapped by the parameter name in one layer. Default is 1 value.
[in]	iLayerCount	The number of layers mapped by the parameter name. Default is 1 value.

Returns:

Pointer to the added parameter.

Implementation of FREE::ParameterCollection ////////////////////////

Definition at line 36 of file freParameterCollection.cxx.

References m_Parameters, and FREE::Parameter::New().

Referenced by FREE::TransformControllerBase< TControlledTransform, iDimension >::ActualizeMainComponent(), FREE::GenericSetupToImageAdaptor::ExtendComponent(), and FREE::ParameterListIO::SaveListToFile().

Here is the call graph for this function:

void FREE::ParameterCollection::DeleteParameter

(

const std::string &

sParameterName

)

Deletes the parameter and his values.

Parameters:

[in]

sParameterName

Name of the parameter, which should be deleted.

Definition at line 45 of file freParameterCollection.cxx.

References GetParameterIndex().

Referenced by ResetParameters().

Here is the call graph for this function:

void FREE::ParameterCollection::DeleteParameter

(

const ParameterCountType

index

)

Deletes the parameter and his values by the given index.

Parameters:

[in]

index

Index of the parameter within the collection. If index is out of range nothing happens.

Definition at line 56 of file freParameterCollection.cxx.

References m_Parameters.

void FREE::ParameterCollection::AddParameterLayer	(	const std::string &	sParameterName,
		bool	bCopyValue = true
	)

Function adds a layer of values to the parameter to be used in a following layer of registration. The layer will be appended at the end

Parameters:

[in]	sParameterName	Name of the parameter ,which should get a new layer.
[in]	bCopyValue	indicates if the items of the preceding parameter layer should be copied.

Definition at line 66 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Here is the call graph for this function:

void FREE::ParameterCollection::DeleteParameterLayer	(	const std::string &	sParameterName,
		const LayerCountType	iLayer
	)

Deletes the defined layer of value for the passed parameter.

Parameters:

[in]	sParameterName	Name of the parameter, whose layer should be deleted.
[in]	iLayer	indicates the layer.

Definition at line 77 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Here is the call graph for this function:

void FREE::ParameterCollection::ResetParameters

(

)

[virtual]

Deletes all parameters.

Definition at line 88 of file freParameterCollection.cxx.

References DeleteParameter(), and m_Parameters.

Referenced by Reset().

Here is the call graph for this function:

void FREE::ParameterCollection::Reset

(

)

[virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 99 of file freParameterCollection.cxx.

References FREE::XMLStreamObject::Reset(), and ResetParameters().

Referenced by operator=(), ParameterCollection(), FREE::ComponentSetup::ResetParameters(), and ~ParameterCollection().

Here is the call graph for this function:

bool FREE::ParameterCollection::ParameterExists

(

const std::string &

sParameterName

)

const

Returns if the parameter exists in the component setup.

Parameters:

[in]

sParameterName

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

Definition at line 107 of file freParameterCollection.cxx.

References GetParameterIndex().

Referenced by FREE::GenericSetupToImageAdaptor::AdaptComponent(), FREE::GenericSetupToImageAdaptor::ExtendComponent(), and FREE::SetupInterpolator::InterpolateParameter().

Here is the call graph for this function:

ParameterCollection::ParameterCountType FREE::ParameterCollection::Size

(

)

const

Returns the count of parameters.

Definition at line 114 of file freParameterCollection.cxx.

References m_Parameters.

Referenced by FREE::GenericSetupToImageAdaptor::AdaptComponent(), FREE::GenericSetupToImageAdaptor::ExtendComponent(), FREE::ComponentControllerBase< TControlledComponent >::GenerateProfileTemplateRealization(), GetParameter(), FREE::SetupInterpolator::InterpolateComponent(), FREE::ParameterListMediaController::LoadMedia(), operator=(), FREE::ComponentSetup::SaveData(), and FREE::ParameterListMediaController::SaveMedia().

ParameterCollection::ValueCountType FREE::ParameterCollection::ParameterSize

(

const std::string &

sParameterName

)

const

Returns the value count of the specified parameter.

Parameters:

[in]

sParameterName

Name of the parameter.

Returns:

Value count of the parameter. If parameter does not exist, the return is 0

Definition at line 121 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Referenced by FREE::SetupInterpolator::InterpolateParameter(), FREE::FEMRegistrationProcessor< VImageDimension >::SaveLandmarksToFile(), and FREE::TranslationTransformControllerBase< 3 >::SetInitialTransformValues().

Here is the call graph for this function:

ParameterCollection::LayerCountType FREE::ParameterCollection::ParameterLayerCount

(

const std::string &

sParameterName

)

const

Returns the count of layers of the specified parameter.

Parameters:

[in]

sParameterName

Name of the parameter.

Returns:

Layer count of the parameter. If parameter does not exist, the return is 0

Definition at line 131 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Referenced by FREE::SetupInterpolator::InterpolateParameter(), and FREE::FEMRegistrationProcessor< VImageDimension >::SaveLandmarksToFile().

Here is the call graph for this function:

ParameterCollection::ParameterCountType FREE::ParameterCollection::GetParameterIndex

(

const std::string &

sParameterName

)

const

Returns the index of a parameter.

Parameters:

[in]

sParameterName

Name of the wanted parameter.

Returns:

The index within the collection. If the parameter does not exist, the return is -1.

Definition at line 141 of file freParameterCollection.cxx.

References m_Parameters.

Referenced by AddParameterLayer(), DeleteParameter(), DeleteParameterLayer(), GetParameter(), GetParameterValue(), ParameterExists(), ParameterLayerCount(), ParameterSize(), and SetParameterValue().

std::string FREE::ParameterCollection::GetParameterName

(

const ParameterCountType &

index

)

const

Returns the name of the parameter specified by the index.

Parameters:

[in]

index

Index of the parameter.

Returns:

The name of the parameter. If index is out of range the return will be an empty string

Definition at line 154 of file freParameterCollection.cxx.

References m_Parameters.

Referenced by FREE::SetupInterpolator::InterpolateComponent().

bool FREE::ParameterCollection::GetParameterValue	(	const std::string &	sParameterName,
		std::string &	value,
		const ValueCountType	iItemPos = 0,
		const LayerCountType	iLayer = 0
	)			const

Returns a bool value of the given parameter. If at least one layer of values exists but the passed iLayer is out of bound, the last existing layer will be used.

Parameters:

[in]	sParameterName	Name of the parameter with the wanted value.
[out]	value	Wanted value of the parameter.
[in]	iItemPos	Indicates the position of the wanted value.
[in]	iLayer	Indicates the layer of the wanted value.

Returns:

Indicates if the value has a valid value. If the parameter does not exist or the iItemPos is out of range, the return is false and the value not valid.

Definition at line 208 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Referenced by FREE::PrecisionSOMetricController::ActualizeMainComponent(), FREE::CenteredRigid3DTransformController::ActualizeReferencesMainComponent(), FREE::ParameterListMediaController::BuildMainComponent(), FREE::MultiRigidRegistrationProcessor< VImageDimension >::ComputeRegistration(), FREE::DemonRegistrationProcessor< VImageDimension >::ComputeRegistration(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::GenerateProfile(), FREE::FEMRegistrationProcessor< VImageDimension >::GetMaxIterationCount(), FREE::StoreableMediaControllerBase< TMedia >::GetMediaFile(), GetParameterValueByIDPath(), FREE::SetupInterpolator::InterpolateParameter(), FREE::ParameterListMediaController::LoadMedia(), FREE::FEMRegistrationProcessor< VImageDimension >::SaveLandmarksToFile(), FREE::ParameterListMediaController::SaveMedia(), FREE::TranslationTransformControllerBase< 3 >::SetInitialTransformValues(), FREE::Rigid2DTransformController::SetInitialTransformValues(), FREE::Euler3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid2DTransformController::SetInitialTransformValues(), FREE::CenteredEuler3DTransformController::SetInitialTransformValues(), FREE::CenteredAffine3DTransformController::SetInitialTransformValues(), FREE::CenteredAffine2DTransformController::SetInitialTransformValues(), and FREE::FEMRegistrationProcessor< VImageDimension >::SetRegistrationParameters().

Here is the call graph for this function:

bool FREE::ParameterCollection::GetParameterValue	(	const std::string &	sParameterName,
		double &	value,
		const ValueCountType	iItemPos = 0,
		const LayerCountType	iLayer = 0
	)			const

Definition at line 172 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Here is the call graph for this function:

bool FREE::ParameterCollection::GetParameterValue	(	const std::string &	sParameterName,
		int &	value,
		const ValueCountType	iItemPos = 0,
		const LayerCountType	iLayer = 0
	)			const

Definition at line 181 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Here is the call graph for this function:

bool FREE::ParameterCollection::GetParameterValue	(	const std::string &	sParameterName,
		long &	value,
		const ValueCountType	iItemPos = 0,
		const LayerCountType	iLayer = 0
	)			const

Definition at line 190 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Here is the call graph for this function:

bool FREE::ParameterCollection::GetParameterValue	(	const std::string &	sParameterName,
		unsigned long &	value,
		const ValueCountType	iItemPos = 0,
		const LayerCountType	iLayer = 0
	)			const

Definition at line 199 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Here is the call graph for this function:

bool FREE::ParameterCollection::GetParameterValue	(	const std::string &	sParameterName,
		bool &	value,
		const ValueCountType	iItemPos = 0,
		const LayerCountType	iLayer = 0
	)			const

Definition at line 163 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Here is the call graph for this function:

bool FREE::ParameterCollection::GetParameterValueByIDPath	(	const IDPath &	parameterID,
		std::string &	value
	)			const

Uses an IDPath to address parameter, layer and value: ParameterName (e.g. ).

Definition at line 277 of file freParameterCollection.cxx.

References FREE::DispatchParameterIDPath(), and GetParameterValue().

Here is the call graph for this function:

bool FREE::ParameterCollection::GetParameterValueByIDPath	(	const IDPath &	parameterID,
		bool &	value
	)			const

Definition at line 217 of file freParameterCollection.cxx.

References FREE::DispatchParameterIDPath(), and GetParameterValue().

Here is the call graph for this function:

bool FREE::ParameterCollection::GetParameterValueByIDPath	(	const IDPath &	parameterID,
		double &	value
	)			const

Definition at line 229 of file freParameterCollection.cxx.

References FREE::DispatchParameterIDPath(), and GetParameterValue().

Here is the call graph for this function:

bool FREE::ParameterCollection::GetParameterValueByIDPath	(	const IDPath &	parameterID,
		int &	value
	)			const

Definition at line 241 of file freParameterCollection.cxx.

References FREE::DispatchParameterIDPath(), and GetParameterValue().

Here is the call graph for this function:

bool FREE::ParameterCollection::GetParameterValueByIDPath	(	const IDPath &	parameterID,
		long &	value
	)			const

Definition at line 253 of file freParameterCollection.cxx.

References FREE::DispatchParameterIDPath(), and GetParameterValue().

Here is the call graph for this function:

bool FREE::ParameterCollection::GetParameterValueByIDPath	(	const IDPath &	parameterID,
		unsigned long &	value
	)			const

Definition at line 265 of file freParameterCollection.cxx.

References FREE::DispatchParameterIDPath(), and GetParameterValue().

Here is the call graph for this function:

bool FREE::ParameterCollection::GetParameterDataString	(	const std::string &	sParameterName,
		std::string &	sData
	)			const

Gets all values and layers in a data string (similar to saving string in a setup file).

Parameters:

[in]	sParameterName	The parameter name to identify the source of the data.
[out]	sData	The data of the parameter (with all layers and value items).

Returns:

Indicates if the value has a valid value. If the parameter does not exist, the return is false and the value not valid.

Parameter * FREE::ParameterCollection::GetParameter

(

const std::string &

sParameterName

)

const

Returns a pointer to a parameter.

Parameters:

[in]

sParameterName

Name of the parameter with the wanted value.

Returns:

A pointer to the parameter. If the parameter does not exist, the return is NULL.

Definition at line 289 of file freParameterCollection.cxx.

References GetParameterIndex().

Referenced by FREE::TransformControllerBase< TControlledTransform, iDimension >::ActualizeMainComponent(), FREE::SetupOptimizationOptimizerControllerBase< TControlledOptimizer >::ActualizeMainComponent(), FREE::SetupOptimizationMetricControllerBase< TControlledMetric >::ActualizeMainComponent(), FREE::GenericSetupToImageAdaptor::AdaptComponent(), FREE::GenericSetupToImageAdaptor::ExtendComponent(), FREE::SetupTransformControllerBase< FREE::ConstrainedSetupTransform >::GenerateProfile(), FREE::OrientImageFilterControllerBase< FREE::ImageTypes< 3 >::InternalImageType, 3 >::GenerateProfile(), FREE::MutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::GenerateProfile(), FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::GenerateProfile(), FREE::ConstrainedSetupTransformController::GenerateProfile(), FREE::BSplineDeformableTransformControllerBase< 3, 3 >::GenerateProfile(), FREE::ComponentControllerBase< TControlledComponent >::GenerateProfileTemplateRealization(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::GetParameter(), FREE::ComponentControllerBase< TControlledComponent >::GetParameter(), FREE::ParameterListIO::LoadListFromFile(), FREE::PointSetMediaControllerBase< PixelType, 2 >::LoadMedia(), FREE::ParameterListMediaController::LoadMedia(), FREE::PointSetMediaControllerBase< PixelType, 2 >::LoadSetFromSetup(), operator=(), FREE::PointSetMediaControllerBase< PixelType, 2 >::SaveMedia(), FREE::ParameterListMediaController::SaveMedia(), FREE::PointSetMediaControllerBase< PixelType, 2 >::SaveSetToSetup(), and FREE::BSplineDeformableTransformControllerBase< 3, 3 >::SetInitialTransformValues().

Here is the call graph for this function:

Parameter * FREE::ParameterCollection::GetParameter

(

ParameterCountType

index

)

const

Returns a pointer to a parameter.

Parameters:

[in]

index

Index of the parameter with in the collection.

Returns:

A pointer to the parameter. If the index is out of range, the return is NULL.

Definition at line 296 of file freParameterCollection.cxx.

References m_Parameters, and Size().

Here is the call graph for this function:

bool FREE::ParameterCollection::SetParameterValue	(	const std::string &	sParameterName,
		const bool	value,
		const ValueCountType	iItemPos = 0,
		const LayerCountType	iLayer = 0
	)

Sets a bool value of the given parameter.

Parameters:

[in]	sParameterName	Name of the parameter with the wanted value.
[in]	value	New value of the parameter.
[in]	iItemPos	Indicates the position of the wanted value.
[in]	iLayer	Indicates the layer of the wanted value.

Returns:

Indicates if the value has a valid value. If the parameter does not exist or the iItemPos is out of range, then the return is false and the value not valid.

Definition at line 304 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Referenced by FREE::CenteredRigid3DTransformController::ActualizeReferencesMainComponent(), FREE::SetupInterpolator::InterpolateParameter(), FREE::VersorRigid3DTransformController::SetInitialTransformValues(), FREE::TranslationTransformControllerBase< 3 >::SetInitialTransformValues(), FREE::Similarity2DTransformController::SetInitialTransformValues(), FREE::ScaleTransformControllerBase< 3 >::SetInitialTransformValues(), FREE::Rigid2DTransformController::SetInitialTransformValues(), FREE::Euler3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid2DTransformController::SetInitialTransformValues(), FREE::CenteredEuler3DTransformController::SetInitialTransformValues(), FREE::CenteredAffine3DTransformController::SetInitialTransformValues(), FREE::CenteredAffine2DTransformController::SetInitialTransformValues(), FREE::StoreableMediaControllerBase< TMedia >::SetMediaFile(), and SetParameterValueByIDPath().

Here is the call graph for this function:

bool FREE::ParameterCollection::SetParameterValue	(	const std::string &	sParameterName,
		const double	value,
		const ValueCountType	iItemPos = 0,
		const LayerCountType	iLayer = 0
	)

Sets a double value of the given parameter.

Definition at line 313 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Here is the call graph for this function:

bool FREE::ParameterCollection::SetParameterValue	(	const std::string &	sParameterName,
		const int	value,
		const ValueCountType	iItemPos = 0,
		const LayerCountType	iLayer = 0
	)

Sets an integer value of the given parameter.

Definition at line 322 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Here is the call graph for this function:

bool FREE::ParameterCollection::SetParameterValue	(	const std::string &	sParameterName,
		const long	value,
		const ValueCountType	iItemPos = 0,
		const LayerCountType	iLayer = 0
	)

Sets a long value of the given parameter.

Definition at line 331 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Here is the call graph for this function:

bool FREE::ParameterCollection::SetParameterValue	(	const std::string &	sParameterName,
		const unsigned long	value,
		const ValueCountType	iItemPos = 0,
		const LayerCountType	iLayer = 0
	)

Sets a long value of the given parameter.

Definition at line 340 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Here is the call graph for this function:

bool FREE::ParameterCollection::SetParameterValue	(	const std::string &	sParameterName,
		const std::string &	value,
		const ValueCountType	iItemPos = 0,
		const LayerCountType	iLayer = 0
	)

Sets a string value of the given parameter.

Definition at line 349 of file freParameterCollection.cxx.

References GetParameterIndex(), and m_Parameters.

Here is the call graph for this function:

bool FREE::ParameterCollection::SetParameterValueByIDPath	(	const IDPath &	parameterID,
		std::string &	value
	)

Uses an IDPath to address parameter, layer and value: ParameterName (e.g. ).

Definition at line 418 of file freParameterCollection.cxx.

References FREE::DispatchParameterIDPath(), and SetParameterValue().

Here is the call graph for this function:

bool FREE::ParameterCollection::SetParameterValueByIDPath	(	const IDPath &	parameterID,
		bool &	value
	)

Definition at line 358 of file freParameterCollection.cxx.

References FREE::DispatchParameterIDPath(), and SetParameterValue().

Here is the call graph for this function:

bool FREE::ParameterCollection::SetParameterValueByIDPath	(	const IDPath &	parameterID,
		double &	value
	)

Definition at line 370 of file freParameterCollection.cxx.

References FREE::DispatchParameterIDPath(), and SetParameterValue().

Here is the call graph for this function:

bool FREE::ParameterCollection::SetParameterValueByIDPath	(	const IDPath &	parameterID,
		int &	value
	)

Definition at line 382 of file freParameterCollection.cxx.

References FREE::DispatchParameterIDPath(), and SetParameterValue().

Here is the call graph for this function:

bool FREE::ParameterCollection::SetParameterValueByIDPath	(	const IDPath &	parameterID,
		long &	value
	)

Definition at line 394 of file freParameterCollection.cxx.

References FREE::DispatchParameterIDPath(), and SetParameterValue().

Here is the call graph for this function:

bool FREE::ParameterCollection::SetParameterValueByIDPath	(	const IDPath &	parameterID,
		unsigned long &	value
	)

Definition at line 406 of file freParameterCollection.cxx.

References FREE::DispatchParameterIDPath(), and SetParameterValue().

Here is the call graph for this function:

ParameterCollection & FREE::ParameterCollection::operator=

(

const ParameterCollection &

rParameterCollection

)

[virtual]

Assignment operator.

Definition at line 430 of file freParameterCollection.cxx.

References GetParameter(), m_Parameters, FREE::Parameter::New(), Reset(), and Size().

Here is the call graph for this function:

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

Reimplemented from FREE::XMLStreamObject.

Definition at line 466 of file freParameterCollection.cxx.

References catchAllNPassMacro, FREE::cXML_Parameter, FREE::XMLStreamObject::cXML_Text, m_Parameters, FREE::Parameter::New(), and throwExceptionMacro.

Here is the call graph for this function:

std::string FREE::ParameterCollection::SaveData	(	const unsigned int &	iDepth,
		bool &	bHasSubElements
	)			const [protected, virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 485 of file freParameterCollection.cxx.

References FREE::XMLStreamObject::AddSubElement(), and m_Parameters.

Here is the call graph for this function:

---

Member Data Documentation

ParametersType FREE::ParameterCollection::m_Parameters [protected]

This variable is a Mapping of all parameters generally needed by the controller. The map is set by the controller and his InitializeSetup function.

Definition at line 243 of file freParameterCollection.h.

Referenced by AddParameter(), AddParameterLayer(), DeleteParameter(), DeleteParameterLayer(), GetParameter(), GetParameterIndex(), GetParameterName(), GetParameterValue(), operator=(), ParameterLayerCount(), ParameterSize(), ResetParameters(), SaveData(), SetParameterValue(), Size(), and SubElementLoadProcessing().

---

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

• freParameterCollection.h
• freParameterCollection.cxx

---