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

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

#include <freProfileRequirement.h>

Inheritance diagram for FREE::CtrlProfile::ProfileRequirement:

[legend]

Collaboration diagram for FREE::CtrlProfile::ProfileRequirement:

[legend]

List of all members.

Public Types
typedef ProfileRequirement	Self
typedef XMLCollectionBase < ProfileOption >	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef FREE::XMLCollectionBase < ProfileOption > ::ElementsCountType	ElementsCountType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
bool	GetIsNegated () const
void	SetIsNegated (const bool &Negated)
IDPath	GetDestination () const
void	SetDestination (const IDPath &destination)
IDPath	GetSource () const
void	SetSource (const IDPath &source)
ProfileOption *	AddProfileOption ()
void	ResetProfilOptions ()
bool	ProfileMatchesRequirement (const ControllerProfileBase &profile) const
ProfileRequirement &	operator= (const ProfileRequirement &rRequirement)
virtual void	Reset ()
Static Public Member Functions
static Pointer	New (void)
Protected Member Functions
	ProfileRequirement ()
virtual	~ProfileRequirement ()
virtual void	SubElementLoadProcessing (const std::string &rsXMLSubTag, const std::string &rsXMLSubElement, const std::string &rsXMLSubData)
virtual void	AttributesLoadProcessing (const AttributesType &rAttributes)
virtual void	SaveAttributes (AttributesSaveListType &rAttributes) const
Protected Attributes
bool	m_bNegated
IDPath	m_Destination
IDPath	m_Source
Private Member Functions
	ProfileRequirement (const ProfileRequirement &rRequirement)

---

Detailed Description

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

Definition at line 41 of file freProfileRequirement.h.

---

Member Typedef Documentation

typedef ProfileRequirement FREE::CtrlProfile::ProfileRequirement::Self

Definition at line 44 of file freProfileRequirement.h.

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

Reimplemented from FREE::XMLCollectionBase< TXMLElement >.

Definition at line 45 of file freProfileRequirement.h.

typedef itk::SmartPointer<Self> FREE::CtrlProfile::ProfileRequirement::Pointer

Definition at line 46 of file freProfileRequirement.h.

typedef itk::SmartPointer<const Self> FREE::CtrlProfile::ProfileRequirement::ConstPointer

Definition at line 47 of file freProfileRequirement.h.

typedef FREE::XMLCollectionBase<ProfileOption>::ElementsCountType FREE::CtrlProfile::ProfileRequirement::ElementsCountType

Reimplemented from FREE::XMLCollectionBase< TXMLElement >.

Definition at line 50 of file freProfileRequirement.h.

---

Constructor & Destructor Documentation

FREE::CtrlProfile::ProfileRequirement::ProfileRequirement

(

)

[protected]

Definition at line 68 of file freProfileRequirement.cxx.

References FREE::cXML_CP_Requirement, Reset(), and FREE::XMLStreamObject::SetXMLTag().

Here is the call graph for this function:

FREE::CtrlProfile::ProfileRequirement::~ProfileRequirement

(

)

[protected, virtual]

Definition at line 85 of file freProfileRequirement.cxx.

References Reset().

Here is the call graph for this function:

FREE::CtrlProfile::ProfileRequirement::ProfileRequirement

(

const ProfileRequirement &

rRequirement

)

[private]

suppresses default copy constructor

---

Member Function Documentation

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

(

)

const [inline, virtual]

Reimplemented from FREE::XMLCollectionBase< TXMLElement >.

Definition at line 49 of file freProfileRequirement.h.

static Pointer FREE::CtrlProfile::ProfileRequirement::New

(

void

)

[inline, static]

Definition at line 50 of file freProfileRequirement.h.

Referenced by FREE::CtrlProfile::ProfileRequirements::AddRequirement(), and FREE::CtrlProfile::ProfileRequirements::SubElementLoadProcessing().

virtual ::itk::LightObject::Pointer FREE::CtrlProfile::ProfileRequirement::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 50 of file freProfileRequirement.h.

bool FREE::CtrlProfile::ProfileRequirement::GetIsNegated

(

)

const [inline]

Definition at line 54 of file freProfileRequirement.h.

References m_bNegated.

void FREE::CtrlProfile::ProfileRequirement::SetIsNegated

(

const bool &

Negated

)

[inline]

Definition at line 55 of file freProfileRequirement.h.

References m_bNegated.

IDPath FREE::CtrlProfile::ProfileRequirement::GetDestination

(

)

const [inline]

Definition at line 57 of file freProfileRequirement.h.

References m_Destination.

void FREE::CtrlProfile::ProfileRequirement::SetDestination

(

const IDPath &

destination

)

[inline]

Definition at line 58 of file freProfileRequirement.h.

References m_Destination.

IDPath FREE::CtrlProfile::ProfileRequirement::GetSource

(

)

const [inline]

Definition at line 60 of file freProfileRequirement.h.

References m_Source.

void FREE::CtrlProfile::ProfileRequirement::SetSource

(

const IDPath &

source

)

[inline]

Definition at line 61 of file freProfileRequirement.h.

References m_Source.

ProfileOption * FREE::CtrlProfile::ProfileRequirement::AddProfileOption

(

)

Adds a profile option to the requirements and returns it.

Implementation of FREE::CtrlProfile::ProfileRequirement /////////////////////

Definition at line 37 of file freProfileRequirement.cxx.

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

Here is the call graph for this function:

void FREE::CtrlProfile::ProfileRequirement::ResetProfilOptions

(

)

Definition at line 46 of file freProfileRequirement.cxx.

Referenced by Reset().

bool FREE::CtrlProfile::ProfileRequirement::ProfileMatchesRequirement

(

const ControllerProfileBase &

profile

)

const

Function checks of the profile option matches the passed profile and returns the checking result.

Parameters:

profile

The profile that should be compared with the profile option (this).

Returns:

True if the passed profile matches the option, false if not.

Definition at line 53 of file freProfileRequirement.cxx.

References FREE::SmartCollectionBase< TXMLElement >::GetElement(), m_bNegated, FREE::CtrlProfile::ProfileOption::ProfileMatchesOption(), and FREE::CollectionBase< TXMLElement, itk::SmartPointer< TXMLElement > >::Size().

Here is the call graph for this function:

ProfileRequirement & FREE::CtrlProfile::ProfileRequirement::operator=

(

const ProfileRequirement &

rRequirement

)

Assignment operator.

Definition at line 76 of file freProfileRequirement.cxx.

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

Here is the call graph for this function:

void FREE::CtrlProfile::ProfileRequirement::Reset

(

)

[virtual]

Resets the sections array.

Reimplemented from FREE::XMLCollectionBase< TXMLElement >.

Definition at line 92 of file freProfileRequirement.cxx.

References FREE::cIDPSelf, m_bNegated, m_Destination, m_Source, and ResetProfilOptions().

Referenced by ProfileRequirement(), and ~ProfileRequirement().

Here is the call graph for this function:

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

Reimplemented from FREE::XMLStreamObject.

Definition at line 102 of file freProfileRequirement.cxx.

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

Here is the call graph for this function:

void FREE::CtrlProfile::ProfileRequirement::AttributesLoadProcessing

(

const AttributesType &

rAttributes

)

[protected, virtual]

Definition at line 121 of file freProfileRequirement.cxx.

References FREE::cXML_CP_RequDestination, FREE::cXML_CP_RequNegated, m_bNegated, m_Destination, and FREE::Convert::ToBool().

Here is the call graph for this function:

void FREE::CtrlProfile::ProfileRequirement::SaveAttributes

(

AttributesSaveListType &

rAttributes

)

const [protected, virtual]

Definition at line 132 of file freProfileRequirement.cxx.

References FREE::cXML_CP_RequDestination, FREE::cXML_CP_RequNegated, m_bNegated, and m_Destination.

---

Member Data Documentation

bool FREE::CtrlProfile::ProfileRequirement::m_bNegated [protected]

indicates of the check result of the requirement should be negated

Definition at line 94 of file freProfileRequirement.h.

Referenced by AttributesLoadProcessing(), GetIsNegated(), ProfileMatchesRequirement(), Reset(), SaveAttributes(), and SetIsNegated().

IDPath FREE::CtrlProfile::ProfileRequirement::m_Destination [protected]

IDPath to the component, which should be checked.

Definition at line 97 of file freProfileRequirement.h.

Referenced by AttributesLoadProcessing(), GetDestination(), Reset(), SaveAttributes(), and SetDestination().

IDPath FREE::CtrlProfile::ProfileRequirement::m_Source [protected]

IDPath to the component, which states the requirement. Neede for cache functionality, if not all requirements in on collection are from the same component. This is an information that won't be saved, its only purpose is as temporary cache information.

Definition at line 104 of file freProfileRequirement.h.

Referenced by GetSource(), Reset(), and SetSource().

---

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

• freProfileRequirement.h
• freProfileRequirement.cxx

---