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

Class providing the possibility to store inheritance information of a component. More...

#include <freProfileInheritance.h>

Inheritance diagram for FREE::CtrlProfile::ProfileInheritance:

[legend]

Collaboration diagram for FREE::CtrlProfile::ProfileInheritance:

[legend]

List of all members.

Public Types
typedef XMLStringMultiMap::ElementIndexType	ElementIndexType
Public Member Functions
void	AddAncestor (const std::string &sControllerID)
bool	IsChildOf (const std::string &sControllerID) const
std::string	GetParent () const
std::string	GetAncestor (ElementIndexType index) const
	ProfileInheritance ()
	ProfileInheritance (const ProfileInheritance &rProfileInheritance)
virtual	~ProfileInheritance ()
virtual ProfileInheritance &	operator= (const ProfileInheritance &rProfileInheritance)
Protected Member Functions
ElementIndexType	IndexOfAncestor (const std::string &sComponentID) const

---

Detailed Description

Class providing the possibility to store inheritance information of a component.

Inheritance is used to store inheritance information of a component and e.g. use it for checking requirement definitions within profils.

Definition at line 40 of file freProfileInheritance.h.

---

Member Typedef Documentation

typedef XMLStringMultiMap::ElementIndexType FREE::CtrlProfile::ProfileInheritance::ElementIndexType

Reimplemented from FREE::XMLStringMultiMap.

Definition at line 43 of file freProfileInheritance.h.

---

Constructor & Destructor Documentation

FREE::CtrlProfile::ProfileInheritance::ProfileInheritance

(

)

[inline]

Definition at line 60 of file freProfileInheritance.h.

FREE::CtrlProfile::ProfileInheritance::ProfileInheritance

(

const ProfileInheritance &

rProfileInheritance

)

Definition at line 110 of file freProfileInheritance.cxx.

FREE::CtrlProfile::ProfileInheritance::~ProfileInheritance

(

)

[virtual]

Definition at line 81 of file freProfileInheritance.cxx.

---

Member Function Documentation

void FREE::CtrlProfile::ProfileInheritance::AddAncestor

(

const std::string &

sControllerID

)

Function adds a component ID to the inheritance information, if it isn't already inserted.

Parameters:

[in]

sControllerID

Controller ID of an ancestor.

Implementation of FREE::CtrlProfile::ProfileInheritance /////////////////////

Definition at line 36 of file freProfileInheritance.cxx.

References FREE::XMLStringMultiMap::AddElement(), FREE::cXML_CP_ControllerID, IndexOfAncestor(), and FREE::XMLStringMultiMap::SetElementData().

Referenced by FREE::ComponentControllerInterface::UpdateControllerID().

Here is the call graph for this function:

bool FREE::CtrlProfile::ProfileInheritance::IsChildOf

(

const std::string &

sControllerID

)

const

Returns if the passed component is an ancestor, so it is in the inheritance list.

Parameters:

[in]

sControllerID

ID of the controller ID which should be checked.

Definition at line 52 of file freProfileInheritance.cxx.

References IndexOfAncestor().

Referenced by FREE::CtrlProfile::ControllerProfileBase::IsRelatedTo(), FREE::ComponentControllerInterface::IsRelatedTo(), and FREE::CtrlProfile::ProfileOption::ProfileMatchesOption().

Here is the call graph for this function:

std::string FREE::CtrlProfile::ProfileInheritance::GetParent

(

)

const

Definition at line 61 of file freProfileInheritance.cxx.

References FREE::XMLStringMultiMap::GetElementData(), and FREE::XMLStringMultiMap::Size().

Here is the call graph for this function:

std::string FREE::CtrlProfile::ProfileInheritance::GetAncestor

(

ElementIndexType

index

)

const

Returns the ancestor specified by the passed index.

Parameters:

[in]

index

Index of the ancestor within the collection.

Returns:

Name of the ancestor. Returns an empty string if the index is invalid.

Definition at line 73 of file freProfileInheritance.cxx.

References FREE::XMLStringMultiMap::GetElementData().

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

Here is the call graph for this function:

ProfileInheritance & FREE::CtrlProfile::ProfileInheritance::operator=

(

const ProfileInheritance &

rProfileInheritance

)

[virtual]

Assignment operator.

Definition at line 99 of file freProfileInheritance.cxx.

References FREE::XMLStringMultiMap::operator=().

Here is the call graph for this function:

ProfileInheritance::ElementIndexType FREE::CtrlProfile::ProfileInheritance::IndexOfAncestor

(

const std::string &

sComponentID

)

const [protected]

Definition at line 86 of file freProfileInheritance.cxx.

References FREE::XMLStringMultiMap::GetElementData(), and FREE::XMLStringMultiMap::Size().

Referenced by AddAncestor(), and IsChildOf().

Here is the call graph for this function:

---

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

• freProfileInheritance.h
• freProfileInheritance.cxx

---