FREE::StoreableMediaControllerInterface

FREE::StoreableMediaControllerInterface Class Reference
[Media controller]

Interface for storage related methods of controllers based on StoreableMediaController. More...

#include <freStoreableMediaControllerInterface.h>

Inheritance diagram for FREE::StoreableMediaControllerInterface:

Inheritance graph
FREE::StoreableMediaControllerBase\< TMedia \>FREE::StoreableMediaControllerBase\< FREE::ParameterListIO \>FREE::StoreableMediaControllerBase\< itk::Image\< float, VDimension \> \>FREE::StoreableMediaControllerBase\< itk::Image\< FREE::FREE::FREE::ImageTypes\< 2 \>::VectorType, VDimension \> \>FREE::StoreableMediaControllerBase\< itk::Image\< FREE::FREE::FREE::ImageTypes\< 3 \>::VectorType, VDimension \> \>FREE::StoreableMediaControllerBase\< itk::Image\< TInternalPixel, VDimension \> \>FREE::StoreableMediaControllerBase\< itk::Image\< TVector, VDimension \> \>FREE::StoreableMediaControllerBase\< itk::PointSet\< float, VDimension, itk::DefaultStaticMeshTraits\< float, VDimension, VDimension, double \> \> \>FREE::StoreableMediaControllerBase\< itk::PointSet\< TPixel, VDimension, itk::DefaultStaticMeshTraits\< TPixel, VDimension, VDimension, double \> \> \>FREE::StoreableMediaControllerBase\< TImage \>FREE::ImageMediaControllerBase\< itk::Image\< FREE::FREE::ImageTypes\< 2 \>::VectorType, VDimension \> \>FREE::ImageMediaControllerBase\< itk::Image\< FREE::FREE::ImageTypes\< 3 \>::VectorType, VDimension \> \>FREE::ParameterListMediaController\< FREE::ParameterListIO \>FREE::PointSetMediaControllerBase\< itk::PointSet\< TPixel, VDimension, itk::DefaultStaticMeshTraits\< TPixel, VDimension, VDimension, double \> \> \>FREE::PointSetMediaControllerBase\< PixelType, 2 \>FREE::PointSetMediaControllerBase\< PixelType, 3 \>FREE::PointSet2DMediaController\< PixelType, 2 \>FREE::PointSet3DMediaController\< PixelType, 3 \>FREE::ImageMediaControllerBase\< itk::Image\< float, VDimension \> \>FREE::IntensityImageMediaControllerBase\< float, unsigned short, VDimension \>FREE::ImageMediaControllerBase\< itk::Image\< TInternalPixel, VDimension \> \>FREE::IntensityImageMediaControllerBase\< TInternalPixel, TExternalPixel, VDimension \>FREE::CharImage2DMediaController\< PixelType, char, 2 \>FREE::CharImage3DMediaController\< PixelType, char, 3 \>FREE::IntensityImage2DMediaController\< PixelType, unsigned short, 2 \>FREE::IntensityImage3DMediaController\< PixelType, unsigned short, 3 \>FREE::RegionImageMediaControllerBase\< TInternalPixel, TExternalPixel, VDimension \>FREE::RegionImageMediaControllerBase\< PixelType, unsigned short, 2 \>FREE::RegionImageMediaControllerBase\< PixelType, unsigned short, 3 \>FREE::ShortImage2DMediaController\< PixelType, short, 2 \>FREE::ShortImage3DMediaController\< PixelType, short, 3 \>FREE::UnsignedCharImage2DMediaController\< PixelType, unsigned char, 2 \>FREE::UnsignedCharImage3DMediaController\< PixelType, unsigned char, 3 \>FREE::UnsignedShortImage2DMediaController\< PixelType, unsigned short, 2 \>FREE::UnsignedShortImage3DMediaController\< PixelType, unsigned short, 3 \>FREE::ImageMediaControllerBase\< itk::Image\< TVector, VDimension \> \>FREE::TransformFieldMediaControllerBase\< TVector, VDimension \>FREE::ImageMediaControllerBase\< TImage \>FREE::IntensityImageMediaControllerBase\< PixelType, char, 2 \>FREE::IntensityImageMediaControllerBase\< PixelType, char, 3 \>FREE::IntensityImageMediaControllerBase\< PixelType, short, 2 \>FREE::IntensityImageMediaControllerBase\< PixelType, short, 3 \>FREE::IntensityImageMediaControllerBase\< PixelType, unsigned char, 2 \>FREE::IntensityImageMediaControllerBase\< PixelType, unsigned char, 3 \>FREE::IntensityImageMediaControllerBase\< PixelType, unsigned short, 2 \>FREE::IntensityImageMediaControllerBase\< PixelType, unsigned short, 3 \>FREE::TransformFieldMediaControllerBase\< FREE::ImageTypes\< 2 \>::VectorType, 2 \>FREE::TransformFieldMediaControllerBase\< FREE::ImageTypes\< 3 \>::VectorType, 3 \>
[legend]

List of all members.

Public Types

typedef
MediaControllerInterface::GenericComponentType 		GenericComponentType
typedef
MediaControllerInterface::GenericComponentPointer 		GenericComponentPointer
typedef
MediaControllerInterface::GenericMediaPointer 		GenericMediaPointer

Public Member Functions

virtual const char * GetNameOfClass () const
 DeclareParameterMacro (MediaFile)
virtual void SetMediaFile (const std::string &sMediaFile, SessionComponentCache *pCache) const =0
virtual std::string GetMediaFile (SessionComponentCache *pCache) const =0
virtual bool SaveMedia (std::string sMediaPath, GenericMediaType *pMedia) const =0
virtual bool SaveMedia (SessionComponentCache *pCache) const =0

Detailed Description

Interface for storage related methods of controllers based on StoreableMediaController.

Definition at line 36 of file freStoreableMediaControllerInterface.h.

Member Typedef Documentation

typedef MediaControllerInterface::GenericComponentType FREE::StoreableMediaControllerInterface::GenericComponentType

Reimplemented in FREE::ImageMediaControllerBase< TImage >, FREE::ParameterListMediaController, FREE::PointSetMediaControllerBase< TPixel, VDimension >, FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::TransformFieldMediaControllerBase< TVector, VDimension >, FREE::StoreableMediaControllerBase< TMedia >, FREE::ImageMediaControllerBase< itk::Image< TInternalPixel, VDimension > >, FREE::ImageMediaControllerBase< itk::Image< FREE::FREE::ImageTypes< 3 >::VectorType, VDimension > >, FREE::ImageMediaControllerBase< itk::Image< FREE::FREE::ImageTypes< 2 >::VectorType, VDimension > >, FREE::ImageMediaControllerBase< itk::Image< TVector, VDimension > >, FREE::ImageMediaControllerBase< itk::Image< float, VDimension > >, 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 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >, FREE::StoreableMediaControllerBase< itk::Image< TInternalPixel, VDimension > >, FREE::StoreableMediaControllerBase< TImage >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 2 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< FREE::ParameterListIO >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 3 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< TPixel, VDimension, itk::DefaultStaticMeshTraits< TPixel, VDimension, VDimension, double > > >, FREE::StoreableMediaControllerBase< itk::Image< TVector, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< float, VDimension, itk::DefaultStaticMeshTraits< float, VDimension, VDimension, double > > >, and FREE::StoreableMediaControllerBase< itk::Image< float, VDimension > >.

Definition at line 40 of file freStoreableMediaControllerInterface.h.

typedef MediaControllerInterface::GenericComponentPointer FREE::StoreableMediaControllerInterface::GenericComponentPointer

Reimplemented in FREE::ImageMediaControllerBase< TImage >, FREE::ParameterListMediaController, FREE::PointSetMediaControllerBase< TPixel, VDimension >, FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::TransformFieldMediaControllerBase< TVector, VDimension >, FREE::StoreableMediaControllerBase< TMedia >, FREE::ImageMediaControllerBase< itk::Image< TInternalPixel, VDimension > >, FREE::ImageMediaControllerBase< itk::Image< FREE::FREE::ImageTypes< 3 >::VectorType, VDimension > >, FREE::ImageMediaControllerBase< itk::Image< FREE::FREE::ImageTypes< 2 >::VectorType, VDimension > >, FREE::ImageMediaControllerBase< itk::Image< TVector, VDimension > >, FREE::ImageMediaControllerBase< itk::Image< float, VDimension > >, 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 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >, FREE::StoreableMediaControllerBase< itk::Image< TInternalPixel, VDimension > >, FREE::StoreableMediaControllerBase< TImage >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 2 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< FREE::ParameterListIO >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 3 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< TPixel, VDimension, itk::DefaultStaticMeshTraits< TPixel, VDimension, VDimension, double > > >, FREE::StoreableMediaControllerBase< itk::Image< TVector, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< float, VDimension, itk::DefaultStaticMeshTraits< float, VDimension, VDimension, double > > >, and FREE::StoreableMediaControllerBase< itk::Image< float, VDimension > >.

Definition at line 41 of file freStoreableMediaControllerInterface.h.

typedef MediaControllerInterface::GenericMediaPointer FREE::StoreableMediaControllerInterface::GenericMediaPointer

Reimplemented in FREE::ImageMediaControllerBase< TImage >, FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::ParameterListMediaController, FREE::PointSetMediaControllerBase< TPixel, VDimension >, FREE::RegionImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::TransformFieldMediaControllerBase< TVector, VDimension >, FREE::StoreableMediaControllerBase< TMedia >, FREE::ImageMediaControllerBase< itk::Image< TInternalPixel, VDimension > >, FREE::ImageMediaControllerBase< itk::Image< FREE::FREE::ImageTypes< 3 >::VectorType, VDimension > >, FREE::ImageMediaControllerBase< itk::Image< FREE::FREE::ImageTypes< 2 >::VectorType, VDimension > >, FREE::ImageMediaControllerBase< itk::Image< TVector, VDimension > >, FREE::ImageMediaControllerBase< itk::Image< float, VDimension > >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 2 >, FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >, 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 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >, FREE::StoreableMediaControllerBase< itk::Image< TInternalPixel, VDimension > >, FREE::StoreableMediaControllerBase< TImage >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 2 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< FREE::ParameterListIO >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 3 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< TPixel, VDimension, itk::DefaultStaticMeshTraits< TPixel, VDimension, VDimension, double > > >, FREE::StoreableMediaControllerBase< itk::Image< TVector, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< float, VDimension, itk::DefaultStaticMeshTraits< float, VDimension, VDimension, double > > >, and FREE::StoreableMediaControllerBase< itk::Image< float, VDimension > >.

Definition at line 42 of file freStoreableMediaControllerInterface.h.

Member Function Documentation

virtual const char* FREE::StoreableMediaControllerInterface::GetNameOfClass (  )  const [inline, virtual]

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::StoreableMediaControllerBase< TMedia >, 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 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >, FREE::StoreableMediaControllerBase< itk::Image< TInternalPixel, VDimension > >, FREE::StoreableMediaControllerBase< TImage >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 2 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< FREE::ParameterListIO >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 3 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< TPixel, VDimension, itk::DefaultStaticMeshTraits< TPixel, VDimension, VDimension, double > > >, FREE::StoreableMediaControllerBase< itk::Image< TVector, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< float, VDimension, itk::DefaultStaticMeshTraits< float, VDimension, VDimension, double > > >, and FREE::StoreableMediaControllerBase< itk::Image< float, VDimension > >.

Definition at line 44 of file freStoreableMediaControllerInterface.h.

FREE::StoreableMediaControllerInterface::DeclareParameterMacro ( MediaFile   ) 

virtual void FREE::StoreableMediaControllerInterface::SetMediaFile ( const std::string &  sMediaFile,
SessionComponentCache *  pCache 
) const [pure virtual]

Implemented in FREE::StoreableMediaControllerBase< TMedia >, FREE::StoreableMediaControllerBase< itk::Image< TInternalPixel, VDimension > >, FREE::StoreableMediaControllerBase< TImage >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 2 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< FREE::ParameterListIO >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 3 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< TPixel, VDimension, itk::DefaultStaticMeshTraits< TPixel, VDimension, VDimension, double > > >, FREE::StoreableMediaControllerBase< itk::Image< TVector, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< float, VDimension, itk::DefaultStaticMeshTraits< float, VDimension, VDimension, double > > >, and FREE::StoreableMediaControllerBase< itk::Image< float, VDimension > >.

virtual std::string FREE::StoreableMediaControllerInterface::GetMediaFile ( SessionComponentCache *  pCache  )  const [pure virtual]

Implemented in FREE::StoreableMediaControllerBase< TMedia >, FREE::StoreableMediaControllerBase< itk::Image< TInternalPixel, VDimension > >, FREE::StoreableMediaControllerBase< TImage >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 2 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< FREE::ParameterListIO >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 3 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< TPixel, VDimension, itk::DefaultStaticMeshTraits< TPixel, VDimension, VDimension, double > > >, FREE::StoreableMediaControllerBase< itk::Image< TVector, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< float, VDimension, itk::DefaultStaticMeshTraits< float, VDimension, VDimension, double > > >, and FREE::StoreableMediaControllerBase< itk::Image< float, VDimension > >.

virtual bool FREE::StoreableMediaControllerInterface::SaveMedia ( std::string  sMediaPath,
GenericMediaType *  pMedia 
) const [pure 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.

Implemented in FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::ParameterListMediaController, FREE::PointSetMediaControllerBase< TPixel, VDimension >, FREE::TransformFieldMediaControllerBase< TVector, VDimension >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 2 >, FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >, FREE::PointSetMediaControllerBase< PixelType, 3 >, FREE::PointSetMediaControllerBase< PixelType, 2 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 2 >::VectorType, 2 >, and FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >.

Referenced by FREE::MediaDrainController::SetMediaCasted().

virtual bool FREE::StoreableMediaControllerInterface::SaveMedia ( SessionComponentCache *  pCache  )  const [pure 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.

Implemented in FREE::IntensityImageMediaControllerBase< TInternalPixel, TExternalPixel, VDimension >, FREE::ParameterListMediaController, FREE::PointSetMediaControllerBase< TPixel, VDimension >, FREE::TransformFieldMediaControllerBase< TVector, VDimension >, FREE::StoreableMediaControllerBase< TMedia >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 2 >, FREE::IntensityImageMediaControllerBase< PixelType, short, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 3 >, FREE::IntensityImageMediaControllerBase< PixelType, unsigned char, 2 >, FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >, FREE::PointSetMediaControllerBase< PixelType, 3 >, FREE::PointSetMediaControllerBase< PixelType, 2 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 2 >::VectorType, 2 >, FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >, FREE::StoreableMediaControllerBase< itk::Image< TInternalPixel, VDimension > >, FREE::StoreableMediaControllerBase< TImage >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 2 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< FREE::ParameterListIO >, FREE::StoreableMediaControllerBase< itk::Image< FREE::FREE::FREE::ImageTypes< 3 >::VectorType, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< TPixel, VDimension, itk::DefaultStaticMeshTraits< TPixel, VDimension, VDimension, double > > >, FREE::StoreableMediaControllerBase< itk::Image< TVector, VDimension > >, FREE::StoreableMediaControllerBase< itk::PointSet< float, VDimension, itk::DefaultStaticMeshTraits< float, VDimension, VDimension, double > > >, and FREE::StoreableMediaControllerBase< itk::Image< float, VDimension > >.

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