f.r.e.e. - Flexible Registration and Evaluation Engine: FREE::ComponentControllerInterface Class Reference

typedef itk::LightObject FREE::ComponentControllerInterface::GenericComponentType

Generic component type

Definition at line 54 of file freControllerInterface.h.

typedef GenericComponentType::Pointer FREE::ComponentControllerInterface::GenericComponentPointer

Generic smartpointer for the controller interface

Definition at line 56 of file freControllerInterface.h.

typedef ::FREE::GenericMediaType FREE::ComponentControllerInterface::GenericMediaType

Definition at line 58 of file freControllerInterface.h.

typedef GenericMediaType::Pointer FREE::ComponentControllerInterface::GenericMediaPointer

Definition at line 59 of file freControllerInterface.h.

typedef std::vector<IDPath> FREE::ComponentControllerInterface::AffectedElementListType

Definition at line 79 of file freControllerInterface.h.

FREE::ComponentControllerInterface::~ComponentControllerInterface ( ) [virtual]

Definition at line 43 of file freControllerInterface.cxx.

FREE::ComponentControllerInterface::ComponentControllerInterface ( ) [protected]

Constructor. The constructor is defined as protected, to prevent the direct use of the class ComponentControllerInterface.

Definition at line 48 of file freControllerInterface.cxx.

virtual const char* FREE::ComponentControllerInterface::GetNameOfClass ( ) const [inline, virtual]

Definition at line 61 of file freControllerInterface.h.

const std::string& FREE::ComponentControllerInterface::ControllerID ( ) const [inline]

Returns the unified identifier of the controller

Definition at line 64 of file freControllerInterface.h.

References m_ControllerID.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::BuildSetup(), FREE::ControllerInfo::ControllerInfo(), FREE::ComponentControllerBase< TControlledComponent >::GetComponent(), FREE::SessionComponentCache::GetControllerID(), FREE::ComponentControllerBase< TControlledComponent >::GetGenericComponent(), FREE::SetupManager::GetPossibleControllers(), FREE::ComponentControllerBase< TControlledComponent >::GetProfile(), FREE::ControllerCentral::RegisterController(), FREE::ComponentControllerBase< TControlledComponent >::ResetMainComponent(), FREE::BSplineDeformableTransformControllerBase< 3, 3 >::ResetMainComponent(), FREE::ComponentControllerBase< TControlledComponent >::SetComponent(), FREE::ComponentControllerBase< TControlledComponent >::SetGenericComponent(), and FREE::ControllerCentral::UnRegisterController().

const std::string& FREE::ComponentControllerInterface::Description ( ) const [inline]

Returns the description of the controller

Definition at line 66 of file freControllerInterface.h.

References m_Description.

const CtrlProfile::ProfileInheritance& FREE::ComponentControllerInterface::ProfileInheritance ( ) const [inline]

Returns the inheritance information of the controller

Definition at line 68 of file freControllerInterface.h.

References m_Inheritance.

bool FREE::ComponentControllerInterface::IsRelatedTo ( const std::string & sControllerID ) const

Returns wether the passed controller ID is an ancestor of current instance or itself.

Parameters:

[in] sControllerID ID of the component which should be checked.

Implementation of FREE::ComponentControllerInterface ///////////////

Definition at line 35 of file freControllerInterface.cxx.

References FREE::CtrlProfile::ProfileInheritance::IsChildOf(), m_ControllerID, and m_Inheritance.

Referenced by FREE::TransformFunctionAccessor< TTransformBase >::GetTransformControllerAndCache(), and FREE::GenericSetupToImageAdaptor::ValidateController().

Here is the call graph for this function:

virtual CtrlProfile::ControllerProfile::Pointer FREE::ComponentControllerInterface::GetProfile ( const SessionComponentCache * pComponentCache ) const [pure virtual]

Returns the controller profile. For more information:

See also:: ComponentControllerClass

Referenced by FREE::SessionBuilder::CheckComponentNecessity(), FREE::ComponentControllerBase< TControlledComponent >::GetMediaValidityTag(), FREE::ComponentControllerBase< TControlledComponent >::GetParameterValidityTag(), FREE::SetupTransform::GetParameterValueType(), and FREE::SetupInterpolator::InterpolateParameter().

virtual AffectedElementListType FREE::ComponentControllerInterface::GetAffectedProfileElements	(	const IDPath &	affectorID,
		SessionComponentCache *	pComponentCache,
		const ComponentSetup *	pNewAffectorSetup = `0`
	)			const `[pure virtual]`

Returns a list with all elements that may change because of a changing affector. For more information:

See also:: ComponentControllerClass

virtual bool FREE::ComponentControllerInterface::ControllerIsResponsible ( const GenericComponentType * pComponent ) const [pure virtual]

Returns if the controller is responsible for the passed component. For more information:

See also:: ComponentControllerClass

virtual void FREE::ComponentControllerInterface::InitializeSetup	(	ComponentSetup *	pComponentSetup,
		SessionComponentCache *	pComponentCache
	)			const `[pure virtual]`

Initialize the ComponentSetup for the component. For more information:

See also:: ComponentControllerClass

virtual SessionComponentCache::Pointer FREE::ComponentControllerInterface::BuildSetup	(	ComponentSetup *	pComponentSetup,
		SessionComponentCache *	pParentComponentCache
	)			const `[pure virtual]`

Uses the information of the ComponentSetup to establish an object needed. For more information:

See also:: ComponentControllerClass

Referenced by FREE::SessionBuilder::BuildComponent().

virtual const bool FREE::ComponentControllerInterface::CheckComponentActualizationNecessity ( const SessionComponentCache * pComponentCache ) const [pure virtual]

This function indicates, if the component is dynamic on multiple levels (at least one parameter). For more information:

See also:: ComponentControllerClass

Referenced by FREE::SessionBuilder::ActualizeComponent(), and FREE::ComponentControllerBase< TControlledComponent >::CheckCmpActNecessitySubCmp().

virtual void FREE::ComponentControllerInterface::ActualizeComponent	(	SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo,
		const unsigned int &	iActiveLayer = `0`
	)			const `[pure virtual]`

This function is used to actualize the component managed by the controller. For more information:

See also:: ComponentControllerClass

Referenced by FREE::SessionBuilder::ActualizeComponent(), and FREE::ComponentControllerBase< TControlledComponent >::ActualizeSubComponents().

virtual void FREE::ComponentControllerInterface::ResetComponent	(	SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo
	)			const `[pure virtual]`

This function resets the component and all sub components to a state equal to the new building of the component. For more information:

See also:: ComponentControllerClass

Referenced by FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::ResetSubComponents(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::ResetSubComponents(), and FREE::ComponentControllerBase< TControlledComponent >::ResetSubComponents().

virtual void FREE::ComponentControllerInterface::SetStatisticEntry	(	StatisticEntry &	rStatisticEntry,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo
	)			const `[pure virtual]`

This function is used to gather the statistical important imformation of the component. For more information:

See also:: ComponentControllerClass

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), and FREE::SessionBuilder::SetStatisticEntry().

virtual GenericComponentPointer FREE::ComponentControllerInterface::GetGenericComponent ( const SessionComponentCache * pComponentCache ) const [pure virtual]

Returns the component managed by the controller as generic component. For more information:

See also:: ComponentControllerClass

Referenced by FREE::SessionComponentCache::Component(), and FREE::MediaContainerController::GetSubComponentCasted().

virtual void FREE::ComponentControllerInterface::SetGenericComponent	(	GenericComponentType *	pGenericComponent,
		SessionComponentCache *	pComponentCache
	)			const `[pure virtual]`

Stores the passed generic component in the passed cache.
For more information:

See also:: ComponentControllerClass

Referenced by FREE::SessionComponentCache::SetComponent(), and FREE::MediaContainerController::SetSubComponentCasted().

virtual GenericComponentType* FREE::ComponentControllerInterface::GetSubComponent	(	SessionComponentCache *	pMainComponentCache,
		const ComponentID	compID
	)			const `[pure virtual]`

Returns the subcomponent specified by the ComponentID. For more information:

See also:: ComponentControllerClass

virtual void FREE::ComponentControllerInterface::SetSubComponent	(	SessionComponentCache *	pMainComponentCache,
		GenericComponentType *	pSubComponent,
		const ComponentID	compID
	)			const `[pure virtual]`

Sets a subcomponent specified by the ComponentID.
For more information:

See also:: ComponentControllerClass

virtual GenericMediaPointer FREE::ComponentControllerInterface::GetMedia	(	const MediaID &	mediaID,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo
	)			const `[pure virtual]`

Returns the media specified by the MediaID. For more information:

See also:: ComponentControllerClass

Referenced by FREE::SessionAccessor::GetMedia(), and FREE::MediaContainerController::GetMediaCasted().

virtual void FREE::ComponentControllerInterface::SetMedia	(	const MediaID &	mediaID,
		GenericMediaType *	pMedia,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo
	)			const `[pure virtual]`

Sets a media component specified by the MediaID.
For more information:

See also:: ComponentControllerClass

Referenced by FREE::SessionBuilder::LinkMediaToComponent(), FREE::SessionBuilder::LinkMediaToComponentByID(), FREE::SessionAccessor::SetMedia(), and FREE::MediaContainerController::SetMediaCasted().

virtual ValidityTag::Pointer FREE::ComponentControllerInterface::GetMediaValidityTag	(	const MediaID &	mediaID,
		SessionComponentCache *	pComponentCache
	)			const `[pure virtual]`

Retrieves the validity tag of the media specified by the mediaID. For more information:

See also:: ComponentControllerClass

Referenced by FREE::MediaContainerController::GetMediaValidityTag(), and FREE::SessionAccessor::GetValidityTag().

virtual ValidityTag::Pointer FREE::ComponentControllerInterface::GetMediaValidityTagRequirement	(	const MediaID &	mediaID,
		SessionComponentCache *	pComponentCache
	)			const `[pure virtual]`

Retrieves the validity tag requirement of the media specified by the mediaID. For more information:

See also:: ComponentControllerClass

Referenced by FREE::MediaContainerController::GetMediaValidityTagRequirement(), and FREE::SessionAccessor::GetValidityTagRequirement().

virtual std::string FREE::ComponentControllerInterface::GetMediaControllerID	(	const MediaID &	mediaID,
		SessionComponentCache *	pComponentCache
	)			const `[pure virtual]`

Retrieves the ID of the actual controller of the given media. For more information:

See also:: ComponentControllerClass

Referenced by FREE::SessionAccessor::GetMediaControllerID().

virtual Parameter::Pointer FREE::ComponentControllerInterface::GetParameter	(	const SessionComponentCache *	pComponentCache,
		const std::string &	sParameterName
	)			const `[pure virtual]`

Returns a smart pointer to the specified parameter which is provided by the component controller. For more information:

See also:: ComponentControllerClass

virtual std::string FREE::ComponentControllerInterface::GetParameterValue	(	const SessionComponentCache *	pComponentCache,
		const std::string &	sParameterName,
		const Parameter::ValueCountType	iItemPos = `0`,
		const Parameter::LayerCountType	iLayer = `0`
	)			const `[pure virtual]`

Returns the specified value of a parameter. For more information:

See also:: ComponentControllerClass

virtual void FREE::ComponentControllerInterface::SetParameterValue	(	SessionComponentCache *	pComponentCache,
		const std::string &	sParameterName,
		const std::string &	sValue,
		const Parameter::ValueCountType	iItemPos = `0`,
		const Parameter::LayerCountType	iLayer = `0`
	)			const `[pure virtual]`

Set the specified value of a parameter. For more information:

See also:: ComponentControllerClass

Referenced by FREE::SessionAccessor::SetParameterValueByIDPath().

virtual ValidityTag::Pointer FREE::ComponentControllerInterface::GetParameterValidityTag	(	const std::string &	sParameterName,
		SessionComponentCache *	pComponentCache
	)			const `[pure virtual]`

Retrieves the validity tag of the parameter specified by sParameterName. For more information:

See also:: ComponentControllerClass

Referenced by FREE::SessionAccessor::GetValidityTag().

virtual ValidityTag::Pointer FREE::ComponentControllerInterface::GetParameterValidityTagRequirement	(	const std::string &	sParameterName,
		SessionComponentCache *	pComponentCache
	)			const `[pure virtual]`

Retrieves the validity tag requirement of the parameter specified by sParameterName. For more information:

See also:: ComponentControllerClass

Referenced by FREE::SessionAccessor::GetValidityTagRequirement().

void FREE::ComponentControllerInterface::UpdateControllerID ( const std::string & sControllerID ) [protected]

Updates the controller ID and adds the old controller ID (if already set) to the inheritance of the controller.

Parameters:

sControllerID

The new controller id.

Definition at line 54 of file freControllerInterface.cxx.

References FREE::CtrlProfile::ProfileInheritance::AddAncestor(), m_ControllerID, and m_Inheritance.

Here is the call graph for this function:

std::string FREE::ComponentControllerInterface::m_ControllerID [protected]

The controller ID

Definition at line 211 of file freControllerInterface.h.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::ComponentControllerBase(), ControllerID(), FREE::ComponentControllerBase< TControlledComponent >::GetProfile(), IsRelatedTo(), and UpdateControllerID().

CtrlProfile::ProfileInheritance FREE::ComponentControllerInterface::m_Inheritance [protected]

Information about the inheritance of the controller

Definition at line 214 of file freControllerInterface.h.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::GetProfile(), IsRelatedTo(), ProfileInheritance(), and UpdateControllerID().

std::string FREE::ComponentControllerInterface::m_Description [protected]

Description of the controller

Definition at line 217 of file freControllerInterface.h.

FREE::ComponentControllerInterface Class Reference
[Basic controllers]

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation


Public Types
typedef itk::LightObject	GenericComponentType
typedef GenericComponentType::Pointer	GenericComponentPointer
typedef ::FREE::GenericMediaType	GenericMediaType
typedef GenericMediaType::Pointer	GenericMediaPointer
typedef std::vector < IDPath >	AffectedElementListType
Public Member Functions
virtual const char *	GetNameOfClass () const
const std::string &	ControllerID () const
const std::string &	Description () const
const CtrlProfile::ProfileInheritance &	ProfileInheritance () const
bool	IsRelatedTo (const std::string &sControllerID) const
virtual CtrlProfile::ControllerProfile::Pointer	GetProfile (const SessionComponentCache *pComponentCache) const =0
virtual AffectedElementListType	GetAffectedProfileElements (const IDPath &affectorID, SessionComponentCache pComponentCache, const ComponentSetup pNewAffectorSetup=0) const =0
virtual bool	ControllerIsResponsible (const GenericComponentType *pComponent) const =0
virtual void	InitializeSetup (ComponentSetup pComponentSetup, SessionComponentCache pComponentCache) const =0
virtual SessionComponentCache::Pointer	BuildSetup (ComponentSetup pComponentSetup, SessionComponentCache pParentComponentCache) const =0
virtual const bool	CheckComponentActualizationNecessity (const SessionComponentCache *pComponentCache) const =0
virtual void	ActualizeComponent (SessionComponentCache pComponentCache, SessionInfo pSessionInfo, const unsigned int &iActiveLayer=0) const =0
virtual void	ResetComponent (SessionComponentCache pComponentCache, SessionInfo pSessionInfo) const =0
virtual void	SetStatisticEntry (StatisticEntry &rStatisticEntry, SessionComponentCache pComponentCache, SessionInfo pSessionInfo) const =0
virtual GenericComponentPointer	GetGenericComponent (const SessionComponentCache *pComponentCache) const =0
virtual void	SetGenericComponent (GenericComponentType pGenericComponent, SessionComponentCache pComponentCache) const =0
virtual GenericComponentType *	GetSubComponent (SessionComponentCache *pMainComponentCache, const ComponentID compID) const =0
virtual void	SetSubComponent (SessionComponentCache pMainComponentCache, GenericComponentType pSubComponent, const ComponentID compID) const =0
virtual GenericMediaPointer	GetMedia (const MediaID &mediaID, SessionComponentCache pComponentCache, SessionInfo pSessionInfo) const =0
virtual void	SetMedia (const MediaID &mediaID, GenericMediaType pMedia, SessionComponentCache pComponentCache, SessionInfo *pSessionInfo) const =0
virtual ValidityTag::Pointer	GetMediaValidityTag (const MediaID &mediaID, SessionComponentCache *pComponentCache) const =0
virtual ValidityTag::Pointer	GetMediaValidityTagRequirement (const MediaID &mediaID, SessionComponentCache *pComponentCache) const =0
virtual std::string	GetMediaControllerID (const MediaID &mediaID, SessionComponentCache *pComponentCache) const =0
virtual Parameter::Pointer	GetParameter (const SessionComponentCache *pComponentCache, const std::string &sParameterName) const =0
virtual std::string	GetParameterValue (const SessionComponentCache *pComponentCache, const std::string &sParameterName, const Parameter::ValueCountType iItemPos=0, const Parameter::LayerCountType iLayer=0) const =0
virtual void	SetParameterValue (SessionComponentCache *pComponentCache, const std::string &sParameterName, const std::string &sValue, const Parameter::ValueCountType iItemPos=0, const Parameter::LayerCountType iLayer=0) const =0
virtual ValidityTag::Pointer	GetParameterValidityTag (const std::string &sParameterName, SessionComponentCache *pComponentCache) const =0
virtual ValidityTag::Pointer	GetParameterValidityTagRequirement (const std::string &sParameterName, SessionComponentCache *pComponentCache) const =0
virtual	~ComponentControllerInterface ()
Protected Member Functions
	ComponentControllerInterface ()
void	UpdateControllerID (const std::string &sControllerID)
Protected Attributes
std::string	m_ControllerID
CtrlProfile::ProfileInheritance	m_Inheritance
std::string	m_Description

FREE::ComponentControllerInterface Class Reference [Basic controllers]