FREE::SessionComponentCache

FREE::SessionComponentCache Class Reference
[Session]

Class that caches the particular information of a component needed for image processing. More...

#include <freSessionComponentCache.h>

Collaboration diagram for FREE::SessionComponentCache:

Collaboration graph
FREE::ComponentCacheCollection\< TCache \>FREE::KeyedCollectionBase\< std::string, TCache, FREE::ComponentCacheIdentifier\< TCache \> \>FREE::SmartCollectionBase\< TElement \>FREE::CollectionBase\< TElement, itk::SmartPointer\< TElement \> \>FREE::ComponentControllerInterfaceFREE::CtrlProfile::ProfileInheritanceFREE::XMLStringMultiMapFREE::XMLStreamObject
[legend]

List of all members.

Public Types

typedef
SessionComponentCache 		Self
typedef itk::LightObject Superclass
typedef
itk::SmartPointer
< Self > 		Pointer
typedef
itk::SmartPointer
< const Self > 		ConstPointer
typedef itk::LightObject GenericComponentType
typedef
itk::SmartPointer
< GenericComponentType > 		GenericComponentPointer
typedef
ComponentCacheCollection
< SessionComponentCache > 		ComponentCacheCollectionType
typedef std::map
< std::string,
GenericComponentPointer > 		CacheRepositoryType
typedef
ComponentCacheCollection
< SessionComponentCache > 		ComponentCacheCollectionType

Public Member Functions

virtual const char * GetNameOfClass () const
virtual
::itk::LightObject::Pointer 		CreateAnother (void) const
bool ControllerIsAssigned () const
bool SetupIsAssigned () const
std::string GetControllerID () const
const ComponentID & GetComponentID () const
bool ComponentIsAssigned () const
bool IsActive () const
bool IsPassiveCache () const
ComponentCacheCollectionType & SubCaches ()
const
ComponentCacheCollectionType & 		SubCaches () const
GenericComponentPointer Component () const
void SetComponent (GenericComponentType *pComponent)
ComponentSetup * Setup () const
const
GenericComponentController * 		Controller () const
bool HasParentCache () const
const
SessionComponentCache * 		GetParentCache () const
SessionComponentCache * GetParentCache ()
const
SessionComponentCache * 		GetRootCache () const
SessionComponentCache * GetRootCache ()
SessionComponentCache * GetCacheByIDPath (const IDPath &idPath)
const
SessionComponentCache * 		GetConstCacheByIDPath (const IDPath &idPath) const
IDPath GetIDPath () const
virtual
SessionComponentCache & 		operator= (const SessionComponentCache &rSessionComponentCache)

Static Public Member Functions

static Pointer New (void)
static Pointer New (SessionComponentCache *pParentCache, ComponentSetup *pSetup, const GenericComponentController *pController, GenericComponentType *pComponent, bool bIsPassive=false)

Protected Member Functions

 SessionComponentCache (SessionComponentCache *pParentCache, ComponentSetup *pSetup, const GenericComponentController *pController, GenericComponentType *pComponent, bool bIsPassive=false)
 SessionComponentCache ()
virtual ~SessionComponentCache ()

Protected Attributes

SessionComponentCache * m_pParent
ComponentSetup::Pointer m_smpComponentSetup
const
GenericComponentController * 		m_pComponentController
ComponentCacheCollectionType m_SubCaches
GenericComponentPointer m_smpComponent
CacheRepositoryType m_Repository
bool m_bPassive

Private Member Functions

 SessionComponentCache (const SessionComponentCache &rSessionComponentCache)

Friends

class DirectSessionComponentAccessor

Detailed Description

Class that caches the particular information of a component needed for image processing.

SessionComponentCache is used to cache the pointers to a component, the associated setup and the controller responsible for the component.
The component cache will be establish via the SessionBuilder when building the setup.

Definition at line 49 of file freSessionComponentCache.h.

Member Typedef Documentation

typedef SessionComponentCache FREE::SessionComponentCache::Self

Definition at line 52 of file freSessionComponentCache.h.

typedef itk::LightObject FREE::SessionComponentCache::Superclass

Definition at line 53 of file freSessionComponentCache.h.

typedef itk::SmartPointer<Self> FREE::SessionComponentCache::Pointer

Definition at line 54 of file freSessionComponentCache.h.

typedef itk::SmartPointer<const Self> FREE::SessionComponentCache::ConstPointer

Definition at line 55 of file freSessionComponentCache.h.

typedef itk::LightObject FREE::SessionComponentCache::GenericComponentType

Definition at line 57 of file freSessionComponentCache.h.

typedef itk::SmartPointer<GenericComponentType> FREE::SessionComponentCache::GenericComponentPointer

Definition at line 58 of file freSessionComponentCache.h.

typedef ComponentCacheCollection<SessionComponentCache> FREE::SessionComponentCache::ComponentCacheCollectionType

Definition at line 66 of file freSessionComponentCache.h.

typedef std::map<std::string, GenericComponentPointer> FREE::SessionComponentCache::CacheRepositoryType

Definition at line 81 of file freSessionComponentCache.h.

typedef ComponentCacheCollection<SessionComponentCache> FREE::SessionComponentCache::ComponentCacheCollectionType

Definition at line 83 of file freSessionComponentCache.h.

Constructor & Destructor Documentation

FREE::SessionComponentCache::SessionComponentCache ( SessionComponentCache *  pParentCache,
ComponentSetup *  pSetup,
const GenericComponentController *  pController,
GenericComponentType *  pComponent,
bool  bIsPassive = false 
) [protected]

This is a constructor for ComponentSetups within a setup structure.

Parameters:
[in] pParentCache Pointer to the component cache, the newly created component is a sub-item of.
[in] pSetup Pointer to the associated setup
[in] pController Pointer to the associated component controller.
[in] pComponent Pointer to component.
[in] bIsPassive Indicates if the cache is passive.

Definition at line 210 of file freSessionComponentCache.cxx.

References m_bPassive, m_pComponentController, m_pParent, m_smpComponent, and m_smpComponentSetup.

FREE::SessionComponentCache::SessionComponentCache (  )  [protected]

Definition at line 222 of file freSessionComponentCache.cxx.

References m_bPassive, m_pComponentController, m_pParent, m_smpComponent, and m_smpComponentSetup.

Referenced by New().

FREE::SessionComponentCache::~SessionComponentCache (  )  [protected, virtual]

Definition at line 262 of file freSessionComponentCache.cxx.

FREE::SessionComponentCache::SessionComponentCache ( const SessionComponentCache &  rSessionComponentCache  )  [private]

suppress default copy constructor

Member Function Documentation

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

Definition at line 60 of file freSessionComponentCache.h.

static Pointer FREE::SessionComponentCache::New ( void   )  [inline, static]

Definition at line 61 of file freSessionComponentCache.h.

Referenced by FREE::SessionBuilder::BuildComponent(), FREE::ComponentControllerBase< TControlledComponent >::BuildSetup(), FREE::SessionBuilder::GeneratePassiveComponentCache(), and FREE::SessionInfo::SetSetup().

virtual ::itk::LightObject::Pointer FREE::SessionComponentCache::CreateAnother ( void   )  const [inline, virtual]

Definition at line 61 of file freSessionComponentCache.h.

SessionComponentCache::Pointer FREE::SessionComponentCache::New ( SessionComponentCache *  pParentCache,
ComponentSetup *  pSetup,
const GenericComponentController *  pController,
GenericComponentType *  pComponent,
bool  bIsPassive = false 
) [static]

Definition at line 233 of file freSessionComponentCache.cxx.

References SessionComponentCache().

Here is the call graph for this function:

FREE::SessionComponentCache::SessionComponentCache

bool FREE::SessionComponentCache::ControllerIsAssigned (  )  const [inline]

Definition at line 68 of file freSessionComponentCache.h.

References m_pComponentController.

Referenced by FREE::SessionBuilder::ActualizeComponent(), FREE::ComponentControllerBase< TControlledComponent >::ActualizeSubComponents(), FREE::ComponentControllerBase< TControlledComponent >::CheckCmpActNecessitySubCmp(), FREE::SessionBuilder::CheckComponentNecessity(), Component(), FREE::SessionAccessor::GetMediaControllerID(), FREE::ComponentControllerBase< TControlledComponent >::GetMediaControllerID(), FREE::MediaContainerController::GetMediaValidityTag(), FREE::ComponentControllerBase< TControlledComponent >::GetMediaValidityTag(), FREE::MediaContainerController::GetMediaValidityTagRequirement(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetMinimizeToOptimize(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMinimizeToOptimize(), FREE::SessionAccessor::GetParameter(), FREE::ComponentControllerBase< TControlledComponent >::GetParameterValidityTag(), FREE::MediaContainerController::GetSubComponentCasted(), FREE::TransformFunctionAccessor< TTransformBase >::GetTransformControllerAndCache(), FREE::SessionAccessor::GetValidityTag(), FREE::SessionAccessor::GetValidityTagRequirement(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::ResetSubComponents(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::ResetSubComponents(), FREE::ComponentControllerBase< TControlledComponent >::ResetSubComponents(), SetComponent(), FREE::SessionAccessor::SetParameterValueByIDPath(), FREE::SessionBuilder::SetStatisticEntry(), and FREE::MediaContainerController::SetSubComponentCasted().

bool FREE::SessionComponentCache::SetupIsAssigned (  )  const [inline]

Definition at line 69 of file freSessionComponentCache.h.

References m_smpComponentSetup.

Referenced by FREE::SPSASOOptimizerController::ActualizeFinalization(), FREE::SPSAOptimizerController::ActualizeFinalization(), FREE::SessionBuilder::CheckComponentNecessity(), FREE::SPSASOOptimizerController::GetMaxIterationCount(), FREE::PowellSOOptimizerController::GetMaxIterationCount(), FREE::OptimizerControllerBase< TControlledOptimizer >::GetMaxIterationCount(), FREE::OnePlusOneEvolutionarySOOptimizerController::GetMaxIterationCount(), FREE::LimitedAxisAmoebaSOOptimizerController::GetMaxIterationCount(), FREE::ExhaustiveSOOptimizerController::GetMaxIterationCount(), FREE::EvolutionaryStrategySOOptimizerController::GetMaxIterationCount(), FREE::ConstrainedOnePlusOneEvolutionarySOOptimizerController::GetMaxIterationCount(), FREE::AmoebaSOOptimizerController::GetMaxIterationCount(), FREE::MediaContainerController::GetMediaControllerID(), FREE::ComponentControllerBase< TControlledComponent >::GetMediaControllerID(), FREE::StoreableMediaControllerBase< TMedia >::GetMediaFile(), FREE::ComponentControllerBase< TControlledComponent >::GetParameter(), FREE::ComponentControllerBase< TControlledComponent >::GetParameterValue(), FREE::ComponentControllerBase< TControlledComponent >::GetProfile(), FREE::SessionBuilder::LinkMediaToComponent(), FREE::SessionBuilder::LinkMediaToComponentByID(), FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >::LoadMedia(), FREE::PointSetMediaControllerBase< PixelType, 2 >::LoadMedia(), FREE::ParameterListMediaController::LoadMedia(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::LoadMedia(), FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >::SaveMedia(), FREE::PointSetMediaControllerBase< PixelType, 2 >::SaveMedia(), FREE::ParameterListMediaController::SaveMedia(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::SaveMedia(), FREE::VersorRigid3DTransformController::SetInitialTransformValues(), FREE::TranslationTransformControllerBase< 3 >::SetInitialTransformValues(), FREE::Similarity2DTransformController::SetInitialTransformValues(), FREE::Rigid2DTransformController::SetInitialTransformValues(), FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::SetInitialTransformValues(), FREE::Euler3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid2DTransformController::SetInitialTransformValues(), FREE::CenteredEuler3DTransformController::SetInitialTransformValues(), FREE::CenteredAffine3DTransformController::SetInitialTransformValues(), FREE::CenteredAffine2DTransformController::SetInitialTransformValues(), FREE::BSplineDeformableTransformControllerBase< 3, 3 >::SetInitialTransformValues(), FREE::StoreableMediaControllerBase< TMedia >::SetMediaFile(), FREE::ComponentControllerBase< TControlledComponent >::SetParameterValue(), and FREE::SessionBuilder::SetStatisticEntry().

std::string FREE::SessionComponentCache::GetControllerID (  )  const

Returns the ID of the assigned controller. If no controller is assigned, an exception will be raised.

Definition at line 95 of file freSessionComponentCache.cxx.

References Controller(), and FREE::ComponentControllerInterface::ControllerID().

Referenced by FREE::ComponentControllerBase< TControlledComponent >::AddStatisticEntry(), FREE::TransformFunctionAccessor< TTransformBase >::GetTransformControllerAndCache(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), FREE::EvolutionaryStrategySOOptimizerController::SetStatisticEntryMainComponent(), FREE::EvolutionaryStrategyOptimizerController::SetStatisticEntryMainComponent(), and FREE::SetupOptimizationProcessorController::SetStatisticEntrySubComponents().

Here is the call graph for this function:

FREE::SessionComponentCache::ControllerFREE::ComponentControllerInterface::ControllerID

const ComponentID & FREE::SessionComponentCache::GetComponentID (  )  const

Returns the ID of the assigned component. If no setup is assigned, an exception will be raised.

Definition at line 102 of file freSessionComponentCache.cxx.

References FREE::ComponentSetup::GetComponentID(), and Setup().

Referenced by FREE::SessionBuilder::ActualizeComponent(), FREE::ComponentControllerBase< TControlledComponent >::ActualizeSubComponents(), FREE::SessionBuilder::CheckComponentNecessity(), FREE::SessionBuilder::SetStatisticEntry(), FREE::StoreableMediaControllerBase< TMedia >::SetStatisticEntryMainComponent(), and FREE::SetupOptimizationProcessorController::SetStatisticEntrySubComponents().

Here is the call graph for this function:

FREE::ComponentSetup::GetComponentIDFREE::SessionComponentCache::Setup

bool FREE::SessionComponentCache::ComponentIsAssigned (  )  const [inline]

Definition at line 85 of file freSessionComponentCache.h.

References m_smpComponent.

Referenced by FREE::SetupOptimizationProcessorController::BuildFinalization(), FREE::ITKTransformControllerBase< TITKTransform, VDimension >::GenerateInverseTransformationFunction(), FREE::ITKTransformControllerBase< TITKTransform, VDimension >::GenerateTransformationFunction(), FREE::OptimizerControllerBase< TControlledOptimizer >::GetCurrentPosition(), FREE::OptimizerControllerBase< TControlledOptimizer >::GetCurrentValue(), FREE::ComponentControllerBase< TControlledComponent >::GetMedia(), FREE::MediaControllerBase< TMedia >::GetMediaCasted(), FREE::ComponentControllerBase< TControlledComponent >::GetSubComponent(), FREE::ParameterListMediaController::LoadMedia(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::ResetSubComponents(), FREE::PointSetMediaControllerBase< PixelType, 2 >::SaveMedia(), FREE::ParameterListMediaController::SaveMedia(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::SaveMedia(), FREE::ComponentControllerBase< TControlledComponent >::SetMedia(), FREE::SessionBuilder::SetStatisticEntry(), and FREE::ComponentControllerBase< TControlledComponent >::SetStatisticEntry().

bool FREE::SessionComponentCache::IsActive (  )  const

Checks if the cached component is actively used within the session, so a controller and a component have been defined. Non active component normally are non required components setups, with no controller/component specified.

Definition at line 63 of file freSessionComponentCache.cxx.

References m_pComponentController, and m_smpComponent.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::ActualizeComponent(), FREE::SessionAccessor::GetMedia(), FREE::ComponentControllerBase< TControlledComponent >::ResetComponent(), FREE::ComponentControllerBase< TControlledComponent >::ResetMainComponent(), FREE::BSplineDeformableTransformControllerBase< 3, 3 >::ResetMainComponent(), and FREE::SessionAccessor::SetMedia().

bool FREE::SessionComponentCache::IsPassiveCache (  )  const

Indicates that the cache was instanciates via SessionBuilder::BuildPassiveComponentCache() and therefor has no component. Any function that is about to check for the component should regard that state to determine, how it should handle the absence of a component.

Definition at line 70 of file freSessionComponentCache.cxx.

References m_bPassive.

ComponentCacheCollectionType& FREE::SessionComponentCache::SubCaches (  )  [inline]

Function to access the member variable m_Components.

Returns:
Reference to m_Components.

Definition at line 99 of file freSessionComponentCache.h.

References m_SubCaches.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::ActualizeSubComponents(), FREE::ComponentControllerBase< TControlledComponent >::BuildSubComponents(), FREE::ComponentControllerBase< TControlledComponent >::CheckCmpActNecessitySubCmp(), FREE::RigidRegistrationProcessorBase< TRegistrationMethod, TTransformBase, TInterpolateBase, TMetricBase, TOptimizerBase, VImageDimension >::GetMaxIterationCount(), FREE::PointSetRegistrationProcessor< VImageDimension >::GetMaxIterationCount(), FREE::MediaContainerController::GetMediaCasted(), FREE::MediaContainerController::GetMediaValidityTag(), FREE::MediaContainerController::GetMediaValidityTagRequirement(), FREE::MediaContainerController::GetSubComponentCasted(), FREE::SessionBuilder::LinkMediaToComponent(), operator=(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::ResetSubComponents(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::ResetSubComponents(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::ResetSubComponents(), FREE::ComponentControllerBase< TControlledComponent >::ResetSubComponents(), FREE::MediaDrainController::SetMediaCasted(), FREE::MediaContainerController::SetMediaCasted(), FREE::SetupOptimizationProcessorController::SetStatisticEntrySubComponents(), FREE::ComponentControllerBase< TControlledComponent >::SetStatisticEntrySubComponents(), and FREE::MediaContainerController::SetSubComponentCasted().

const ComponentCacheCollectionType& FREE::SessionComponentCache::SubCaches (  )  const [inline]

Definition at line 100 of file freSessionComponentCache.h.

References m_SubCaches.

SessionComponentCache::GenericComponentPointer FREE::SessionComponentCache::Component (  )  const

Function to returns smartpointer to cached component.

Returns:
Smartpointer to the cached component.
Implementation of FREE::SessionComponentCache //////////////////////

Definition at line 37 of file freSessionComponentCache.cxx.

References ControllerIsAssigned(), FREE::ComponentControllerInterface::GetGenericComponent(), m_pComponentController, and m_smpComponent.

Referenced by FREE::SetupOptimizationProcessorController::BuildFinalization(), FREE::ITKTransformControllerBase< TITKTransform, VDimension >::GenerateInverseTransformationFunction(), FREE::ITKTransformControllerBase< TITKTransform, VDimension >::GenerateTransformationFunction(), FREE::OptimizerControllerBase< TControlledOptimizer >::GetCurrentPosition(), FREE::OptimizerControllerBase< TControlledOptimizer >::GetCurrentValue(), FREE::MediaControllerBase< TMedia >::GetMediaCasted(), FREE::ParameterListMediaController::LoadMedia(), operator=(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::ResetSubComponents(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::ResetSubComponents(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::ResetSubComponents(), FREE::ParameterListMediaController::SaveMedia(), and FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetComponentCache().

Here is the call graph for this function:

FREE::SessionComponentCache::ControllerIsAssignedFREE::ComponentControllerInterface::GetGenericComponent

void FREE::SessionComponentCache::SetComponent ( GenericComponentType *  pComponent  ) 

Definition at line 51 of file freSessionComponentCache.cxx.

References ControllerIsAssigned(), m_pComponentController, m_smpComponent, and FREE::ComponentControllerInterface::SetGenericComponent().

Here is the call graph for this function:

FREE::SessionComponentCache::ControllerIsAssignedFREE::ComponentControllerInterface::SetGenericComponent

ComponentSetup * FREE::SessionComponentCache::Setup (  )  const

Function to access the member variable m_smpComponentSetup.

Returns:
Pointer to m_smpComponentSetup. If no Controller is assigned, an exception will be raised.

Definition at line 77 of file freSessionComponentCache.cxx.

References m_smpComponentSetup, and throwExceptionMacro.

Referenced by FREE::SPSASOOptimizerController::ActualizeFinalization(), FREE::SPSAOptimizerController::ActualizeFinalization(), FREE::TransformControllerBase< TControlledTransform, iDimension >::ActualizeMainComponent(), FREE::SetupOptimizationOptimizerControllerBase< TControlledOptimizer >::ActualizeMainComponent(), FREE::SetupOptimizationMetricControllerBase< TControlledMetric >::ActualizeMainComponent(), FREE::PrecisionSOMetricController::ActualizeMainComponent(), FREE::HistogramMetricControllerBase< TControlledCompareHistogramMetric >::ActualizeMainComponent(), FREE::ExhaustiveSOOptimizerController::ActualizeMainComponent(), FREE::ConjugateGradientOptimizerController::ActualizeMainComponent(), FREE::AmoebaOptimizerController::ActualizeMainComponent(), FREE::ParameterListMediaController::BuildMainComponent(), FREE::SessionBuilder::CheckComponentNecessity(), FREE::ProcessorControllerBase< TControlledProcessor >::CompareValidityTagRequirement(), FREE::SetupTransformControllerBase< FREE::ConstrainedSetupTransform >::GenerateProfile(), FREE::OrientImageFilterControllerBase< FREE::ImageTypes< 3 >::InternalImageType, 3 >::GenerateProfile(), FREE::MutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::GenerateProfile(), FREE::MediaDrainController::GenerateProfile(), FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::GenerateProfile(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::GenerateProfile(), FREE::ConstrainedSetupTransformController::GenerateProfile(), FREE::BSplineDeformableTransformControllerBase< 3, 3 >::GenerateProfile(), GetComponentID(), FREE::LightRegistrationProcessorBase::GetComponentSetup(), GetIDPath(), FREE::SessionAccessor::GetLinkedMedia(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::MediaBridgeController::GetMediaCasted(), FREE::MediaActualizerController::GetMediaCasted(), FREE::ClosedFormRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::MediaContainerController::GetMediaControllerID(), FREE::MediaBridgeController::GetMediaControllerID(), FREE::MediaActualizerController::GetMediaControllerID(), FREE::ComponentControllerBase< TControlledComponent >::GetMediaControllerID(), FREE::StoreableMediaControllerBase< TMedia >::GetMediaFile(), FREE::MediaBridgeController::GetMediaValidityTag(), FREE::MediaActualizerController::GetMediaValidityTag(), FREE::MediaBridgeController::GetMediaValidityTagRequirement(), FREE::MediaActualizerController::GetMediaValidityTagRequirement(), FREE::FEMRegistrationControllerBase< FREE::FEMRegistrationProcessor >::GetMediaValidityTagRequirement(), FREE::DemonRegistrationControllerBase< FREE::DemonRegistrationProcessor >::GetMediaValidityTagRequirement(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::GetParameter(), FREE::ComponentControllerBase< TControlledComponent >::GetParameter(), FREE::ComponentControllerBase< TControlledComponent >::GetProfile(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetValidityTagRequirement(), FREE::SessionBuilder::LinkMediaToComponent(), FREE::SessionBuilder::LinkMediaToComponentByID(), FREE::ParameterListIO::LoadListFromFile(), FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >::LoadMedia(), FREE::PointSetMediaControllerBase< PixelType, 2 >::LoadMedia(), FREE::ParameterListMediaController::LoadMedia(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::LoadMedia(), operator=(), FREE::ComponentControllerBase< TControlledComponent >::ResetMainComponent(), FREE::BSplineDeformableTransformControllerBase< 3, 3 >::ResetMainComponent(), FREE::MediaDrainController::SaveAllMedia(), FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >::SaveMedia(), FREE::PointSetMediaControllerBase< PixelType, 2 >::SaveMedia(), FREE::ParameterListMediaController::SaveMedia(), FREE::MediaDrainController::SaveMedia(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::SaveMedia(), FREE::VersorRigid3DTransformController::SetInitialTransformValues(), FREE::TranslationTransformControllerBase< 3 >::SetInitialTransformValues(), FREE::Similarity2DTransformController::SetInitialTransformValues(), FREE::ScaleTransformControllerBase< 3 >::SetInitialTransformValues(), FREE::Rigid2DTransformController::SetInitialTransformValues(), FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::SetInitialTransformValues(), FREE::Euler3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid2DTransformController::SetInitialTransformValues(), FREE::CenteredEuler3DTransformController::SetInitialTransformValues(), FREE::CenteredAffine3DTransformController::SetInitialTransformValues(), FREE::CenteredAffine2DTransformController::SetInitialTransformValues(), FREE::BSplineDeformableTransformControllerBase< 3, 3 >::SetInitialTransformValues(), FREE::MediaBridgeController::SetMediaCasted(), and FREE::StoreableMediaControllerBase< TMedia >::SetMediaFile().

const GenericComponentController * FREE::SessionComponentCache::Controller (  )  const

Function to access the member variable m_pComponentController.

Returns:
Pointer to m_pComponentController. If no Controller is assigned, an exception will be raised.

Definition at line 86 of file freSessionComponentCache.cxx.

References m_pComponentController, and throwExceptionMacro.

Referenced by FREE::SessionBuilder::ActualizeComponent(), FREE::VersorTransformOptimizerController::ActualizeMainComponent(), FREE::SPSAOptimizerController::ActualizeMainComponent(), FREE::RegStepGradDescOptimizerControllerBase< TOptimizer >::ActualizeMainComponent(), FREE::PowellOptimizerController::ActualizeMainComponent(), FREE::OnePlusOneEvolutionaryOptimizerController::ActualizeMainComponent(), FREE::LBFGSOptimizerController::ActualizeMainComponent(), FREE::GradientDescentOptimizerController::ActualizeMainComponent(), FREE::EvolutionaryStrategyOptimizerController::ActualizeMainComponent(), FREE::ContinuousLBFGSOptimizerController::ActualizeMainComponent(), FREE::ConjugateGradientOptimizerController::ActualizeMainComponent(), FREE::AmoebaOptimizerController::ActualizeMainComponent(), FREE::ComponentControllerBase< TControlledComponent >::ActualizeSubComponents(), FREE::ComponentControllerBase< TControlledComponent >::CheckCmpActNecessitySubCmp(), FREE::SessionBuilder::CheckComponentNecessity(), GetControllerID(), FREE::RigidRegistrationProcessorBase< TRegistrationMethod, TTransformBase, TInterpolateBase, TMetricBase, TOptimizerBase, VImageDimension >::GetMaxIterationCount(), FREE::PointSetRegistrationProcessor< VImageDimension >::GetMaxIterationCount(), FREE::SessionAccessor::GetMedia(), FREE::MediaContainerController::GetMediaCasted(), FREE::SessionAccessor::GetMediaControllerID(), FREE::MediaContainerController::GetMediaValidityTag(), FREE::ComponentControllerBase< TControlledComponent >::GetMediaValidityTag(), FREE::MediaContainerController::GetMediaValidityTagRequirement(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetMinimizeToOptimize(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMinimizeToOptimize(), FREE::SessionAccessor::GetParameter(), FREE::ComponentControllerBase< TControlledComponent >::GetParameterValidityTag(), FREE::MediaContainerController::GetSubComponentCasted(), FREE::TransformFunctionAccessor< TTransformBase >::GetTransformControllerAndCache(), FREE::SessionAccessor::GetValidityTag(), FREE::SessionAccessor::GetValidityTagRequirement(), FREE::SessionBuilder::LinkMediaToComponent(), FREE::SessionBuilder::LinkMediaToComponentByID(), FREE::RigidRegistrationProcessorBase< TRegistrationMethod, TTransformBase, TInterpolateBase, TMetricBase, TOptimizerBase, VImageDimension >::OnNewIteration(), FREE::PointSetRegistrationProcessor< VImageDimension >::OnNewIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), operator=(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::ResetSubComponents(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::ResetSubComponents(), FREE::ComponentControllerBase< TControlledComponent >::ResetSubComponents(), FREE::SessionAccessor::SetMedia(), FREE::MediaContainerController::SetMediaCasted(), FREE::SessionAccessor::SetParameterValueByIDPath(), FREE::SessionBuilder::SetStatisticEntry(), and FREE::MediaContainerController::SetSubComponentCasted().

bool FREE::SessionComponentCache::HasParentCache (  )  const

Returns true if the component has a parent component cache.

Definition at line 109 of file freSessionComponentCache.cxx.

References m_pParent.

const SessionComponentCache * FREE::SessionComponentCache::GetParentCache (  )  const

Returns a pointer to the parent component cache.

Returns:
If no parent has been specified, the return is NULL.

Definition at line 116 of file freSessionComponentCache.cxx.

References m_pParent.

Referenced by FREE::VersorTransformOptimizerController::ActualizeMainComponent(), FREE::SPSAOptimizerController::ActualizeMainComponent(), FREE::RegStepGradDescOptimizerControllerBase< TOptimizer >::ActualizeMainComponent(), FREE::PowellOptimizerController::ActualizeMainComponent(), FREE::OnePlusOneEvolutionaryOptimizerController::ActualizeMainComponent(), FREE::LBFGSOptimizerController::ActualizeMainComponent(), FREE::GradientDescentOptimizerController::ActualizeMainComponent(), FREE::EvolutionaryStrategyOptimizerController::ActualizeMainComponent(), FREE::ContinuousLBFGSOptimizerController::ActualizeMainComponent(), FREE::ConjugateGradientOptimizerController::ActualizeMainComponent(), FREE::AmoebaOptimizerController::ActualizeMainComponent(), FREE::SessionBuilder::CheckComponentNecessity(), and GetConstCacheByIDPath().

SessionComponentCache * FREE::SessionComponentCache::GetParentCache (  ) 

Definition at line 121 of file freSessionComponentCache.cxx.

References m_pParent.

const SessionComponentCache * FREE::SessionComponentCache::GetRootCache (  )  const

Returns a pointer to the first component cache without parent.

Remarks:
If no parent has been specified, the return is the this pointer, because an item is at least its own root. So there is never an item without a root.

Definition at line 126 of file freSessionComponentCache.cxx.

References GetRootCache(), and m_pParent.

Referenced by GetConstCacheByIDPath(), GetRootCache(), FREE::ProgressCtrlEventBase::IsLegalSender(), FREE::CallbackCtrlEventBase::IsLegalSender(), FREE::ProgressCtrlEventBase::SetACR(), and FREE::CallbackCtrlEventBase::SetACR().

Here is the call graph for this function:

SessionComponentCache * FREE::SessionComponentCache::GetRootCache (  ) 

Definition at line 134 of file freSessionComponentCache.cxx.

References GetRootCache(), and m_pParent.

Here is the call graph for this function:

FREE::SessionComponentCache::GetRootCache

SessionComponentCache * FREE::SessionComponentCache::GetCacheByIDPath ( const IDPath &  idPath  ) 

Retrieve a component cache via a given component ID path

Parameters:
[in] idPath The component ID path addressing the wanted component.
Returns:
Returns the pointer to the addressed component. If no component has been found under the specified path, the return is NULL

Definition at line 142 of file freSessionComponentCache.cxx.

References GetConstCacheByIDPath().

Referenced by FREE::RigidRegistrationProcessorBase< TRegistrationMethod, TTransformBase, TInterpolateBase, TMetricBase, TOptimizerBase, VImageDimension >::ComputeRegistration(), FREE::PointSetRegistrationProcessor< VImageDimension >::ComputeRegistration(), FREE::SessionAccessor::GetMediaControllerID(), FREE::TransformFunctionAccessor< TTransformBase >::GetTransformControllerAndCache(), FREE::SessionAccessor::GetValidityTag(), FREE::SessionAccessor::GetValidityTagRequirement(), and FREE::SessionAccessor::SetParameterValueByIDPath().

Here is the call graph for this function:

FREE::SessionComponentCache::GetConstCacheByIDPathFREE::KeyedCollectionBase::GetElementFREE::IDPath::GetFirstComponentFREE::SessionComponentCache::GetParentCacheFREE::SessionComponentCache::GetRootCacheFREE::IDPath::GetSubIDPathFREE::IDPath::SetAbsoluteFREE::IDPath::IsAbsoluteFREE::IDPath::IsEmptyFREE::IDPath::ToStrFREE::KeyedCollectionBase::GetElementIndexFREE::IDPath::GetComponentFREE::IDPath::SizeFREE::IDPath::AssembleIDPathFREE::IDPath::AddComponent

const SessionComponentCache * FREE::SessionComponentCache::GetConstCacheByIDPath ( const IDPath &  idPath  )  const

Constant variant of GetCacheByIDPath()

Definition at line 156 of file freSessionComponentCache.cxx.

References GetConstCacheByIDPath(), FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElement(), FREE::IDPath::GetFirstComponent(), GetParentCache(), GetRootCache(), FREE::IDPath::GetSubIDPath(), FREE::IDPath::IsAbsolute(), FREE::IDPath::IsEmpty(), m_SubCaches, FREE::IDPath::PTAnyChild, FREE::IDPath::PTAnyDescendant, FREE::IDPath::PTComponent, FREE::IDPath::PTNULL, FREE::IDPath::PTParent, FREE::IDPath::SetAbsolute(), throwExceptionMacro, and FREE::IDPath::ToStr().

Referenced by GetCacheByIDPath(), GetConstCacheByIDPath(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetMinimizeToOptimize(), and FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMinimizeToOptimize().

Here is the call graph for this function:

FREE::KeyedCollectionBase::GetElementFREE::IDPath::GetFirstComponentFREE::SessionComponentCache::GetParentCacheFREE::SessionComponentCache::GetRootCacheFREE::IDPath::GetSubIDPathFREE::IDPath::SetAbsoluteFREE::IDPath::IsAbsoluteFREE::IDPath::IsEmptyFREE::IDPath::ToStrFREE::KeyedCollectionBase::GetElementIndexFREE::IDPath::GetComponentFREE::IDPath::SizeFREE::IDPath::AssembleIDPathFREE::IDPath::AddComponent

IDPath FREE::SessionComponentCache::GetIDPath (  )  const

Returns the complete component ID path of the cached setup component. If no setup is cached, it will raise an exception.

Definition at line 199 of file freSessionComponentCache.cxx.

References catchAllNPassMacro, FREE::ComponentSetup::GetIDPath(), and Setup().

Referenced by FREE::WarpImageFilterControllerBase< FREE::ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::TransformationFieldType >::ActualizeMainComponent(), FREE::ResampleImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::ComponentControllerBase< TControlledComponent >::AddStatisticEntry(), FREE::ITKTransformControllerBase< TITKTransform, VDimension >::GenerateInverseTransformationFunction(), FREE::PrecisionSOMetricController::GenerateProfile(), FREE::ITKTransformControllerBase< TITKTransform, VDimension >::GenerateTransformationFunction(), FREE::SessionAccessor::GetLinkedMedia(), FREE::ComponentControllerBase< TControlledComponent >::GetMediaCasted(), FREE::SessionAccessor::GetParameterValue(), FREE::SessionAccessor::GetParameterValueByIDPath(), FREE::SessionBuilder::LinkMediaToComponent(), FREE::SessionBuilder::LinkMediaToComponentByID(), FREE::ComponentControllerBase< TControlledComponent >::MakeCallback(), FREE::ComponentControllerBase< TControlledComponent >::NotifyProgress(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnRegistrationProgressEvent(), FREE::PointSetMediaControllerBase< PixelType, 2 >::SaveMedia(), FREE::MediaDrainController::SaveMedia(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetComponentCache(), FREE::ComponentControllerBase< TControlledComponent >::SetMediaCasted(), FREE::VersorTransformOptimizerController::SetStatisticEntryMainComponent(), FREE::SVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::SetStatisticEntryMainComponent(), FREE::StoreableMediaControllerBase< TMedia >::SetStatisticEntryMainComponent(), FREE::SPSASOOptimizerController::SetStatisticEntryMainComponent(), FREE::SPSAOptimizerController::SetStatisticEntryMainComponent(), FREE::RegStepGradDescOptimizerControllerBase< TOptimizer >::SetStatisticEntryMainComponent(), FREE::PrecisionSOMetricController::SetStatisticEntryMainComponent(), FREE::PowellSOOptimizerController::SetStatisticEntryMainComponent(), FREE::PowellOptimizerController::SetStatisticEntryMainComponent(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::SetStatisticEntryMainComponent(), FREE::OptimizerControllerBase< TControlledOptimizer >::SetStatisticEntryMainComponent(), FREE::OnePlusOneEvolutionarySOOptimizerController::SetStatisticEntryMainComponent(), FREE::OnePlusOneEvolutionaryOptimizerController::SetStatisticEntryMainComponent(), FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::SetStatisticEntryMainComponent(), FREE::LimitedAxisAmoebaSOOptimizerController::SetStatisticEntryMainComponent(), FREE::LBFGSOptimizerController::SetStatisticEntryMainComponent(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::SetStatisticEntryMainComponent(), FREE::ImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::GradientDescentOptimizerController::SetStatisticEntryMainComponent(), FREE::FEMRegistrationControllerBase< FREE::FEMRegistrationProcessor >::SetStatisticEntryMainComponent(), FREE::ExhaustiveSOOptimizerController::SetStatisticEntryMainComponent(), FREE::ExhaustiveOptimizerController::SetStatisticEntryMainComponent(), FREE::EvolutionaryStrategySOOptimizerController::SetStatisticEntryMainComponent(), FREE::EvolutionaryStrategyOptimizerController::SetStatisticEntryMainComponent(), FREE::ESCMAMutationController::SetStatisticEntryMainComponent(), FREE::ContinuousLBFGSOptimizerController::SetStatisticEntryMainComponent(), FREE::ConstrainedOnePlusOneEvolutionarySOOptimizerController::SetStatisticEntryMainComponent(), FREE::ConstrainedImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConstrainedImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConstrainedAccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::SetStatisticEntryMainComponent(), FREE::ConsistencySOMetricControllerBase< FREE::ConsistencyRegistrationMetric< 2 > >::SetStatisticEntryMainComponent(), FREE::ConjugateGradientOptimizerController::SetStatisticEntryMainComponent(), FREE::AmoebaSOOptimizerController::SetStatisticEntryMainComponent(), FREE::AmoebaOptimizerController::SetStatisticEntryMainComponent(), FREE::AccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::SetStatisticEntryMainComponent(), and FREE::SetupOptimizationProcessorController::SetStatisticEntrySubComponents().

Here is the call graph for this function:

FREE::ComponentSetup::GetIDPathFREE::SessionComponentCache::SetupFREE::ComponentSetup::HasParentComponent

SessionComponentCache & FREE::SessionComponentCache::operator= ( const SessionComponentCache &  rSessionComponentCache  )  [virtual]

Assignment operator.

Definition at line 249 of file freSessionComponentCache.cxx.

References Component(), Controller(), m_pComponentController, m_smpComponent, m_smpComponentSetup, m_SubCaches, Setup(), and SubCaches().

Here is the call graph for this function:

FREE::SessionComponentCache::ComponentFREE::SessionComponentCache::ControllerFREE::SessionComponentCache::SetupFREE::SessionComponentCache::SubCachesFREE::SessionComponentCache::ControllerIsAssignedFREE::ComponentControllerInterface::GetGenericComponent

Friends And Related Function Documentation

friend class DirectSessionComponentAccessor [friend]

Definition at line 79 of file freSessionComponentCache.h.

Member Data Documentation

SessionComponentCache* FREE::SessionComponentCache::m_pParent [protected]

Pointer to the parent component cache. if Pointer is NULL no parent has been defined.

Definition at line 165 of file freSessionComponentCache.h.

Referenced by GetParentCache(), GetRootCache(), HasParentCache(), and SessionComponentCache().

ComponentSetup::Pointer FREE::SessionComponentCache::m_smpComponentSetup [protected]

Pointer to the cached component setup.

Definition at line 168 of file freSessionComponentCache.h.

Referenced by operator=(), SessionComponentCache(), Setup(), and SetupIsAssigned().

const GenericComponentController* FREE::SessionComponentCache::m_pComponentController [protected]

Pointer to the cached component controller.

Definition at line 171 of file freSessionComponentCache.h.

Referenced by Component(), Controller(), ControllerIsAssigned(), IsActive(), operator=(), SessionComponentCache(), and SetComponent().

ComponentCacheCollectionType FREE::SessionComponentCache::m_SubCaches [protected]

Subcomponents of this component cache

Definition at line 174 of file freSessionComponentCache.h.

Referenced by GetConstCacheByIDPath(), operator=(), and SubCaches().

GenericComponentPointer FREE::SessionComponentCache::m_smpComponent [protected]

Smartpointer of the cached component setup.

Definition at line 177 of file freSessionComponentCache.h.

Referenced by Component(), ComponentIsAssigned(), FREE::DirectSessionComponentAccessor::GetComponent(), IsActive(), operator=(), SessionComponentCache(), FREE::DirectSessionComponentAccessor::SetComponent(), and SetComponent().

CacheRepositoryType FREE::SessionComponentCache::m_Repository [protected]

Map of string keys and generic component pointers as values. This is a repository that can be used be the controller to store any data concerning the cached component and cannot or should not stored in the component.

Definition at line 182 of file freSessionComponentCache.h.

Referenced by FREE::DirectSessionComponentAccessor::DeleteRepositoryElement(), FREE::DirectSessionComponentAccessor::GetRepository(), FREE::DirectSessionComponentAccessor::GetRepositoryElement(), and FREE::DirectSessionComponentAccessor::SetRepositoryElement().

bool FREE::SessionComponentCache::m_bPassive [protected]

Definition at line 184 of file freSessionComponentCache.h.

Referenced by IsPassiveCache(), and SessionComponentCache().

The documentation for this class was generated from the following files:
Generated at Sat Oct 13 18:29:28 2007 for f.r.e.e. - Flexible Registration and Evaluation Engine by doxygen 1.5.3 written by Dimitri van Heesch, © 1997-2000