FREE::PointSetMediaControllerBase< TPixel, VDimension > Class Template Reference
[Media controller]

Base class for point set media. More...

#include <frePointSetMediaController.h>

Inheritance diagram for FREE::PointSetMediaControllerBase< TPixel, VDimension >:

[legend]

Collaboration diagram for FREE::PointSetMediaControllerBase< TPixel, VDimension >:

[legend]

List of all members.

Public Types
typedef itk::PointSet < TPixel, VDimension, itk::DefaultStaticMeshTraits < TPixel, VDimension, VDimension, ScalarType > >	ComponentType
typedef ComponentType	ImageType
typedef StoreableMediaControllerBase < ComponentType >	Superclass
typedef Superclass::ComponentPointer	ComponentPointer
typedef Superclass::GenericComponentType	GenericComponentType
typedef Superclass::GenericComponentPointer	GenericComponentPointer
typedef Superclass::GenericMediaPointer	GenericMediaPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
	DeclareParameterMacro (Points)
	DeclareParameterMacro (Values)
	DeclareParameterMacro (PointsSource)
	PointSetMediaControllerBase ()
virtual	~PointSetMediaControllerBase ()
virtual GenericMediaPointer	ComputeActualizedMedia (GenericMediaType *pGenericMedia, GenericMediaType *pGenericTransformationField) const
virtual GenericMediaPointer	ComputeActualizedMediaByFunction (GenericMediaType *pGenericMedia, GenericMediaType *pGenericTransformationFunction) const
virtual bool	SaveMedia (std::string sMediaPath, GenericMediaType *pMedia) const
virtual bool	SaveMedia (SessionComponentCache *pCache) const
virtual bool	LoadMedia (SessionComponentCache *pCache) const
virtual unsigned long	GetMediaDimension () const
virtual ComponentPointer	GetComponent (const SessionComponentCache *pComponentCache) const
Protected Member Functions
virtual void	GenerateProfile (CtrlProfile::ControllerProfile &profile, const SessionComponentCache *pComponentCache, bool bRegardOldSetup) const
virtual ComponentPointer	BuildMainComponent (ComponentSetup *pComponentSetup, SessionComponentCache *pComponentCache) const
virtual void	LoadSetFromSetup (ComponentSetup &rSetup, ComponentType &rSet) const
virtual void	SaveSetToSetup (ComponentSetup &pSetup, ComponentType &rSet) const

---

Detailed Description

template<class TPixel, unsigned int VDimension>
class FREE::PointSetMediaControllerBase< TPixel, VDimension >

Base class for point set media.

Definition at line 43 of file frePointSetMediaController.h.

---

Member Typedef Documentation

template<class TPixel, unsigned int VDimension>

typedef itk::PointSet< TPixel, VDimension, itk::DefaultStaticMeshTraits<TPixel, VDimension, VDimension, ScalarType> > FREE::PointSetMediaControllerBase< TPixel, VDimension >::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::StoreableMediaControllerBase< TMedia >.

Reimplemented in FREE::PointSet2DMediaController, and FREE::PointSet3DMediaController.

Definition at line 46 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

typedef ComponentType FREE::PointSetMediaControllerBase< TPixel, VDimension >::ImageType

Definition at line 47 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

typedef StoreableMediaControllerBase<ComponentType> FREE::PointSetMediaControllerBase< TPixel, VDimension >::Superclass

Reimplemented from FREE::StoreableMediaControllerBase< TMedia >.

Reimplemented in FREE::PointSet2DMediaController, and FREE::PointSet3DMediaController.

Definition at line 48 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

typedef Superclass::ComponentPointer FREE::PointSetMediaControllerBase< TPixel, VDimension >::ComponentPointer

SmartPointer of the component class

Reimplemented from FREE::StoreableMediaControllerBase< TMedia >.

Definition at line 49 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

typedef Superclass::GenericComponentType FREE::PointSetMediaControllerBase< TPixel, VDimension >::GenericComponentType

Reimplemented from FREE::StoreableMediaControllerBase< TMedia >.

Definition at line 50 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

typedef Superclass::GenericComponentPointer FREE::PointSetMediaControllerBase< TPixel, VDimension >::GenericComponentPointer

Reimplemented from FREE::StoreableMediaControllerBase< TMedia >.

Definition at line 51 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

typedef Superclass::GenericMediaPointer FREE::PointSetMediaControllerBase< TPixel, VDimension >::GenericMediaPointer

Reimplemented from FREE::StoreableMediaControllerBase< TMedia >.

Definition at line 52 of file frePointSetMediaController.h.

---

Constructor & Destructor Documentation

template<class TPixel, unsigned int VDimension>

FREE::PointSetMediaControllerBase< TPixel, VDimension >::PointSetMediaControllerBase

(

)

[inline]

Definition at line 60 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

virtual FREE::PointSetMediaControllerBase< TPixel, VDimension >::~PointSetMediaControllerBase

(

)

[inline, virtual]

Definition at line 67 of file frePointSetMediaController.h.

---

Member Function Documentation

template<class TPixel, unsigned int VDimension>

virtual const char* FREE::PointSetMediaControllerBase< TPixel, VDimension >::GetNameOfClass

(

)

const [inline, virtual]

Reimplemented from FREE::StoreableMediaControllerBase< TMedia >.

Reimplemented in FREE::PointSet2DMediaController, and FREE::PointSet3DMediaController.

Definition at line 54 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

FREE::PointSetMediaControllerBase< TPixel, VDimension >::DeclareParameterMacro

(

Points

)

template<class TPixel, unsigned int VDimension>

FREE::PointSetMediaControllerBase< TPixel, VDimension >::DeclareParameterMacro

(

Values

)

template<class TPixel, unsigned int VDimension>

FREE::PointSetMediaControllerBase< TPixel, VDimension >::DeclareParameterMacro

(

PointsSource

)

template<class TPixel, unsigned int VDimension>

virtual GenericMediaPointer FREE::PointSetMediaControllerBase< TPixel, VDimension >::ComputeActualizedMedia	(	GenericMediaType *	pGenericMedia,
		GenericMediaType *	pGenericTransformationField
	)			const [inline, virtual]

Definition at line 71 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

virtual GenericMediaPointer FREE::PointSetMediaControllerBase< TPixel, VDimension >::ComputeActualizedMediaByFunction	(	GenericMediaType *	pGenericMedia,
		GenericMediaType *	pGenericTransformationFunction
	)			const [inline, virtual]

Definition at line 118 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

virtual bool FREE::PointSetMediaControllerBase< TPixel, VDimension >::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.

Implements FREE::StoreableMediaControllerInterface.

Definition at line 158 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

virtual bool FREE::PointSetMediaControllerBase< TPixel, VDimension >::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.

Reimplemented from FREE::StoreableMediaControllerBase< TMedia >.

Definition at line 175 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

virtual bool FREE::PointSetMediaControllerBase< TPixel, VDimension >::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.

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 220 of file frePointSetMediaController.h.

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

template<class TPixel, unsigned int VDimension>

virtual unsigned long FREE::PointSetMediaControllerBase< TPixel, VDimension >::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.

Reimplemented from FREE::MediaControllerBase< TMedia >.

Definition at line 271 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

virtual ComponentPointer FREE::PointSetMediaControllerBase< TPixel, VDimension >::GetComponent

(

const SessionComponentCache *

pComponentCache

)

const [inline, virtual]

Returns the component managed by the controller and stored in the cache. Reimplement GetComponent() to realize special controller behavior. This version only accesses the component in the cache and returns the pointer.

Parameters:

[in]

pComponentCache

Pointer to the component cache.

Returns:

Smartpointer to the component.

Reimplemented from FREE::ComponentControllerBase< TMedia >.

Definition at line 276 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

virtual void FREE::PointSetMediaControllerBase< TPixel, VDimension >::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::StoreableMediaControllerBase< TMedia >.

Definition at line 318 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

virtual ComponentPointer FREE::PointSetMediaControllerBase< TPixel, VDimension >::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::MediaControllerBase< TMedia >.

Definition at line 330 of file frePointSetMediaController.h.

template<class TPixel, unsigned int VDimension>

virtual void FREE::PointSetMediaControllerBase< TPixel, VDimension >::LoadSetFromSetup	(	ComponentSetup &	rSetup,
		ComponentType &	rSet
	)			const [inline, protected, virtual]

Definition at line 364 of file frePointSetMediaController.h.

Referenced by FREE::PointSetMediaControllerBase< PixelType, 2 >::LoadMedia().

template<class TPixel, unsigned int VDimension>

virtual void FREE::PointSetMediaControllerBase< TPixel, VDimension >::SaveSetToSetup	(	ComponentSetup &	pSetup,
		ComponentType &	rSet
	)			const [inline, protected, virtual]

Definition at line 388 of file frePointSetMediaController.h.

Referenced by FREE::PointSetMediaControllerBase< PixelType, 2 >::SaveMedia().

---

The documentation for this class was generated from the following file:

• frePointSetMediaController.h

---