#include <freRegistrationProcessEventHandler.h>

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.
| typedef RegistrationProcessEventHandler<TRegistrationProcessor> FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::Self |
Definition at line 51 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.
| typedef itk::SmartPointer<RegistrationProcessEventHandler> FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::Pointer |
Definition at line 52 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.
| typedef TRegistrationProcessor FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::RegistrationProcessorType |
Definition at line 53 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.
| typedef RegistrationProcessEventHandler<TRegistrationProcessor> FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::Self |
Definition at line 51 of file Controllers/Registration/freRegistrationProcessEventHandler.h.
| typedef itk::SmartPointer<RegistrationProcessEventHandler> FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::Pointer |
Definition at line 52 of file Controllers/Registration/freRegistrationProcessEventHandler.h.
| typedef TRegistrationProcessor FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::RegistrationProcessorType |
Definition at line 53 of file Controllers/Registration/freRegistrationProcessEventHandler.h.
| 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().

| FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::RegistrationProcessEventHandler | ( | ) | [protected] |
| FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::itkNewMacro | ( | RegistrationProcessEventHandler< TRegistrationProcessor > | ) |
| FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::itkTypeMacro | ( | RegistrationProcessEventHandler< TRegistrationProcessor > | , | |
| itk::LightObject | ||||
| ) |
| 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.
| 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.
| 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.
| 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().

| 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.
| [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().

| 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.
| [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().

| 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.
| [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().

| FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::itkNewMacro | ( | RegistrationProcessEventHandler< TRegistrationProcessor > | ) |
| FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::itkTypeMacro | ( | RegistrationProcessEventHandler< TRegistrationProcessor > | , | |
| itk::LightObject | ||||
| ) |
| void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetSessionInfo | ( | SessionInfo * | pSessionInfo | ) |
| void FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetComponentCache | ( | SessionComponentCache * | pCache | ) |
| 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.
| StatisticEntry * FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::GetRegistrationEntry | ( | ) | [inline] |
Definition at line 173 of file Controllers/Registration/freRegistrationProcessEventHandler.txx.
References FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pRegistrationEntry.
| StatisticEntry * FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::GetLevelEntry | ( | ) | [inline] |
Definition at line 181 of file Controllers/Registration/freRegistrationProcessEventHandler.txx.
References FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pLevelEntry.
| StatisticEntry * FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::GetIterationEntry | ( | ) | [inline] |
Definition at line 189 of file Controllers/Registration/freRegistrationProcessEventHandler.txx.
References FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pIterationEntry.
| 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.
| [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().

| 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.
| [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().

| 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.
| [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().

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().
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().
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().
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().
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().
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().
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().
RegistrationProcessorType* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pProcessor [protected] |
Definition at line 82 of file Components/SetupOptimization/BasicControllers/freRegistrationProcessEventHandler.h.
Referenced by FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::SetComponentCache().
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.
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.
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.
SessionInfo* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pSessionInfo [protected] |
Definition at line 76 of file Controllers/Registration/freRegistrationProcessEventHandler.h.
SessionComponentCache* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pCache [protected] |
Definition at line 78 of file Controllers/Registration/freRegistrationProcessEventHandler.h.
RegistrationProcessorType* FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::m_pProcessor [protected] |
Definition at line 80 of file Controllers/Registration/freRegistrationProcessEventHandler.h.
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().
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().
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().
1.5.3 written by Dimitri van Heesch,
© 1997-2000