FREE::RegistrationProcessEventHandler< TRegistrationProcessor > Class Template Reference
[Registration controllerRegistration controller]

Class handles the events generated by registration processors... More...

#include <freRegistrationProcessEventHandler.h>

Collaboration diagram for FREE::RegistrationProcessEventHandler< TRegistrationProcessor >:

Collaboration graph
FREE::SessionInfoFREE::StatisticsFREE::XMLStreamObjectFREE::SetupFREE::XMLStringMultiMapFREE::TimeStampedObjectFREE::StatisticDataFREE::SessionComponentCacheFREE::ComponentCacheCollection\< TCache \>FREE::KeyedCollectionBase\< std::string, TCache, FREE::ComponentCacheIdentifier\< TCache \> \>FREE::SmartCollectionBase\< TElement \>FREE::CollectionBase\< TElement, itk::SmartPointer\< TElement \> \>FREE::ComponentControllerInterfaceFREE::CtrlProfile::ProfileInheritanceFREE::StatisticEntry
[legend]

List of all members.

Public Types

typedef
RegistrationProcessEventHandler
< TRegistrationProcessor > 
Self
typedef
itk::SmartPointer
< RegistrationProcessEventHandler
Pointer
typedef
TRegistrationProcessor 
RegistrationProcessorType
typedef
RegistrationProcessEventHandler
< TRegistrationProcessor > 
Self
typedef
itk::SmartPointer
< RegistrationProcessEventHandler
Pointer
typedef
TRegistrationProcessor 
RegistrationProcessorType

Public Member Functions

 itkNewMacro (RegistrationProcessEventHandler)
 itkTypeMacro (RegistrationProcessEventHandler, itk::LightObject)
void SetSessionInfo (SessionInfo *pSessionInfo)
void SetOnProgress (ProgressCtrlEventBase *onProgress)
void SetOnCallback (CallbackCtrlEventBase *onCallback)
void SetComponentCache (SessionComponentCache *pCache)
 itkNewMacro (RegistrationProcessEventHandler)
 itkTypeMacro (RegistrationProcessEventHandler, itk::LightObject)
void SetSessionInfo (SessionInfo *pSessionInfo)
void SetComponentCache (SessionComponentCache *pCache)
void SetRegistrationEntry (StatisticEntry *pEntry)
StatisticEntryGetRegistrationEntry ()
StatisticEntryGetLevelEntry ()
StatisticEntryGetIterationEntry ()

Protected Member Functions

 RegistrationProcessEventHandler ()
void OnNextLevel (const unsigned int iLevel, void *pSender)
void OnNextIteration (const long lIteration, Statistics *pStatistic, void *pSender)
void OnRegistrationProgressEvent (const RegistrationStatusType status, void *pSender, const std::string sComment)
 RegistrationProcessEventHandler ()
void OnNextLevel (const unsigned int iLevel, void *pSender, long threadID=0)
void OnNextIteration (const long lIteration, Statistics *pStatistic, void *pSender, long threadID=0)
void OnRegistrationProgressEvent (const RegistrationStatusType status, const std::string sComment, void *pSender, long threadID=0)

Protected Attributes

ProgressCtrlEventBase::Pointer m_OnProgress
CallbackCtrlEventBase::Pointer m_OnCallback
IterationEvent< Self >
::Pointer 
m_IterationEvent
LevelEvent< Self >
::Pointer 
m_LevelEvent
RegistrationProgressEvent
< Self >::Pointer 
m_RegistrationProgressEvent
SessionInfom_pSessionInfo
SessionComponentCachem_pCache
RegistrationProcessorTypem_pProcessor
IterationEvent< Self >
::Pointer 
m_IterationEvent
LevelEvent< Self >
::Pointer 
m_LevelEvent
RegistrationProgressEvent
< Self >::Pointer 
m_RegistrationProgressEvent
SessionInfom_pSessionInfo
SessionComponentCachem_pCache
RegistrationProcessorTypem_pProcessor
StatisticEntrym_pRegistrationEntry
StatisticEntrym_pLevelEntry
StatisticEntrym_pIterationEntry


Detailed Description

template<class TRegistrationProcessor>
class FREE::RegistrationProcessEventHandler< TRegistrationProcessor >

Class handles the events generated by registration processors...

RegistrationProcessEventHandler is used to handle the events of a registration processor. It handles the event directly or converts it into a controller progress notification respectively a callback.
This class is needed because the controller itself is neutral towards the components he manages and would not be able to access component specific information if uses a own event function. The RegistrationProcessEventHandler is containes both the event function pointer and the component specific information.

RegistrationProcessEventHandler is used to handle the events of a registration processor. It handles the event directly or converts it into a controller progress notification respectively a callback.
This class is needed because the controller itself is neutral towards the components he manages and would not be able to access component specific information if uses an own event function. The RegistrationProcessEventHandler is contains both the event function pointer and the component specific information.

Definition at line 48 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.


Member Typedef Documentation

template<class TRegistrationProcessor>
typedef RegistrationProcessEventHandler<TRegistrationProcessor> FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::Self

Definition at line 51 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.

template<class TRegistrationProcessor>
typedef itk::SmartPointer<RegistrationProcessEventHandler> FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::Pointer

Definition at line 52 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.

template<class TRegistrationProcessor>
typedef TRegistrationProcessor FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::RegistrationProcessorType

Definition at line 53 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.

template<class TRegistrationProcessor>
typedef RegistrationProcessEventHandler<TRegistrationProcessor> FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::Self

Definition at line 51 of file Controllers/Registration/freRegistrationProcessEventHandler.h.

template<class TRegistrationProcessor>
typedef itk::SmartPointer<RegistrationProcessEventHandler> FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::Pointer

Definition at line 52 of file Controllers/Registration/freRegistrationProcessEventHandler.h.

template<class TRegistrationProcessor>
typedef TRegistrationProcessor FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::RegistrationProcessorType

Definition at line 53 of file Controllers/Registration/freRegistrationProcessEventHandler.h.


Constructor & Destructor Documentation

template<class TRegistrationProcessor>
FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::RegistrationProcessEventHandler (  )  [inline, protected]

Definition at line 82 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.txx.

References FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_IterationEvent, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_LevelEvent, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_RegistrationProgressEvent, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), and FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnRegistrationProgressEvent().

Here is the call graph for this function:

FREE::RegistrationProcessEventHandler::OnNextIterationFREE::RegistrationProcessEventHandler::OnNextLevelFREE::RegistrationProcessEventHandler::OnRegistrationProgressEventFREE::SessionComponentCache::GetIDPathFREE::SessionInfo::GetStatisticFREE::Convert::ToStrFREE::ComponentSetup::GetIDPathFREE::SessionComponentCache::SetupFREE::ComponentSetup::HasParentComponent

template<class TRegistrationProcessor>
FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::RegistrationProcessEventHandler (  )  [protected]


Member Function Documentation

template<class TRegistrationProcessor>
FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::itkNewMacro ( RegistrationProcessEventHandler< TRegistrationProcessor >   ) 

template<class TRegistrationProcessor>
FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::itkTypeMacro ( RegistrationProcessEventHandler< TRegistrationProcessor >  ,
itk::LightObject   
)

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetSessionInfo ( SessionInfo pSessionInfo  )  [inline]

Definition at line 34 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.txx.

References FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pSessionInfo.

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetOnProgress ( ProgressCtrlEventBase onProgress  )  [inline]

Definition at line 42 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.txx.

References FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_OnProgress.

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetOnCallback ( CallbackCtrlEventBase onCallback  )  [inline]

Definition at line 50 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.txx.

References FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_OnCallback.

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetComponentCache ( SessionComponentCache pCache  )  [inline]

Definition at line 58 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.txx.

References catchAllNPassMacro, FREE::SessionComponentCache::Component(), FREE::SessionComponentCache::GetIDPath(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_IterationEvent, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_LevelEvent, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pCache, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pProcessor, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_RegistrationProgressEvent, throwExceptionMacro, and FREE::IDPath::ToStr().

Here is the call graph for this function:

FREE::SessionComponentCache::ComponentFREE::SessionComponentCache::GetIDPathFREE::IDPath::ToStrFREE::SessionComponentCache::ControllerIsAssignedFREE::ComponentControllerInterface::GetGenericComponentFREE::ComponentSetup::GetIDPathFREE::SessionComponentCache::SetupFREE::ComponentSetup::HasParentComponentFREE::IDPath::Size

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel ( const unsigned int  iLevel,
void *  pSender 
) [inline, protected]

Function is plugged to the fnOnNextLevel function pointer of RegistrationProcessor via m_LevelEvent.

Parameters:
[in] iLevel Level of registration started with this event.
[in,out] pSender Void pointer to the sender of the event. Must be cast.

Definition at line 92 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.txx.

References FREE::SessionComponentCache::GetIDPath(), FREE::SessionInfo::GetStatistic(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pCache, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pSessionInfo, and FREE::Convert::ToStr().

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

Here is the call graph for this function:

FREE::SessionComponentCache::GetIDPathFREE::SessionInfo::GetStatisticFREE::Convert::ToStrFREE::ComponentSetup::GetIDPathFREE::SessionComponentCache::SetupFREE::ComponentSetup::HasParentComponent

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration ( const long  lIteration,
Statistics pStatistic,
void *  pSender 
) [inline, protected]

Function is plugged to the fnOnNextIteration function pointer of RegistrationProcessor via m_IterationEvent.

Parameters:
[in] lIteration The actual iteration number.
[in,out] pStatistic Pointer to the statistic object, if set.
[in,out] pSender Void pointer to the sender of the event. Must be cast.

Definition at line 111 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.txx.

References FREE::SessionComponentCache::GetIDPath(), FREE::SessionInfo::GetStatistic(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pCache, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pSessionInfo, and FREE::Convert::ToStr().

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::RegistrationProcessEventHandler().

Here is the call graph for this function:

FREE::SessionComponentCache::GetIDPathFREE::SessionInfo::GetStatisticFREE::Convert::ToStrFREE::ComponentSetup::GetIDPathFREE::SessionComponentCache::SetupFREE::ComponentSetup::HasParentComponent

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnRegistrationProgressEvent ( const RegistrationStatusType  status,
void *  pSender,
const std::string  sComment 
) [inline, protected]

Function is plugged to the fnOnNextIteration function pointer of RegistrationProcessor via m_RegistrationProgressEvent.

Parameters:
[in] status Actual status of the registration process progress.
[in] pSender Pointer to the object, which called the event.
[in] sComment String for adding any comments concerning the new status.

Definition at line 128 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.txx.

References FREE::SessionComponentCache::GetIDPath(), and FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pCache.

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::RegistrationProcessEventHandler().

Here is the call graph for this function:

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

template<class TRegistrationProcessor>
FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::itkNewMacro ( RegistrationProcessEventHandler< TRegistrationProcessor >   ) 

template<class TRegistrationProcessor>
FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::itkTypeMacro ( RegistrationProcessEventHandler< TRegistrationProcessor >  ,
itk::LightObject   
)

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetSessionInfo ( SessionInfo pSessionInfo  ) 

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetComponentCache ( SessionComponentCache pCache  ) 

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetRegistrationEntry ( StatisticEntry pEntry  )  [inline]

Definition at line 160 of file Controllers/Registration/freRegistrationProcessEventHandler.txx.

References FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pIterationEntry, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pLevelEntry, and FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pRegistrationEntry.

template<class TRegistrationProcessor>
StatisticEntry * FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::GetRegistrationEntry (  )  [inline]

Definition at line 173 of file Controllers/Registration/freRegistrationProcessEventHandler.txx.

References FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pRegistrationEntry.

template<class TRegistrationProcessor>
StatisticEntry * FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::GetLevelEntry (  )  [inline]

Definition at line 181 of file Controllers/Registration/freRegistrationProcessEventHandler.txx.

References FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pLevelEntry.

template<class TRegistrationProcessor>
StatisticEntry * FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::GetIterationEntry (  )  [inline]

Definition at line 189 of file Controllers/Registration/freRegistrationProcessEventHandler.txx.

References FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pIterationEntry.

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel ( const unsigned int  iLevel,
void *  pSender,
long  threadID = 0 
) [inline, protected]

Function is plugged to the fnOnNextLevel function pointer of RegistrationProcessor via m_LevelEvent.

Parameters:
[in] iLevel Level of registration started with this event.
[in,out] pSender Void pointer to the sender of the event. Must be casted.
[in] threadID ID of the Thread executing the event. By default this value is 0. This ID is not unique over the complete system, it should only be assumed that it is unique in the context of the sender.

Definition at line 81 of file Controllers/Registration/freRegistrationProcessEventHandler.txx.

References FREE::StatisticDictionary::AddEntryDefinition(), FREE::StatisticEntry::AddValue(), FREE::StatisticDictionary::AddValueDefinition(), FREE::StatisticEntry::CreateChildEntry(), FREE::SessionComponentCache::GetControllerID(), FREE::Statistics::GetDictionary(), FREE::StatisticDictionary::GetEntryDefinitionByName(), FREE::SessionComponentCache::GetIDPath(), FREE::StatisticValueDefinition::GetRefID(), FREE::StatisticEntryDefinition::GetRefID(), FREE::SessionInfo::GetStatistic(), FREE::StatisticDictionary::GetValueDefinitionByName(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pCache, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pLevelEntry, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pRegistrationEntry, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pSessionInfo, FREE::StatisticEntry::SetRefID(), FREE::Convert::ToStr(), and FREE::ControllerCentral::TriggerControllerProgressEvent().

Here is the call graph for this function:

FREE::StatisticDictionary::AddEntryDefinitionFREE::StatisticEntry::AddValueFREE::StatisticDictionary::AddValueDefinitionFREE::StatisticEntry::CreateChildEntryFREE::SessionComponentCache::GetControllerIDFREE::Statistics::GetDictionaryFREE::StatisticDictionary::GetEntryDefinitionByNameFREE::SessionComponentCache::GetIDPathFREE::StatisticValueDefinition::GetRefIDFREE::StatisticEntryDefinition::GetRefIDFREE::SessionInfo::GetStatisticFREE::StatisticDictionary::GetValueDefinitionByNameFREE::StatisticEntry::SetRefIDFREE::Convert::ToStrFREE::ControllerCentral::TriggerControllerProgressEventFREE::SmartCollectionBase::AddElementFREE::SmartCollectionBase::GetElementFREE::CollectionBase::SizeFREE::StatisticData::CreateEntryFREE::TimeStampedObject::IsClosedFREE::StatisticData::OpenEntryFREE::StatisticEntry::PostCreateChildEntryFREE::StatisticEntry::NewFREE::StatisticEntry::StatisticEntryFREE::SessionComponentCache::ControllerFREE::ComponentControllerInterface::ControllerIDFREE::ComponentSetup::GetIDPathFREE::SessionComponentCache::SetupFREE::ComponentSetup::HasParentComponent

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration ( const long  lIteration,
Statistics pStatistic,
void *  pSender,
long  threadID = 0 
) [inline, protected]

Function is plugged to the fnOnNextIteration function pointer of RegistrationProcessor via m_IterationEvent.

Parameters:
[in] lIteration The actual iteration number.
[in,out] pStatistic Pointer to the statistic object, if set.
[in,out] pSender Void pointer to the sender of the event. Must be casted.
[in] threadID ID of the Thread executing the event. By default this value is 0. This ID is not unique over the complete system, it should only be assumed that it is unique in the context of the sender.

Definition at line 110 of file Controllers/Registration/freRegistrationProcessEventHandler.txx.

References FREE::StatisticDictionary::AddEntryDefinition(), FREE::StatisticEntry::AddValue(), FREE::StatisticDictionary::AddValueDefinition(), FREE::StatisticEntry::CloseEntry(), FREE::SessionComponentCache::Controller(), FREE::SessionComponentCache::GetControllerID(), FREE::Statistics::GetDictionary(), FREE::StatisticDictionary::GetEntryDefinitionByName(), FREE::SessionComponentCache::GetIDPath(), FREE::StatisticValueDefinition::GetRefID(), FREE::StatisticEntryDefinition::GetRefID(), FREE::SessionInfo::GetStatistic(), FREE::StatisticDictionary::GetValueDefinitionByName(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pCache, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pIterationEntry, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pLevelEntry, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pRegistrationEntry, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pSessionInfo, FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), FREE::StatisticEntry::PostCreateChildEntry(), FREE::StatisticEntry::SetRefID(), FREE::ComponentControllerInterface::SetStatisticEntry(), FREE::Convert::ToStr(), and FREE::ControllerCentral::TriggerControllerProgressEvent().

Here is the call graph for this function:

FREE::StatisticDictionary::AddEntryDefinitionFREE::StatisticEntry::AddValueFREE::StatisticDictionary::AddValueDefinitionFREE::StatisticEntry::CloseEntryFREE::SessionComponentCache::ControllerFREE::SessionComponentCache::GetControllerIDFREE::Statistics::GetDictionaryFREE::StatisticDictionary::GetEntryDefinitionByNameFREE::SessionComponentCache::GetIDPathFREE::StatisticValueDefinition::GetRefIDFREE::StatisticEntryDefinition::GetRefIDFREE::SessionInfo::GetStatisticFREE::StatisticDictionary::GetValueDefinitionByNameFREE::RegistrationProcessEventHandler::OnNextLevelFREE::StatisticEntry::PostCreateChildEntryFREE::StatisticEntry::SetRefIDFREE::ComponentControllerInterface::SetStatisticEntryFREE::Convert::ToStrFREE::ControllerCentral::TriggerControllerProgressEventFREE::SmartCollectionBase::AddElementFREE::SmartCollectionBase::GetElementFREE::CollectionBase::SizeFREE::StatisticData::CloseEntryFREE::TimeStampedObject::IsClosedFREE::TimeStampedObject::SetClosingTimeStampFREE::TimeStampedObject::StampFREE::ComponentControllerInterface::ControllerIDFREE::ComponentSetup::GetIDPathFREE::SessionComponentCache::SetupFREE::ComponentSetup::HasParentComponentFREE::Convert::ToStrFREE::StatisticData::CreateEntryFREE::StatisticData::OpenEntryFREE::StatisticEntry::NewFREE::StatisticEntry::StatisticEntry

template<class TRegistrationProcessor>
void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnRegistrationProgressEvent ( const RegistrationStatusType  status,
const std::string  sComment,
void *  pSender,
long  threadID = 0 
) [inline, protected]

Function is plugged to the fnOnNextIteration function pointer of RegistrationProcessor via m_RegistrationProgressEvent.

Parameters:
[in] status Actual status of the registration process progress.
[in] pSender Pointer to the object, which called the event.
[in] sComment String for adding any comments concerning the new status.
[in] threadID ID of the Thread executing the event. By default this value is 0. This ID is not unique over the complete system, it should only be assumed that it is unique in the context of the sender.

Definition at line 146 of file Controllers/Registration/freRegistrationProcessEventHandler.txx.

References FREE::SessionComponentCache::GetIDPath(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pCache, and FREE::ControllerCentral::TriggerControllerProgressEvent().

Here is the call graph for this function:

FREE::SessionComponentCache::GetIDPathFREE::ControllerCentral::TriggerControllerProgressEventFREE::ComponentSetup::GetIDPathFREE::SessionComponentCache::SetupFREE::ComponentSetup::HasParentComponent


Member Data Documentation

template<class TRegistrationProcessor>
ProgressCtrlEventBase::Pointer FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_OnProgress [protected]

Pointer to the function that handles controller progress events.

Definition at line 67 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetOnProgress().

template<class TRegistrationProcessor>
CallbackCtrlEventBase::Pointer FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_OnCallback [protected]

Pointer to the function that handles controller callback events.

Definition at line 69 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetOnCallback().

template<class TRegistrationProcessor>
IterationEvent<Self>::Pointer FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_IterationEvent [protected]

Event object that handles iteration events of the processor.

Definition at line 72 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::RegistrationProcessEventHandler(), and FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetComponentCache().

template<class TRegistrationProcessor>
LevelEvent<Self>::Pointer FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_LevelEvent [protected]

Event object that handles level events of the processor.

Definition at line 74 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::RegistrationProcessEventHandler(), and FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetComponentCache().

template<class TRegistrationProcessor>
RegistrationProgressEvent<Self>::Pointer FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_RegistrationProgressEvent [protected]

Event object that handles registration progress events of the processor.

Definition at line 76 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::RegistrationProcessEventHandler(), and FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetComponentCache().

template<class TRegistrationProcessor>
SessionInfo* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pSessionInfo [protected]

Definition at line 78 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), and FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetSessionInfo().

template<class TRegistrationProcessor>
SessionComponentCache* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pCache [protected]

Definition at line 80 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnRegistrationProgressEvent(), and FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetComponentCache().

template<class TRegistrationProcessor>
RegistrationProcessorType* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pProcessor [protected]

Definition at line 82 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetComponentCache().

template<class TRegistrationProcessor>
IterationEvent<Self>::Pointer FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_IterationEvent [protected]

Event object that handles iteration events of the processor.

Definition at line 70 of file Controllers/Registration/freRegistrationProcessEventHandler.h.

template<class TRegistrationProcessor>
LevelEvent<Self>::Pointer FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_LevelEvent [protected]

Event object that handles level events of the processor.

Definition at line 72 of file Controllers/Registration/freRegistrationProcessEventHandler.h.

template<class TRegistrationProcessor>
RegistrationProgressEvent<Self>::Pointer FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_RegistrationProgressEvent [protected]

Event object that handles registration progress events of the processor.

Definition at line 74 of file Controllers/Registration/freRegistrationProcessEventHandler.h.

template<class TRegistrationProcessor>
SessionInfo* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pSessionInfo [protected]

Definition at line 76 of file Controllers/Registration/freRegistrationProcessEventHandler.h.

template<class TRegistrationProcessor>
SessionComponentCache* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pCache [protected]

Definition at line 78 of file Controllers/Registration/freRegistrationProcessEventHandler.h.

template<class TRegistrationProcessor>
RegistrationProcessorType* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pProcessor [protected]

Definition at line 80 of file Controllers/Registration/freRegistrationProcessEventHandler.h.

template<class TRegistrationProcessor>
StatisticEntry* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pRegistrationEntry [protected]

Definition at line 82 of file Controllers/Registration/freRegistrationProcessEventHandler.h.

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::GetRegistrationEntry(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), and FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetRegistrationEntry().

template<class TRegistrationProcessor>
StatisticEntry* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pLevelEntry [protected]

Definition at line 83 of file Controllers/Registration/freRegistrationProcessEventHandler.h.

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::GetLevelEntry(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), and FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetRegistrationEntry().

template<class TRegistrationProcessor>
StatisticEntry* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pIterationEntry [protected]

Definition at line 84 of file Controllers/Registration/freRegistrationProcessEventHandler.h.

Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::GetIterationEntry(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), and FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetRegistrationEntry().


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