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

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

#include <freProfileSubComponents.h>

Inheritance diagram for FREE::CtrlProfile::ProfileSubComponents:

[legend]

Collaboration diagram for FREE::CtrlProfile::ProfileSubComponents:

[legend]

List of all members.

Public Types
typedef XMLKeyedCollectionBase < std::string, SubComponent, ProfileSubCompIdentifier > ::ElementsCountType	ElementsCountType
Public Member Functions
virtual const char *	GetNameOfClass () const
SubComponent *	AddSubComponent (const std::string &sComponentID, const unsigned int &iRequired=1, const std::string &sControllerID=csUndefinedController, const std::string &sDescription="")
bool	SubComponentExists (const std::string &sComponentID) const
	ProfileSubComponents ()
	ProfileSubComponents (const ProfileSubComponents &rSubComponents)
virtual	~ProfileSubComponents ()
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 subcomponent definitions of a profile.

Definition at line 44 of file freProfileSubComponents.h.

---

Member Typedef Documentation

typedef XMLKeyedCollectionBase<std::string, SubComponent, ProfileSubCompIdentifier>::ElementsCountType FREE::CtrlProfile::ProfileSubComponents::ElementsCountType

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

Definition at line 47 of file freProfileSubComponents.h.

---

Constructor & Destructor Documentation

FREE::CtrlProfile::ProfileSubComponents::ProfileSubComponents

(

)

Definition at line 62 of file freProfileSubComponents.cxx.

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

Here is the call graph for this function:

FREE::CtrlProfile::ProfileSubComponents::ProfileSubComponents

(

const ProfileSubComponents &

rSubComponents

)

Copy constructor

Definition at line 69 of file freProfileSubComponents.cxx.

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

Here is the call graph for this function:

FREE::CtrlProfile::ProfileSubComponents::~ProfileSubComponents

(

)

[virtual]

Definition at line 76 of file freProfileSubComponents.cxx.

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

Here is the call graph for this function:

---

Member Function Documentation

virtual const char* FREE::CtrlProfile::ProfileSubComponents::GetNameOfClass

(

)

const [inline, virtual]

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

Definition at line 49 of file freProfileSubComponents.h.

SubComponent * FREE::CtrlProfile::ProfileSubComponents::AddSubComponent	(	const std::string &	sComponentID,
		const unsigned int &	iRequired = 1,
		const std::string &	sControllerID = csUndefinedController,
		const std::string &	sDescription = ""
	)

Function adds a new component to the profile, if the component already exists (by its ID), it will pe replaced.

Parameters:

[in]	sComponentID	ID of the new component.
[in]	iRequired	Indicates of the Component is optional, so must not be defined, or needed in a semantic group of subcomponents (all or none).
[in]	sControllerID	ID of the default controller for this setup. Empty string indicates that there is no default controller.
[in]	sDescription	Description of subcomponent's use.

Returns:

Pointer to the newly added subcomponent profile

Implementation of FREE::CtrlProfile::ProfileSubComponents ///////////////////

Definition at line 36 of file freProfileSubComponents.cxx.

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

Here is the call graph for this function:

bool FREE::CtrlProfile::ProfileSubComponents::SubComponentExists

(

const std::string &

sComponentID

)

const

Returns if the subcomponent exists in the set of defined component subcomponents.

Parameters:

[in]

sComponentID

ID of the subcomponent, that shoud be checked for existance.

Definition at line 56 of file freProfileSubComponents.cxx.

References FREE::KeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::GetElementIndex().

Here is the call graph for this function:

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

Reimplemented from FREE::XMLStreamObject.

Definition at line 83 of file freProfileSubComponents.cxx.

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

Here is the call graph for this function:

---

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

• freProfileSubComponents.h
• freProfileSubComponents.cxx

---