FREE::SetupOptimizationProcessorController Class Reference
[Processor controller, Setup optimization controller, Setup Optimization]

Derived class of a controller object for optimizers. More...

#include <freSetupOptimizationProcessorController.h>

Inheritance diagram for FREE::SetupOptimizationProcessorController:

[legend]

Collaboration diagram for FREE::SetupOptimizationProcessorController:

[legend]

List of all members.

Public Types
typedef ComponentControllerBase < SetupOptimizationProcessor >	Superclass
Public Member Functions
	itkTypeMacro (SetupOptimizationProcessorController, ComponentControllerBase)
	DeclareParameterMacro (Setup)
	DeclareParameterMacro (AdaptationList)
	SetupOptimizationProcessorController ()
Protected Member Functions
virtual void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const
virtual void	BuildFinalization (ComponentSetup *pComponentSetup, SessionComponentCache *pComponentCache) const
virtual void	ActualizeMainComponent (ComponentType *pMainComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo, const unsigned int &iActLevel) const
virtual GenericComponentType *	GetSubComponentCasted (ComponentType *pMainComponent, const ComponentID &compID, SessionComponentCache *pMainComponentCache) const
virtual void	SetSubComponentCasted (GenericComponentType *pSubComponent, ComponentType *pMainComponent, const ComponentID compID, SessionComponentCache *pMainComponentCache) const
virtual void	SetStatisticEntrySubComponents (StatisticEntry &rStatisticEntry, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo, StatisticDictionary &rDictionary) const

---

Detailed Description

Derived class of a controller object for optimizers.

Definition at line 38 of file freSetupOptimizationProcessorController.h.

---

Member Typedef Documentation

typedef ComponentControllerBase<SetupOptimizationProcessor> FREE::SetupOptimizationProcessorController::Superclass

Definition at line 41 of file freSetupOptimizationProcessorController.h.

---

Constructor & Destructor Documentation

FREE::SetupOptimizationProcessorController::SetupOptimizationProcessorController

(

)

Definition at line 41 of file freSetupOptimizationProcessorController.cxx.

References FREE::ComponentControllerInterface::m_Description, and FREE::ComponentControllerInterface::UpdateControllerID().

Here is the call graph for this function:

---

Member Function Documentation

FREE::SetupOptimizationProcessorController::itkTypeMacro	(	SetupOptimizationProcessorController	,
		ComponentControllerBase
	)

FREE::SetupOptimizationProcessorController::DeclareParameterMacro

(

Setup

)

FREE::SetupOptimizationProcessorController::DeclareParameterMacro

(

AdaptationList

)

void FREE::SetupOptimizationProcessorController::GenerateProfile	(	CtrlProfile::ControllerProfile &	profile,
		const SessionComponentCache *	pComponentCache,
		bool	bRegardOldSetup
	)			const [protected, virtual]

Adjusts the current profile according to the definitions of the controller.
Method should call the superclass variant to regard demands of basic controllers.

Parameters:

[in,out]	profile	Reference of the current profile.
[in]	pComponentCache	Pointer to the cache indicating the location of the component that should be profiled. This pointer can be null. In this case only a default profile that isn't context sensitive is wanted (others aren't possible anyway)
[in]	bRegardOldSetup	If true, the setup of pComponentCache is valid and should be regarded when the profile is generated. Otherwise just use defaults if setup information is needed.

Reimplemented from FREE::ComponentControllerBase< TControlledComponent >.

Definition at line 50 of file freSetupOptimizationProcessorController.cxx.

References FREE::cComp_MainMetric, FREE::cComp_MainOptimizer, FREE::cComp_MainTransform, FREE::CtrlProfile::ProfileOption::CheckForInheritance(), FREE::ComponentControllerBase< TControlledComponent >::GenerateProfile(), FREE::CtrlProfile::ControllerProfileBase::Inheritance(), FREE::CtrlProfile::ControllerProfileBase::Parameters(), FREE::Parameter::PVTURI, FREE::CtrlProfile::ControllerProfile::Requirements(), and FREE::CtrlProfile::ControllerProfileBase::SubComponents().

Here is the call graph for this function:

void FREE::SetupOptimizationProcessorController::BuildFinalization	(	ComponentSetup *	pComponentSetup,
		SessionComponentCache *	pComponentCache
	)			const [protected, virtual]

This function (called by BuildSetup()) does any finalization work needed after the main and all subcomponents have been build.
In a derived class this function should be overridden if any behavior has to be implemented.

Parameters:

[in]	pComponentSetup	The setup information for the component that should be build.
[in]	pComponentCache	Pointer to the component cache of the current component.

Here is the place (in derived classes) to insert code that should be executed after the main component and all specified subcomponents have been build. By default finalization does nothing.

Reimplemented from FREE::ComponentControllerBase< TControlledComponent >.

Definition at line 149 of file freSetupOptimizationProcessorController.cxx.

References FREE::SessionComponentCache::Component(), FREE::SessionComponentCache::ComponentIsAssigned(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

void FREE::SetupOptimizationProcessorController::ActualizeMainComponent	(	ComponentType *	pMainComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo,
		const unsigned int &	iActLevel
	)			const [protected, virtual]

Definition at line 106 of file freSetupOptimizationProcessorController.cxx.

References catchAllNPassMacro, FREE::SessionAccessor::GetParameterValue(), FREE::Adaptation::AdaptationList::New(), and FREE::Setup::New().

Here is the call graph for this function:

SetupOptimizationProcessorController::GenericComponentType * FREE::SetupOptimizationProcessorController::GetSubComponentCasted	(	ComponentType *	pMainComponent,
		const ComponentID &	compID,
		SessionComponentCache *	pMainComponentCache
	)			const [protected, virtual]

Definition at line 83 of file freSetupOptimizationProcessorController.cxx.

References FREE::cComp_MainMetric, FREE::cComp_MainOptimizer, and FREE::cComp_MainTransform.

void FREE::SetupOptimizationProcessorController::SetSubComponentCasted	(	GenericComponentType *	pSubComponent,
		ComponentType *	pMainComponent,
		const ComponentID	compID,
		SessionComponentCache *	pMainComponentCache
	)			const [protected, virtual]

Definition at line 95 of file freSetupOptimizationProcessorController.cxx.

References FREE::cComp_MainMetric, FREE::cComp_MainOptimizer, and FREE::cComp_MainTransform.

void FREE::SetupOptimizationProcessorController::SetStatisticEntrySubComponents	(	StatisticEntry &	rStatisticEntry,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo,
		StatisticDictionary &	rDictionary
	)			const [protected, virtual]

This function (called by SetStatisticEntry()) records any statistical information of all subcomponents In a derived class this function should be overridden to provide a specific behavior.

Parameters:

[in,out]	rStatisticEntry	reference to the Statistic object, where the relevant information should be stored.
[in]	pComponentCache	Pointer to the component cache.
[in]	pSessionInfo	Pointer to the session info
[in,out]	rDictionary	Dictionary with information about the stored facts (e.g. Type, Name) The entry in the dictionary should be set by the controller if needed.

Reimplemented from FREE::ComponentControllerBase< TControlledComponent >.

Definition at line 168 of file freSetupOptimizationProcessorController.cxx.

References FREE::StatisticDictionary::AddEntryDefinition(), catchAllNPassMacro, FREE::StatisticEntry::CreateChildEntry(), FREE::SessionComponentCache::GetComponentID(), FREE::SessionComponentCache::GetControllerID(), FREE::StatisticDictionary::GetEntryDefinitionByName(), FREE::SessionComponentCache::GetIDPath(), FREE::StatisticEntryDefinition::GetRefID(), FREE::StatisticEntryDefinition::SetRefID(), FREE::SessionBuilder::SetStatisticEntry(), FREE::SessionComponentCache::SubCaches(), throwCtrlExceptionMacro, and FREE::IDPath::ToStr().

Here is the call graph for this function:

---

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

• freSetupOptimizationProcessorController.h
• freSetupOptimizationProcessorController.cxx

---