f.r.e.e. - Flexible Registration and Evaluation Engine: FREE::MediaControllerBase< TMedia

template<class TMedia>

typedef TMedia FREE::MediaControllerBase< TMedia >::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::ComponentControllerBase< TMedia >.

Definition at line 43 of file freMediaControllerBase.h.

template<class TMedia>

typedef ComponentControllerBase<TMedia> FREE::MediaControllerBase< TMedia >::Superclass

Definition at line 44 of file freMediaControllerBase.h.

template<class TMedia>

typedef ComponentType::Pointer FREE::MediaControllerBase< TMedia >::ComponentPointer

SmartPointer of the component class

Reimplemented from FREE::ComponentControllerBase< TMedia >.

Definition at line 46 of file freMediaControllerBase.h.

template<class TMedia>

typedef Superclass::GenericComponentType FREE::MediaControllerBase< TMedia >::GenericComponentType

Reimplemented from FREE::MediaControllerInterface.

Definition at line 47 of file freMediaControllerBase.h.

template<class TMedia>

typedef Superclass::GenericComponentPointer FREE::MediaControllerBase< TMedia >::GenericComponentPointer

Reimplemented from FREE::MediaControllerInterface.

Definition at line 48 of file freMediaControllerBase.h.

template<class TMedia>

typedef Superclass::GenericMediaType FREE::MediaControllerBase< TMedia >::GenericMediaType

Reimplemented from FREE::MediaControllerInterface.

Definition at line 49 of file freMediaControllerBase.h.

template<class TMedia>

typedef Superclass::GenericMediaPointer FREE::MediaControllerBase< TMedia >::GenericMediaPointer

Reimplemented from FREE::MediaControllerInterface.

Definition at line 50 of file freMediaControllerBase.h.

template<class TMedia>

FREE::MediaControllerBase< TMedia >::MediaControllerBase ( ) [inline]

Implementation of FREE::MediaContainerController ///////////////////

Definition at line 38 of file freMediaControllerBase.txx.

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

Here is the call graph for this function:

template<class TMedia>

virtual const char* FREE::MediaControllerBase< TMedia >::GetNameOfClass ( ) const [inline, virtual]

Reimplemented from FREE::MediaControllerInterface.

Definition at line 52 of file freMediaControllerBase.h.

template<class TMedia>

bool FREE::MediaControllerBase< TMedia >::LoadMedia ( SessionComponentCache * pCache ) const [inline, virtual]

This function loads the media and stored it as component in the cache. The loading behavior depends on the controller (e.g. image media controller will save the media to the path specified in the component setup).

Parameters:

[in,out] pCache Cache containg the component setup most controller need to load the media. The media will be stored as component in the passed cache.

Returns:: Returns if the media was successfully loaded.

Implements FREE::MediaControllerInterface.

Definition at line 69 of file freMediaControllerBase.txx.

template<class TMedia>

unsigned long FREE::MediaControllerBase< TMedia >::GetMediaDimension ( ) const [inline, virtual]

This function returns the dimension of the media controlled by the controller.

Returns:: Returns dimension of the controlled media. A dimension of 0 indicates that media has no dimensionality or that it is arbitrary.

Implements FREE::MediaControllerInterface.

Definition at line 77 of file freMediaControllerBase.txx.

Referenced by FREE::MediaControllerBase< TMedia >::GenerateProfile().

template<class TMedia>

MediaControllerBase< TMedia >::ComponentPointer FREE::MediaControllerBase< TMedia >::BuildMainComponent	(	ComponentSetup *	pComponentSetup,
		SessionComponentCache *	pComponentCache
	)			const `[inline, protected, virtual]`

This function (called by BuildSetup()) creates an object of the controlled class by the use of the passed setup information and initializes other elements in the cache if required.
In a derived class this function should be overridden if a simple instantiation is not sufficient.

Parameters:

`[in]`	pComponentSetup	The setup information for the component that should be build.
`[in,out]`	pComponentCache	Pointer to the component cache associated with the component. The component will be automatically added to the cache by the BuildSetup()

Returns:: Smart pointer to the newly created component. Will be added to the cache.

Reimplemented from FREE::ComponentControllerBase< TMedia >.

Definition at line 59 of file freMediaControllerBase.txx.

References FREE::ComponentControllerBase< TMedia >::BuildMainComponent(), FREE::SessionComponentRepositoryKeys::MediaValidity(), FREE::ValidityTag::NewNull(), and FREE::DirectSessionComponentAccessor::SetRepositoryElement().

Referenced by FREE::PointSetMediaControllerBase< PixelType, 2 >::BuildMainComponent(), and FREE::ParameterListMediaController::BuildMainComponent().

Here is the call graph for this function:

template<class TMedia>

MediaControllerBase< TMedia >::GenericMediaPointer FREE::MediaControllerBase< TMedia >::GetMediaCasted	(	const MediaID &	mediaID,
		ComponentType *	pComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo
	)			const `[inline, protected, virtual]`

Returns the media specified by the MediaID. If the media ID is not handled, an exception will be thrown.
Reimplement this member function to realize special controller behavior. This version is only for establishing a generic interface.

Parameters:

`[in]`	mediaID	ID specifying the wanted media.
`[in]`	pComponent	Pointer to the casted component of the passed cache.
`[in]`	pComponentCache	Pointer to the component cache.
`[in]`	pSessionInfo	Pointer to the session info.

Returns:: Smartpointer to the media.

Remarks:: If media is unknown to controller, an exception will be raised.

Reimplemented from FREE::ComponentControllerBase< TMedia >.

Definition at line 85 of file freMediaControllerBase.txx.

References FREE::SessionComponentCache::Component(), FREE::SessionComponentCache::ComponentIsAssigned(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

template<class TMedia>

void FREE::MediaControllerBase< TMedia >::SetMediaCasted	(	const MediaID &	mediaID,
		GenericMediaType *	pMedia,
		ComponentType *	pComponent,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pSessionInfo
	)			const `[inline, protected, virtual]`

Definition at line 108 of file freMediaControllerBase.txx.

References FREE::ComponentControllerBase< TMedia >::ActualizeMediaValidityTag(), FREE::ComponentControllerBase< TMedia >::SetGenericComponent(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

template<class TMedia>

void FREE::MediaControllerBase< TMedia >::GenerateProfile	(	CtrlProfile::ControllerProfile &	profile,
		const SessionComponentCache *	pComponentCache,
		bool	bRegardOldSetup
	)			const `[inline, 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< TMedia >.

Definition at line 47 of file freMediaControllerBase.txx.

References FREE::DAGet, FREE::ComponentControllerBase< TMedia >::GenerateProfile(), FREE::MediaControllerBase< TMedia >::GetMediaDimension(), and FREE::CtrlProfile::ControllerProfileBase::MediaMap().

Here is the call graph for this function:


Public Types
typedef TMedia	ComponentType
typedef ComponentControllerBase < TMedia >	Superclass
typedef ComponentType::Pointer	ComponentPointer
typedef Superclass::GenericComponentType	GenericComponentType
typedef Superclass::GenericComponentPointer	GenericComponentPointer
typedef Superclass::GenericMediaType	GenericMediaType
typedef Superclass::GenericMediaPointer	GenericMediaPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
	MediaControllerBase ()
virtual bool	LoadMedia (SessionComponentCache *pCache) const
virtual unsigned long	GetMediaDimension () const
Protected Member Functions
virtual ComponentPointer	BuildMainComponent (ComponentSetup pComponentSetup, SessionComponentCache pComponentCache) 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
virtual void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const

FREE::MediaControllerBase< TMedia > Class Template Reference
[Media controller]

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

template<class TMedia>
class FREE::MediaControllerBase< TMedia >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

FREE::MediaControllerBase< TMedia > Class Template Reference [Media controller]

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

template<class TMedia> class FREE::MediaControllerBase< TMedia >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

FREE::MediaControllerBase< TMedia > Class Template Reference
[Media controller]

template<class TMedia>
class FREE::MediaControllerBase< TMedia >