FREE::PrecisionSOMetricController Class Reference
[Metric controller, Setup optimization metric]

Controller class for a precision metric. More...

#include <frePrecisionSOMetricController.h>

Inheritance diagram for FREE::PrecisionSOMetricController:

[legend]

Collaboration diagram for FREE::PrecisionSOMetricController:

[legend]

List of all members.

Public Types
typedef PrecisionSOMetric	ComponentType
typedef SetupOptimizationMetricControllerBase < ComponentType >	Superclass
Public Member Functions
	DeclareParameterMacro (SampleSize)
	itkTypeMacro (PrecisionSOMetricController, SetupOptimizationMetricControllerBase)
	PrecisionSOMetricController ()
Protected Member Functions
virtual void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const
virtual void	ActualizeMainComponent (ComponentType *pMainComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo, const unsigned int &iActLevel) const
void	SetStatisticEntryMainComponent (StatisticEntry &rStatisticEntry, ComponentType *pMainComponent, SessionComponentCache *pMainComponentCache, SessionInfo *pSessionInfo, StatisticDictionary &rDictionary) 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

---

Detailed Description

Controller class for a precision metric.

PrecisionSOMetricController is the class for the control of a metric, that is used as measure for the quality property precision.

Definition at line 41 of file frePrecisionSOMetricController.h.

---

Member Typedef Documentation

typedef PrecisionSOMetric FREE::PrecisionSOMetricController::ComponentType

The component class managed by the controller. The component class must be a derivation from itk::LightObject to ensure the ability to use the smartpointer concept of itk

Reimplemented from FREE::SetupOptimizationMetricControllerBase< TControlledMetric >.

Definition at line 46 of file frePrecisionSOMetricController.h.

typedef SetupOptimizationMetricControllerBase<ComponentType> FREE::PrecisionSOMetricController::Superclass

Reimplemented from FREE::SetupOptimizationMetricControllerBase< TControlledMetric >.

Definition at line 47 of file frePrecisionSOMetricController.h.

---

Constructor & Destructor Documentation

FREE::PrecisionSOMetricController::PrecisionSOMetricController

(

)

Implementation of FREE::PrecisionSOMetricController ///////

Definition at line 35 of file frePrecisionSOMetricController.cxx.

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

Here is the call graph for this function:

---

Member Function Documentation

FREE::PrecisionSOMetricController::DeclareParameterMacro

(

SampleSize

)

FREE::PrecisionSOMetricController::itkTypeMacro	(	PrecisionSOMetricController	,
		SetupOptimizationMetricControllerBase
	)

void FREE::PrecisionSOMetricController::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::SetupOptimizationMetricControllerBase< TControlledMetric >.

Definition at line 44 of file frePrecisionSOMetricController.cxx.

References FREE::CtrlProfile::ProfileOption::CheckForInheritance(), FREE::ComponentControllerBase< TControlledMetric >::GenerateProfile(), FREE::SessionComponentCache::GetIDPath(), FREE::SessionAccessor::GetParameterByIDPath(), FREE::CtrlProfile::ControllerProfileBase::Inheritance(), FREE::CtrlProfile::ControllerProfileBase::Parameters(), FREE::Parameter::PVTDouble, FREE::Parameter::PVTULong, FREE::CtrlProfile::ControllerProfile::Requirements(), and FREE::CtrlProfile::ControllerProfileBase::SubComponents().

Here is the call graph for this function:

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

Definition at line 95 of file frePrecisionSOMetricController.cxx.

References FREE::ComponentControllerBase< TControlledMetric >::ActualizeMainComponent(), FREE::ParameterCollection::GetParameterValue(), FREE::ComponentSetup::Parameters(), FREE::SessionComponentCache::Setup(), and throwExceptionMacro.

Here is the call graph for this function:

void FREE::PrecisionSOMetricController::SetStatisticEntryMainComponent	(	StatisticEntry &	rStatisticEntry,
		ComponentType *	pMainComponent,
		SessionComponentCache *	pMainComponentCache,
		SessionInfo *	pSessionInfo,
		StatisticDictionary &	rDictionary
	)			const [protected]

Definition at line 112 of file frePrecisionSOMetricController.cxx.

References FREE::StatisticEntry::AddValue(), FREE::StatisticDictionary::AddValueDefinition(), FREE::SessionComponentCache::GetIDPath(), FREE::StatisticValueDefinition::GetRefID(), FREE::StatisticDictionary::GetValueDefinitionByName(), and FREE::Convert::ToStr().

Here is the call graph for this function:

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

Definition at line 76 of file frePrecisionSOMetricController.cxx.

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

Definition at line 86 of file frePrecisionSOMetricController.cxx.

---

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

• frePrecisionSOMetricController.h
• frePrecisionSOMetricController.cxx

---