FREE::OptimizerOwnerControllerInterface Class Reference
[Basic controllers]

Interface class for a controller that manages an optimizer owner. More...

#include <freOptimizerOwnerControllerInterface.h>

Inheritance diagram for FREE::OptimizerOwnerControllerInterface:

[legend]

List of all members.

Public Member Functions
virtual const char *	GetNameOfClass () const
	DeclareParameterMacro (MinimizeToOptimize)
virtual bool	GetMinimizeToOptimize (const SessionComponentCache *pComponentCache) const =0

---

Detailed Description

Interface class for a controller that manages an optimizer owner.

OptimizerOwnerControllerInterface is an interface class that should be used as basis class for controllers that manages a component that have a component managed by OptimizerControlerBase (or derivatives) as subcomponent. The interface grants a possibility to query for the optimization direction via the method GetMinimizeToOptimize(). Also the parameter "MinimizeToOptimize" is defined a controller using this interface as a basis class should provide this parameter via GetParameter() and in their profile.

Definition at line 46 of file freOptimizerOwnerControllerInterface.h.

---

Member Function Documentation

virtual const char* FREE::OptimizerOwnerControllerInterface::GetNameOfClass

(

)

const [inline, virtual]

Reimplemented in FREE::MultiRigidRegistrationControllerBase< TControlledMultiRigidProcessor >, FREE::MultiRigid2DRegistrationController, FREE::MultiRigid3DRegistrationController, FREE::PointSet2DRegistrationController, FREE::PointSet3DRegistrationController, FREE::Rigid2DRegistrationController, FREE::Rigid3DRegistrationController, and FREE::MultiRigidRegistrationControllerBase< FREE::MultiRigidRegistrationProcessor >.

Definition at line 49 of file freOptimizerOwnerControllerInterface.h.

FREE::OptimizerOwnerControllerInterface::DeclareParameterMacro

(

MinimizeToOptimize

)

virtual bool FREE::OptimizerOwnerControllerInterface::GetMinimizeToOptimize

(

const SessionComponentCache *

pComponentCache

)

const [pure virtual]

Method indicates if an optimizer should maximize or minimize to fullfill the interests of the owner. This function is used by the controllers of optimizer subcomponents to set their managed component properly.

Parameters:

pComponentCache

Pointer to the component cache of the optimizer owner

Returns:

Indicates if an optimizer should minimize (true) or maximize (false) to (possibly) reach the optimum.

Implemented in FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >, FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >, FREE::PointSetRegistrationControllerBase< FREE::PointSetRegistrationProcessor< 2 > >, FREE::PointSetRegistrationControllerBase< FREE::PointSetRegistrationProcessor< 3 > >, FREE::RigidRegistrationControllerBase< TControlledMultiRigidProcessor >, FREE::RigidRegistrationControllerBase< FREE::RigidRegistrationProcessor >, and FREE::RigidRegistrationControllerBase< FREE::MultiRigidRegistrationProcessor< VImageDimension > >.

---

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

• freOptimizerOwnerControllerInterface.h

---