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

Class providing the possibility to store and retrieve characteristics of subcomponents... More...

#include <freProfileSubComponent.h>

Inheritance diagram for FREE::CtrlProfile::SubComponent:

[legend]

Collaboration diagram for FREE::CtrlProfile::SubComponent:

[legend]

List of all members.

Public Types
typedef SubComponent	Self
typedef itk::LightObject	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	SetComponentID (const std::string &sComponentID)
std::string	GetComponentID () const
void	SetDescription (const std::string &sDescription)
std::string	GetDescription () const
void	SetIsRequired (unsigned int iRequired)
unsigned int	GetIsRequired () const
void	SetControllerID (const std::string &sControllerID)
std::string	GetControllerID () const
void	SetInternal (bool bInternal)
bool	GetInternal () const
void	SetIsTemplate (bool bTemplate)
bool	GetIsTemplate () const
virtual void	Reset ()
virtual SubComponent &	operator= (const SubComponent &rSubComponent)
Static Public Member Functions
static Pointer	New (void)
Protected Member Functions
	SubComponent ()
virtual	~SubComponent ()
virtual void	AttributesLoadProcessing (const AttributesType &rAttributes)
virtual void	SaveAttributes (AttributesSaveListType &rAttributes) const
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
std::string	m_sComponentID
std::string	m_sDescription
std::string	m_sControllerID
unsigned int	m_iRequired
bool	m_bInternal
bool	m_bTemplate
Private Member Functions
	SubComponent (const SubComponent &rSubComponent)

---

Detailed Description

Class providing the possibility to store and retrieve characteristics of subcomponents...

Parameter is used to store all characteristic information about a subcomponent within the component profile.

Definition at line 43 of file freProfileSubComponent.h.

---

Member Typedef Documentation

typedef SubComponent FREE::CtrlProfile::SubComponent::Self

Definition at line 46 of file freProfileSubComponent.h.

typedef itk::LightObject FREE::CtrlProfile::SubComponent::Superclass

Definition at line 47 of file freProfileSubComponent.h.

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

Definition at line 48 of file freProfileSubComponent.h.

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

Definition at line 49 of file freProfileSubComponent.h.

---

Constructor & Destructor Documentation

FREE::CtrlProfile::SubComponent::SubComponent

(

)

[protected]

Definition at line 51 of file freProfileSubComponent.cxx.

References Reset().

Here is the call graph for this function:

FREE::CtrlProfile::SubComponent::~SubComponent

(

)

[protected, virtual]

Definition at line 57 of file freProfileSubComponent.cxx.

FREE::CtrlProfile::SubComponent::SubComponent

(

const SubComponent &

rSubComponent

)

[private]

---

Member Function Documentation

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

(

)

const [inline, virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 51 of file freProfileSubComponent.h.

static Pointer FREE::CtrlProfile::SubComponent::New

(

void

)

[inline, static]

Definition at line 52 of file freProfileSubComponent.h.

Referenced by FREE::CtrlProfile::ProfileSubComponents::AddSubComponent(), FREE::ComponentControllerBase< TControlledComponent >::GenerateProfileTemplateRealization(), and FREE::CtrlProfile::ProfileSubComponents::SubElementLoadProcessing().

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

(

void

)

const [inline, virtual]

Definition at line 52 of file freProfileSubComponent.h.

void FREE::CtrlProfile::SubComponent::SetComponentID

(

const std::string &

sComponentID

)

[inline]

Definition at line 54 of file freProfileSubComponent.h.

References m_sComponentID.

std::string FREE::CtrlProfile::SubComponent::GetComponentID

(

)

const [inline]

Definition at line 55 of file freProfileSubComponent.h.

References m_sComponentID.

Referenced by FREE::SessionBuilder::CheckComponentNecessity(), FREE::CtrlProfile::ProfileSubCompIdentifier::KeyMatches(), operator=(), and FREE::CtrlProfile::ProfileOption::ProfileMatchesOption().

void FREE::CtrlProfile::SubComponent::SetDescription

(

const std::string &

sDescription

)

[inline]

Definition at line 57 of file freProfileSubComponent.h.

References m_sDescription.

std::string FREE::CtrlProfile::SubComponent::GetDescription

(

)

const [inline]

Definition at line 58 of file freProfileSubComponent.h.

References m_sDescription.

void FREE::CtrlProfile::SubComponent::SetIsRequired

(

unsigned int

iRequired

)

[inline]

Definition at line 60 of file freProfileSubComponent.h.

References m_iRequired.

unsigned int FREE::CtrlProfile::SubComponent::GetIsRequired

(

)

const [inline]

Definition at line 61 of file freProfileSubComponent.h.

References m_iRequired.

Referenced by FREE::SessionBuilder::CheckComponentNecessity(), and operator=().

void FREE::CtrlProfile::SubComponent::SetControllerID

(

const std::string &

sControllerID

)

[inline]

Definition at line 63 of file freProfileSubComponent.h.

References m_sControllerID.

std::string FREE::CtrlProfile::SubComponent::GetControllerID

(

)

const [inline]

Definition at line 64 of file freProfileSubComponent.h.

References m_sControllerID.

Referenced by operator=().

void FREE::CtrlProfile::SubComponent::SetInternal

(

bool

bInternal

)

[inline]

Definition at line 66 of file freProfileSubComponent.h.

References m_bInternal.

bool FREE::CtrlProfile::SubComponent::GetInternal

(

)

const [inline]

Definition at line 67 of file freProfileSubComponent.h.

References m_bInternal.

Referenced by operator=().

void FREE::CtrlProfile::SubComponent::SetIsTemplate

(

bool

bTemplate

)

[inline]

Definition at line 69 of file freProfileSubComponent.h.

References m_bTemplate.

Referenced by FREE::MediaDrainController::GenerateProfile().

bool FREE::CtrlProfile::SubComponent::GetIsTemplate

(

)

const [inline]

Definition at line 70 of file freProfileSubComponent.h.

References m_bTemplate.

Referenced by operator=().

void FREE::CtrlProfile::SubComponent::Reset

(

)

[virtual]

Resets the object to default/initial state

Reimplemented from FREE::XMLStreamObject.

Definition at line 63 of file freProfileSubComponent.cxx.

References FREE::csUndefinedController, m_bInternal, m_bTemplate, m_iRequired, m_sComponentID, m_sControllerID, and FREE::XMLStreamObject::Reset().

Referenced by SubComponent().

Here is the call graph for this function:

SubComponent & FREE::CtrlProfile::SubComponent::operator=

(

const SubComponent &

rSubComponent

)

[virtual]

Assignment operator.

Implementation of FREE::CtrlProfile::SubComponent ///////////////////////////

Definition at line 37 of file freProfileSubComponent.cxx.

References GetComponentID(), GetControllerID(), GetInternal(), GetIsRequired(), GetIsTemplate(), m_bInternal, m_bTemplate, m_iRequired, m_sComponentID, and m_sControllerID.

Here is the call graph for this function:

void FREE::CtrlProfile::SubComponent::AttributesLoadProcessing

(

const AttributesType &

rAttributes

)

[protected, virtual]

Definition at line 76 of file freProfileSubComponent.cxx.

References FREE::cXML_CP_SubCompCtrlID, FREE::cXML_CP_SubCompID, FREE::cXML_CP_SubCompInternal, FREE::cXML_CP_SubCompRequired, FREE::cXML_CP_Template, m_bInternal, m_bTemplate, m_iRequired, m_sComponentID, m_sControllerID, FREE::Convert::ToBool(), and FREE::Convert::ToInt().

Here is the call graph for this function:

void FREE::CtrlProfile::SubComponent::SaveAttributes

(

AttributesSaveListType &

rAttributes

)

const [protected, virtual]

Definition at line 90 of file freProfileSubComponent.cxx.

References FREE::cXML_CP_SubCompCtrlID, FREE::cXML_CP_SubCompID, FREE::cXML_CP_SubCompInternal, FREE::cXML_CP_SubCompRequired, FREE::cXML_CP_Template, m_bInternal, m_bTemplate, m_iRequired, m_sComponentID, m_sControllerID, and FREE::Convert::ToStr().

Here is the call graph for this function:

void FREE::CtrlProfile::SubComponent::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 freProfileSubComponent.cxx.

References FREE::cXML_CP_SubCompDescription, and m_sDescription.

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

Reimplemented from FREE::XMLStreamObject.

Definition at line 112 of file freProfileSubComponent.cxx.

References FREE::XMLStreamObject::AddSubElement(), FREE::cXML_CP_SubCompDescription, and m_sDescription.

Here is the call graph for this function:

---

Member Data Documentation

std::string FREE::CtrlProfile::SubComponent::m_sComponentID [protected]

ID of the subcomponent. The ID is used do identify a component in the subset of all subcomponents and to build up idpathes.

Definition at line 96 of file freProfileSubComponent.h.

Referenced by AttributesLoadProcessing(), GetComponentID(), operator=(), Reset(), SaveAttributes(), and SetComponentID().

std::string FREE::CtrlProfile::SubComponent::m_sDescription [protected]

Descripse the use of this subcomponent.

Definition at line 99 of file freProfileSubComponent.h.

Referenced by GetDescription(), SaveData(), SetDescription(), and SubElementLoadProcessing().

std::string FREE::CtrlProfile::SubComponent::m_sControllerID [protected]

ID of the controller that should handle the component by default. Empty string indicates that there is no default controller.

Definition at line 103 of file freProfileSubComponent.h.

Referenced by AttributesLoadProcessing(), GetControllerID(), operator=(), Reset(), SaveAttributes(), and SetControllerID().

unsigned int FREE::CtrlProfile::SubComponent::m_iRequired [protected]

Indicates if the subcomponent is optional. Optional (0) subcomponent must not be defined.
m_iRequired>1 indicates a semantic group where all or none subcomponent have to be selected. The default group is 1, so the group of all required subcomponents.

Definition at line 108 of file freProfileSubComponent.h.

Referenced by AttributesLoadProcessing(), GetIsRequired(), operator=(), Reset(), SaveAttributes(), and SetIsRequired().

bool FREE::CtrlProfile::SubComponent::m_bInternal [protected]

Indicates if the component is private, thus it should not be shown in interfaces that allow users to change the subcomponent (e.g. a setup editor). Normaly this kind of parameters have the access type "Get"..

Definition at line 113 of file freProfileSubComponent.h.

Referenced by AttributesLoadProcessing(), GetInternal(), operator=(), Reset(), SaveAttributes(), and SetInternal().

bool FREE::CtrlProfile::SubComponent::m_bTemplate [protected]

Indicates if the component profile is a template, thus it is allowed to have multiple subcomponent based on this specification.

Definition at line 117 of file freProfileSubComponent.h.

Referenced by AttributesLoadProcessing(), GetIsTemplate(), operator=(), Reset(), SaveAttributes(), and SetIsTemplate().

---

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

• freProfileSubComponent.h
• freProfileSubComponent.cxx

---