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

Class providing the possibility to store and retrieve requirements of the profile. More...

#include <freProfileRequirements.h>

Inheritance diagram for FREE::CtrlProfile::ProfileRequirements:

[legend]

Collaboration diagram for FREE::CtrlProfile::ProfileRequirements:

[legend]

List of all members.

Public Types
typedef XMLCollectionBase < ProfileRequirement >	Superclass
typedef Superclass::ElementVectorType	RequirementVectorType
typedef Superclass::ElementsCountType	ElementsCountType
Public Member Functions
ProfileRequirement *	AddRequirement (const IDPath &destination, const IDPath &source=cIDPSelf)
RequirementVectorType	GetRequirementsBySource (const IDPath &source)
RequirementVectorType	GetRequirementsByDestination (const IDPath &destination)
void	DeleteRequirementsByDestination (const IDPath &destination)
void	DeleteRequirementsBySource (const IDPath &source)
	ProfileRequirements ()
	ProfileRequirements (const ProfileRequirements &rRequirements)
ProfileRequirements &	operator= (const ProfileRequirements &rRequirements)
virtual	~ProfileRequirements ()
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 requirements of the profile.

Definition at line 37 of file freProfileRequirements.h.

---

Member Typedef Documentation

typedef XMLCollectionBase<ProfileRequirement> FREE::CtrlProfile::ProfileRequirements::Superclass

Reimplemented from FREE::XMLCollectionBase< TXMLElement >.

Definition at line 40 of file freProfileRequirements.h.

typedef Superclass::ElementVectorType FREE::CtrlProfile::ProfileRequirements::RequirementVectorType

Definition at line 41 of file freProfileRequirements.h.

typedef Superclass::ElementsCountType FREE::CtrlProfile::ProfileRequirements::ElementsCountType

Reimplemented from FREE::XMLCollectionBase< TXMLElement >.

Definition at line 42 of file freProfileRequirements.h.

---

Constructor & Destructor Documentation

FREE::CtrlProfile::ProfileRequirements::ProfileRequirements

(

)

Definition at line 100 of file freProfileRequirements.cxx.

References FREE::cXML_CP_Requirements, FREE::XMLCollectionBase< TXMLElement >::Reset(), and FREE::XMLStreamObject::SetXMLTag().

Here is the call graph for this function:

FREE::CtrlProfile::ProfileRequirements::ProfileRequirements

(

const ProfileRequirements &

rRequirements

)

Copy constructor

Definition at line 107 of file freProfileRequirements.cxx.

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

Here is the call graph for this function:

FREE::CtrlProfile::ProfileRequirements::~ProfileRequirements

(

)

[virtual]

Definition at line 124 of file freProfileRequirements.cxx.

References FREE::XMLCollectionBase< TXMLElement >::Reset().

Here is the call graph for this function:

---

Member Function Documentation

ProfileRequirement * FREE::CtrlProfile::ProfileRequirements::AddRequirement	(	const IDPath &	destination,
		const IDPath &	source = cIDPSelf
	)

Adds a requirement to the collection.

Parameters:

[in]	destination	IDPath of the destination.
[in]	source	IDPath of the source; by default "self".

Returns:

Pointer to the new requirement definition.

Implementation of FREE::CtrlProfile::ProfileRequirements ////////////////////

Definition at line 37 of file freProfileRequirements.cxx.

References FREE::SmartCollectionBase< TXMLElement >::AddElement(), and FREE::CtrlProfile::ProfileRequirement::New().

Referenced by FREE::SetupManager::ActualizeConstraintCache().

Here is the call graph for this function:

ProfileRequirements::RequirementVectorType FREE::CtrlProfile::ProfileRequirements::GetRequirementsBySource

(

const IDPath &

source

)

Returns a vector with all pointers to requirements with the given source.

Remarks:

This pointers are no copy of the requirements. So it is a direct access to the data and the must not be deallocated.

Parameters:

[in]

source

IDPath of the source, the searched requirements should have.

Returns:

Vector with the pointer to the found requirements.

Definition at line 62 of file freProfileRequirements.cxx.

References FREE::CollectionBase< TXMLElement, itk::SmartPointer< TXMLElement > >::m_Elements.

ProfileRequirements::RequirementVectorType FREE::CtrlProfile::ProfileRequirements::GetRequirementsByDestination

(

const IDPath &

destination

)

Returns a vector with all pointers to requirements with the given destination.

Remarks:

This pointers are no copy of the requirements. So it is a direct access to the data and they must not be deallocated.

Parameters:

[in]

destination

IDPath of the destination, the searched requirements should have.

Returns:

Vector with the pointer to the found constraints.

Definition at line 49 of file freProfileRequirements.cxx.

References FREE::CollectionBase< TXMLElement, itk::SmartPointer< TXMLElement > >::m_Elements.

void FREE::CtrlProfile::ProfileRequirements::DeleteRequirementsByDestination

(

const IDPath &

destination

)

Deletes all requirements with the passed destination ID path.

Definition at line 75 of file freProfileRequirements.cxx.

References FREE::CollectionBase< TXMLElement, itk::SmartPointer< TXMLElement > >::m_Elements, and FREE::CollectionBase< TXMLElement, itk::SmartPointer< TXMLElement > >::Size().

Here is the call graph for this function:

void FREE::CtrlProfile::ProfileRequirements::DeleteRequirementsBySource

(

const IDPath &

source

)

Deletes all requirements with the passed destination ID path.

Definition at line 88 of file freProfileRequirements.cxx.

References FREE::CollectionBase< TXMLElement, itk::SmartPointer< TXMLElement > >::m_Elements, and FREE::CollectionBase< TXMLElement, itk::SmartPointer< TXMLElement > >::Size().

Here is the call graph for this function:

ProfileRequirements & FREE::CtrlProfile::ProfileRequirements::operator=

(

const ProfileRequirements &

rRequirements

)

Assignment operator.

Definition at line 115 of file freProfileRequirements.cxx.

References FREE::XMLStreamObject::LoadFromString(), and FREE::XMLStreamObject::SaveToString().

Here is the call graph for this function:

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

Reimplemented from FREE::XMLStreamObject.

Definition at line 131 of file freProfileRequirements.cxx.

References FREE::SmartCollectionBase< TXMLElement >::AddElement(), catchAllNPassMacro, FREE::cXML_CP_ProfileOption, FREE::XMLStreamObject::cXML_Text, FREE::XMLStreamObject::LoadFromString(), FREE::CtrlProfile::ProfileRequirement::New(), and throwExceptionMacro.

Here is the call graph for this function:

---

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

• freProfileRequirements.h
• freProfileRequirements.cxx

---