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

template<class TMedia>

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

Definition at line 44 of file freStoreableMediaControllerBase.h.

template<class TMedia>

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

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 45 of file freStoreableMediaControllerBase.h.

template<class TMedia>

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

SmartPointer of the component class

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 47 of file freStoreableMediaControllerBase.h.

template<class TMedia>

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

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 48 of file freStoreableMediaControllerBase.h.

template<class TMedia>

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

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 49 of file freStoreableMediaControllerBase.h.

template<class TMedia>

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

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 50 of file freStoreableMediaControllerBase.h.

template<class TMedia>

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

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 51 of file freStoreableMediaControllerBase.h.

template<class TMedia>

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

Implementation of FREE::StorableMediaControllerBase ////////////////

Definition at line 38 of file freStoreableMediaControllerBase.txx.

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

Here is the call graph for this function:

template<class TMedia>

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

Reimplemented from FREE::MediaControllerBase< TMedia >.

Reimplemented in FREE::PointSetMediaControllerBase< TPixel, VDimension >, FREE::PointSet2DMediaController, FREE::PointSet3DMediaController, FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::RegionImage2DMediaController, FREE::RegionImage3DMediaController, FREE::TransformFieldMediaControllerBase< TVector, VDimension >, FREE::TransformField2DMediaController, FREE::TransformField3DMediaController, FREE::PointSetMediaControllerBase< PixelType, 3 >, FREE::PointSetMediaControllerBase< PixelType, 2 >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::RegionImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 2 >::VectorType, 2 >, and FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >.

Definition at line 53 of file freStoreableMediaControllerBase.h.

template<class TMedia>

bool FREE::StoreableMediaControllerBase< TMedia >::SaveMedia	(	std::string	sMediaPath,
		GenericMediaType *	pMedia
	)			const `[inline, virtual]`

This function saves the media passed. The location is specified by the passed path.

Parameters:

`[in]`	sMediaPath	Path locating the destination of the save operation.
`[in]`	pMedia	Pointer to media.

Returns:: Returns if the media was successfully saved.

Definition at line 59 of file freStoreableMediaControllerBase.txx.

template<class TMedia>

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

This function saves the media passed within the cache as component. The saving behavior depends on the controller (e.g. point set controller will save the media as parameter in the component setup of the cache; image media controller will save the media to the path specified in the component setup).

Parameters:

[in] pCache Cache containg the media to be saved as component. Most controller also need a component setup referenced by the cache.

Returns:: Returns if the media was successfully saved.

Implements FREE::StoreableMediaControllerInterface.

Definition at line 67 of file freStoreableMediaControllerBase.txx.

template<class TMedia>

void FREE::StoreableMediaControllerBase< TMedia >::SetMediaFile	(	const std::string &	sMediaFile,
		SessionComponentCache *	pCache
	)			const `[inline, virtual]`

Implements FREE::StoreableMediaControllerInterface.

Definition at line 75 of file freStoreableMediaControllerBase.txx.

References FREE::ComponentSetup::Parameters(), FREE::ParameterCollection::SetParameterValue(), FREE::SessionComponentCache::Setup(), FREE::SessionComponentCache::SetupIsAssigned(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

template<class TMedia>

std::string FREE::StoreableMediaControllerBase< TMedia >::GetMediaFile ( SessionComponentCache * pCache ) const [inline, virtual]

Implements FREE::StoreableMediaControllerInterface.

Definition at line 86 of file freStoreableMediaControllerBase.txx.

References FREE::ParameterCollection::GetParameterValue(), FREE::ComponentSetup::Parameters(), FREE::SessionComponentCache::Setup(), FREE::SessionComponentCache::SetupIsAssigned(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

template<class TMedia>

void FREE::StoreableMediaControllerBase< TMedia >::SetStatisticEntryMainComponent	(	StatisticEntry &	rStatisticEntry,
		ComponentType *	pMainComponent,
		SessionComponentCache *	pMainComponentCache,
		SessionInfo *	pSessionInfo,
		StatisticDictionary &	rDictionary
	)			const `[inline, protected, virtual]`

This function (called by SetStatisticEntry()) records any statistical information of the passed component In a derived class this function should be overridden to provide a specific behavior.

Parameters:

`[in,out]`	rStatisticEntry	reference to the Statistic object, where the relevant information should be stored.
`[in]`	pMainComponent	Pointer to the casted component. Also available via cache, but already casted for convenience.
`[in]`	pMainComponentCache	Pointer to the component cache.
`[in]`	pSessionInfo	Pointer to the session info
`[in,out]`	rDictionary	Dictionary with information about the stored facts (e.g. Type, Name) The entry in the dictionary should set by the controller if needed.

Reimplemented from FREE::ComponentControllerBase< TMedia >.

Reimplemented in FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, and FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >.

Definition at line 100 of file freStoreableMediaControllerBase.txx.

References FREE::StatisticEntry::AddValue(), FREE::StatisticDictionary::AddValueDefinition(), catchAllNPassMacro, FREE::SessionComponentCache::GetComponentID(), FREE::SessionComponentCache::GetIDPath(), FREE::SessionAccessor::GetParameterValue(), FREE::StatisticValueDefinition::GetRefID(), and FREE::StatisticDictionary::GetValueDefinitionByName().

Here is the call graph for this function:

template<class TMedia>

void FREE::StoreableMediaControllerBase< 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::MediaControllerBase< TMedia >.

Definition at line 47 of file freStoreableMediaControllerBase.txx.

References FREE::ComponentControllerBase< TMedia >::GenerateProfile(), FREE::CtrlProfile::ControllerProfileBase::Parameters(), and FREE::Parameter::PVTString.

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

Here is the call graph for this function:


Public Types
typedef TMedia	ComponentType
typedef MediaControllerBase < 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
	StoreableMediaControllerBase ()
virtual bool	SaveMedia (std::string sMediaPath, GenericMediaType *pMedia) const
virtual bool	SaveMedia (SessionComponentCache *pCache) const
virtual void	SetMediaFile (const std::string &sMediaFile, SessionComponentCache *pCache) const
virtual std::string	GetMediaFile (SessionComponentCache *pCache) const
Protected Member Functions
virtual void	SetStatisticEntryMainComponent (StatisticEntry &rStatisticEntry, ComponentType pMainComponent, SessionComponentCache pMainComponentCache, SessionInfo *pSessionInfo, StatisticDictionary &rDictionary) const
virtual void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const

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

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

template<class TMedia>
class FREE::StoreableMediaControllerBase< TMedia >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

template<class TMedia> class FREE::StoreableMediaControllerBase< TMedia >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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

template<class TMedia>
class FREE::StoreableMediaControllerBase< TMedia >