FREE::MediaActualizerController

FREE::MediaActualizerController Class Reference
[Media controller]

Controller class for fre::MediaActualizer. More...

#include <freMediaActualizerController.h>

Inheritance diagram for FREE::MediaActualizerController:

Inheritance graph
FREE::ProcessorControllerBase\< FREE::MediaActualizer \>FREE::ComponentControllerBase\< TControlledProcessor \>FREE::ComponentControllerInterface
[legend]
Collaboration diagram for FREE::MediaActualizerController:

Collaboration graph
FREE::ProcessorControllerBase\< FREE::MediaActualizer \>FREE::ComponentControllerBase\< TControlledProcessor \>FREE::ComponentControllerInterfaceFREE::CtrlProfile::ProfileInheritanceFREE::XMLStringMultiMapFREE::XMLStreamObject
[legend]

List of all members.

Public Types

typedef MediaActualizer ComponentType
typedef
ProcessorControllerBase
< ComponentType > 		Superclass
typedef
MediaActualizerController 		Self
typedef
ComponentType::Pointer 		ComponentPointer
typedef
Superclass::GenericComponentType 		GenericComponentType
typedef
Superclass::GenericComponentPointer 		GenericComponentPointer
typedef
Superclass::GenericMediaPointer 		GenericMediaPointer

Public Member Functions

 itkTypeMacro (MediaActualizerController, ProcessorControllerBase)
 DeclareParameterMacro (PersistentResult)
 DeclareParameterMacro (UseField)
 DeclareMediaIDMacro (deformationField)
 DeclareMediaIDMacro (transformFunction)
virtual
ValidityTag::Pointer 		GetMediaValidityTag (const MediaID &mediaID, SessionComponentCache *pComponentCache) const
virtual
ValidityTag::Pointer 		GetMediaValidityTagRequirement (const MediaID &mediaID, SessionComponentCache *pComponentCache) const
virtual std::string GetMediaControllerID (const MediaID &mediaID, SessionComponentCache *pComponentCache) const
 MediaActualizerController ()

Protected Member Functions

virtual void GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const
virtual
GenericMediaPointer 		GetMediaCasted (const MediaID &mediaID, ComponentType *pComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo) const
virtual void SetMediaCasted (const MediaID &mediaID, GenericMediaType *pMedia, ComponentType *pComponent, SessionComponentCache *pComponentCache, SessionInfo *pSessionInfo) const
bool UseField (SessionComponentCache *pComponentCache) const

Detailed Description

Controller class for fre::MediaActualizer.

MediaActualizerController is derived from ProcessorControllerBase and is the controller of fre::MediaActualizer.

Definition at line 41 of file freMediaActualizerController.h.

Member Typedef Documentation

typedef MediaActualizer FREE::MediaActualizerController::ComponentType

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

Reimplemented from FREE::ProcessorControllerBase< TControlledProcessor >.

Definition at line 44 of file freMediaActualizerController.h.

typedef ProcessorControllerBase<ComponentType> FREE::MediaActualizerController::Superclass

Reimplemented from FREE::ProcessorControllerBase< TControlledProcessor >.

Definition at line 45 of file freMediaActualizerController.h.

typedef MediaActualizerController FREE::MediaActualizerController::Self

Definition at line 46 of file freMediaActualizerController.h.

typedef ComponentType::Pointer FREE::MediaActualizerController::ComponentPointer

SmartPointer of the component class

Reimplemented from FREE::ComponentControllerBase< TControlledProcessor >.

Definition at line 48 of file freMediaActualizerController.h.

typedef Superclass::GenericComponentType FREE::MediaActualizerController::GenericComponentType

Generic component type

Reimplemented from FREE::ProcessorControllerBase< TControlledProcessor >.

Definition at line 49 of file freMediaActualizerController.h.

typedef Superclass::GenericComponentPointer FREE::MediaActualizerController::GenericComponentPointer

Generic smartpointer for the controller interface

Reimplemented from FREE::ProcessorControllerBase< TControlledProcessor >.

Definition at line 50 of file freMediaActualizerController.h.

typedef Superclass::GenericMediaPointer FREE::MediaActualizerController::GenericMediaPointer

Reimplemented from FREE::ProcessorControllerBase< TControlledProcessor >.

Definition at line 51 of file freMediaActualizerController.h.

Constructor & Destructor Documentation

FREE::MediaActualizerController::MediaActualizerController (  ) 

Definition at line 159 of file freMediaActualizerController.cxx.

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

Here is the call graph for this function:

FREE::ComponentControllerInterface::UpdateControllerIDFREE::CtrlProfile::ProfileInheritance::AddAncestorFREE::XMLStringMultiMap::AddElementFREE::CtrlProfile::ProfileInheritance::IndexOfAncestorFREE::XMLStringMultiMap::SetElementDataFREE::XMLStringMultiMap::GetElementDataFREE::XMLStringMultiMap::Size

Member Function Documentation

FREE::MediaActualizerController::itkTypeMacro ( MediaActualizerController  ,
ProcessorControllerBase   
)

FREE::MediaActualizerController::DeclareParameterMacro ( PersistentResult   ) 

FREE::MediaActualizerController::DeclareParameterMacro ( UseField   ) 

FREE::MediaActualizerController::DeclareMediaIDMacro ( deformationField   ) 

FREE::MediaActualizerController::DeclareMediaIDMacro ( transformFunction   ) 

ValidityTag::Pointer FREE::MediaActualizerController::GetMediaValidityTag ( const MediaID &  mediaID,
SessionComponentCache *  pComponentCache 
) const [virtual]

Retrieves the validity tag of the media specified by the mediaID. The tag is used to decide if a media component is outdated or up to date. It determines the time when the medium was actualized the last time. This can be used by other controllers that link to the media to decide if they may be outdated.
Reimplement GetMediaValidityTag() to realize special controller behavior.
This version checks the cache repository for an element with key "MediaValidityTag_[mediaID]" and returns the ValidityTag. (e.g.: mediaID = finalImage -> key = MediaValidityTag_finalImage). If no element exists with this key, but the media is defined in the controller profile, a NULL-ValidityTag will be returned (always outdated compared to others). If neither an element nor a profile entry can be found, an exception will be thrown.

Parameters:
[in] mediaID ID specifying the wanted media.
[in] pComponentCache Pointer to the component cache.
Returns:
ValidityTag of the media. NULL-ValidityTag if no tag is yet defined for the media.

Reimplemented from FREE::ComponentControllerBase< TControlledProcessor >.

Definition at line 37 of file freMediaActualizerController.cxx.

References catchAllNPassMacro, FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElement(), FREE::ComponentControllerBase< TControlledProcessor >::GetMediaValidityTag(), FREE::DirectSessionComponentAccessor::GetRepositoryElement(), FREE::SessionAccessor::GetValidityTag(), FREE::ComponentSetup::MediaLinks(), FREE::SessionComponentRepositoryKeys::MediaValidity(), FREE::ValidityTag::NewNull(), FREE::SessionComponentCache::Setup(), and throwCtrlExceptionMacro.

Referenced by GetMediaCasted().

Here is the call graph for this function:

FREE::KeyedCollectionBase::GetElementFREE::ComponentControllerBase\< TControlledProcessor \>::GetMediaValidityTagFREE::DirectSessionComponentAccessor::GetRepositoryElementFREE::SessionAccessor::GetValidityTagFREE::ComponentSetup::MediaLinksFREE::SessionComponentRepositoryKeys::MediaValidityFREE::ValidityTag::NewNullFREE::SessionComponentCache::SetupFREE::KeyedCollectionBase::GetElementIndexFREE::SessionComponentCache::ControllerFREE::SessionComponentCache::ControllerIsAssignedFREE::SessionComponentCache::GetCacheByIDPathFREE::IDPath::ToStrFREE::IDPath::GetMediaIDFREE::ComponentControllerInterface::GetMediaValidityTagFREE::IDPath::GetParameterNameFREE::ComponentControllerInterface::GetParameterValidityTagFREE::IDPath::IsMediaSelectionFREE::IDPath::IsParameterSelectionFREE::SessionComponentCache::GetConstCacheByIDPathFREE::IDPath::GetFirstComponentFREE::SessionComponentCache::GetParentCacheFREE::SessionComponentCache::GetRootCacheFREE::IDPath::GetSubIDPathFREE::IDPath::SetAbsoluteFREE::IDPath::IsAbsoluteFREE::IDPath::IsEmptyFREE::IDPath::GetComponentFREE::IDPath::SizeFREE::IDPath::AssembleIDPathFREE::IDPath::AddComponentFREE::ValidityTag::New

ValidityTag::Pointer FREE::MediaActualizerController::GetMediaValidityTagRequirement ( const MediaID &  mediaID,
SessionComponentCache *  pComponentCache 
) const [virtual]

Retrieves the validity tag requirement of the media specified by the mediaID. The requirement is the most up to date ValidityTag in the dependency chain of a media component.
Reimplement GetMediaValidityTagRequirement() to realize special controller behavior accordingly a certain dependency chain.
This version returns only the ValidityTag of the specified media; thus the media has no dependencies.

Parameters:
[in] mediaID ID specifying the wanted media.
[in] pComponentCache Pointer to the component cache.
Returns:
ValidityTag requirement

Reimplemented from FREE::ComponentControllerBase< TControlledProcessor >.

Definition at line 86 of file freMediaActualizerController.cxx.

References catchAllNPassMacro, FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElement(), FREE::ComponentControllerBase< TControlledProcessor >::GetMediaValidityTagRequirement(), FREE::SessionAccessor::GetValidityTagRequirement(), FREE::ComponentSetup::MediaLinks(), FREE::ValidityTag::New(), FREE::SessionComponentCache::Setup(), throwCtrlExceptionMacro, and UseField().

Referenced by GetMediaCasted().

Here is the call graph for this function:

FREE::KeyedCollectionBase::GetElementFREE::ComponentControllerBase\< TControlledProcessor \>::GetMediaValidityTagRequirementFREE::SessionAccessor::GetValidityTagRequirementFREE::ComponentSetup::MediaLinksFREE::ValidityTag::NewFREE::SessionComponentCache::SetupFREE::MediaActualizerController::UseFieldFREE::KeyedCollectionBase::GetElementIndexFREE::SessionComponentCache::ControllerFREE::SessionComponentCache::ControllerIsAssignedFREE::SessionComponentCache::GetCacheByIDPathFREE::IDPath::ToStrFREE::IDPath::GetMediaIDFREE::ComponentControllerInterface::GetMediaValidityTagRequirementFREE::IDPath::GetParameterNameFREE::ComponentControllerInterface::GetParameterValidityTagRequirementFREE::IDPath::IsMediaSelectionFREE::IDPath::IsParameterSelectionFREE::SessionComponentCache::GetConstCacheByIDPathFREE::IDPath::GetFirstComponentFREE::SessionComponentCache::GetParentCacheFREE::SessionComponentCache::GetRootCacheFREE::IDPath::GetSubIDPathFREE::IDPath::SetAbsoluteFREE::IDPath::IsAbsoluteFREE::IDPath::IsEmptyFREE::IDPath::GetComponentFREE::IDPath::SizeFREE::IDPath::AssembleIDPathFREE::IDPath::AddComponentFREE::SessionAccessor::GetParameterValueFREE::SessionComponentCache::GetIDPathFREE::SessionAccessor::GetParameterFREE::ComponentSetup::GetIDPathFREE::ComponentSetup::HasParentComponentFREE::ComponentControllerInterface::GetParameter

std::string FREE::MediaActualizerController::GetMediaControllerID ( const MediaID &  mediaID,
SessionComponentCache *  pComponentCache 
) const [virtual]

Retrieves the ID of the actual controller of the given media. Every controller has default types/controllers for its media, but they could be invalid by linking media (e.g. media type is intensity image media, but the actually linked medium could be of subtype region image media.).

Parameters:
[in] mediaID ID specifying the wanted media.
[in] pComponentCache Pointer to the component cache.

Reimplemented from FREE::ComponentControllerBase< TControlledProcessor >.

Definition at line 141 of file freMediaActualizerController.cxx.

References catchAllNPassMacro, FREE::csUndefinedController, FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElement(), FREE::SessionAccessor::GetMediaControllerID(), FREE::ComponentSetup::MediaLinks(), FREE::SessionComponentCache::Setup(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

FREE::KeyedCollectionBase::GetElementFREE::SessionAccessor::GetMediaControllerIDFREE::ComponentSetup::MediaLinksFREE::SessionComponentCache::SetupFREE::KeyedCollectionBase::GetElementIndexFREE::SessionComponentCache::ControllerFREE::SessionComponentCache::ControllerIsAssignedFREE::SessionComponentCache::GetCacheByIDPathFREE::IDPath::ToStrFREE::ComponentControllerInterface::GetMediaControllerIDFREE::IDPath::GetMediaIDFREE::IDPath::IsMediaSelectionFREE::SessionComponentCache::GetConstCacheByIDPathFREE::IDPath::GetFirstComponentFREE::SessionComponentCache::GetParentCacheFREE::SessionComponentCache::GetRootCacheFREE::IDPath::GetSubIDPathFREE::IDPath::SetAbsoluteFREE::IDPath::IsAbsoluteFREE::IDPath::IsEmptyFREE::IDPath::GetComponentFREE::IDPath::SizeFREE::IDPath::AssembleIDPathFREE::IDPath::AddComponent

void FREE::MediaActualizerController::GenerateProfile ( CtrlProfile::ControllerProfile &  profile,
const SessionComponentCache *  pComponentCache,
bool  bRegardOldSetup 
) const [protected, virtual]

Adjusts the current profile according to the definitions of the controller.
Method should call the superclass variant to regard demands of basic controllers.

Parameters:
[in,out] profile Reference of the current profile.
[in] pComponentCache Pointer to the cache indicating the location of the component that should be profiled. This pointer can be null. In this case only a default profile that isn't context sensitive is wanted (others aren't possible anyway)
[in] bRegardOldSetup If true, the setup of pComponentCache is valid and should be regarded when the profile is generated. Otherwise just use defaults if setup information is needed.

Reimplemented from FREE::ComponentControllerBase< TControlledProcessor >.

Definition at line 168 of file freMediaActualizerController.cxx.

References FREE::DAAny, FREE::DASet, FREE::CtrlProfile::Media::DT_AllDimensions, FREE::ComponentControllerBase< TControlledProcessor >::GenerateProfile(), FREE::ControllerID::MediaControllerBase, FREE::CtrlProfile::ControllerProfileBase::MediaMap(), FREE::CtrlProfile::ControllerProfileBase::Parameters(), and FREE::Parameter::PVTBool.

Here is the call graph for this function:

FREE::ComponentControllerBase\< TControlledProcessor \>::GenerateProfileFREE::CtrlProfile::ControllerProfileBase::MediaMapFREE::CtrlProfile::ControllerProfileBase::Parameters

MediaActualizerController::GenericMediaPointer FREE::MediaActualizerController::GetMediaCasted ( const MediaID &  mediaID,
ComponentType *  pComponent,
SessionComponentCache *  pComponentCache,
SessionInfo *  pSessionInfo 
) const [protected, virtual]

Definition at line 189 of file freMediaActualizerController.cxx.

References FREE::MediaActualizer::ActualizeMediaByField(), FREE::MediaActualizer::ActualizeMediaByFunction(), FREE::ComponentControllerBase< TControlledProcessor >::ActualizeMediaValidityTag(), catchAllNPassMacro, FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElement(), FREE::ComponentControllerBase< TControlledProcessor >::GetMediaCasted(), GetMediaValidityTag(), GetMediaValidityTagRequirement(), FREE::SessionAccessor::GetParameterValue(), FREE::DirectSessionComponentAccessor::GetRepositoryElement(), FREE::ComponentSetup::MediaLinks(), FREE::ComponentControllerBase< TControlledProcessor >::NotifyProgress(), FREE::DirectSessionComponentAccessor::SetRepositoryElement(), FREE::SessionComponentCache::Setup(), throwCtrlExceptionMacro, and UseField().

Here is the call graph for this function:

FREE::MediaActualizer::ActualizeMediaByFieldFREE::MediaActualizer::ActualizeMediaByFunctionFREE::ComponentControllerBase\< TControlledProcessor \>::ActualizeMediaValidityTagFREE::KeyedCollectionBase::GetElementFREE::ComponentControllerBase\< TControlledProcessor \>::GetMediaCastedFREE::MediaActualizerController::GetMediaValidityTagFREE::DirectSessionComponentAccessor::GetRepositoryElementFREE::ComponentSetup::MediaLinksFREE::SessionComponentCache::SetupFREE::MediaActualizerController::GetMediaValidityTagRequirementFREE::MediaActualizerController::UseFieldFREE::SessionAccessor::GetParameterValueFREE::ComponentControllerBase\< TControlledProcessor \>::NotifyProgressFREE::DirectSessionComponentAccessor::SetRepositoryElementFREE::ControllerCentral::GetControllerFREE::SessionAccessor::GetMediaFREE::IDPath::ToStrFREE::SessionAccessor::GetMediaControllerIDFREE::SessionInfo::GetSessionCacheFREE::ControllerInfo::GetControllerFREE::ControllerCentral::GetControllerInfoFREE::SessionComponentCache::ControllerFREE::SessionInfo::GetCacheByIDPathFREE::ComponentControllerInterface::GetMediaFREE::IDPath::GetMediaIDFREE::IDPath::GetParentComponentIDPathFREE::SessionComponentCache::IsActiveFREE::IDPath::IsMediaSelectionFREE::IDPath::SizeFREE::SessionComponentCache::ControllerIsAssignedFREE::SessionComponentCache::GetCacheByIDPathFREE::ComponentControllerInterface::GetMediaControllerIDFREE::KeyedCollectionBase::GetElementIndexFREE::ComponentControllerBase\< TControlledProcessor \>::GetMediaValidityTagFREE::SessionAccessor::GetValidityTagFREE::SessionComponentRepositoryKeys::MediaValidityFREE::ValidityTag::NewNullFREE::ComponentControllerInterface::GetMediaValidityTagFREE::IDPath::GetParameterNameFREE::ComponentControllerInterface::GetParameterValidityTagFREE::IDPath::IsParameterSelectionFREE::ValidityTag::NewFREE::ComponentControllerBase\< TControlledProcessor \>::GetMediaValidityTagRequirementFREE::SessionAccessor::GetValidityTagRequirementFREE::ComponentControllerInterface::GetMediaValidityTagRequirementFREE::ComponentControllerInterface::GetParameterValidityTagRequirementFREE::SessionComponentCache::GetIDPathFREE::SessionAccessor::GetParameterFREE::ComponentSetup::GetIDPath

void FREE::MediaActualizerController::SetMediaCasted ( const MediaID &  mediaID,
GenericMediaType *  pMedia,
ComponentType *  pComponent,
SessionComponentCache *  pComponentCache,
SessionInfo *  pSessionInfo 
) const [protected, virtual]

Definition at line 252 of file freMediaActualizerController.cxx.

References FREE::ComponentControllerBase< TControlledProcessor >::SetMediaCasted().

Here is the call graph for this function:

FREE::ComponentControllerBase\< TControlledProcessor \>::SetMediaCasted

bool FREE::MediaActualizerController::UseField ( SessionComponentCache *  pComponentCache  )  const [protected]

Definition at line 131 of file freMediaActualizerController.cxx.

References FREE::SessionAccessor::GetParameterValue().

Referenced by GetMediaCasted(), and GetMediaValidityTagRequirement().

Here is the call graph for this function:

FREE::SessionAccessor::GetParameterValueFREE::SessionComponentCache::GetIDPathFREE::SessionAccessor::GetParameterFREE::IDPath::ToStrFREE::ComponentSetup::GetIDPathFREE::SessionComponentCache::SetupFREE::ComponentSetup::HasParentComponentFREE::SessionComponentCache::ControllerFREE::SessionComponentCache::ControllerIsAssignedFREE::ComponentControllerInterface::GetParameterFREE::IDPath::Size

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