FREE::ParameterListMediaController

FREE::ParameterListMediaController Class Reference
[Media controller]

Controller for a parameter list. More...

#include <freParameterListMediaController.h>

Inheritance diagram for FREE::ParameterListMediaController:

Inheritance graph
FREE::StoreableMediaControllerBase\< FREE::ParameterListIO \>FREE::MediaControllerBase\< TMedia \>FREE::ComponentControllerBase\< TMedia \>FREE::ComponentControllerInterfaceFREE::MediaControllerInterfaceFREE::StoreableMediaControllerInterface
[legend]
Collaboration diagram for FREE::ParameterListMediaController:

Collaboration graph
FREE::StoreableMediaControllerBase\< FREE::ParameterListIO \>FREE::MediaControllerBase\< TMedia \>FREE::ComponentControllerBase\< TMedia \>FREE::ComponentControllerInterfaceFREE::CtrlProfile::ProfileInheritanceFREE::XMLStringMultiMapFREE::XMLStreamObjectFREE::MediaControllerInterfaceFREE::StoreableMediaControllerInterface
[legend]

List of all members.

Public Types

typedef ParameterListIO ComponentType
typedef
StoreableMediaControllerBase
< ComponentType > 		Superclass
typedef
Superclass::ComponentPointer 		ComponentPointer
typedef
Superclass::GenericComponentType 		GenericComponentType
typedef
Superclass::GenericComponentPointer 		GenericComponentPointer
typedef
Superclass::GenericMediaPointer 		GenericMediaPointer

Public Member Functions

 itkTypeMacro (ParameterListMediaController, StoreableMediaControllerBase)
 DeclareParameterMacro (ReadMode)
 DeclareParameterMacro (ParameterLink)
 ParameterListMediaController ()
virtual ~ParameterListMediaController ()
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
ValidityTag::Pointer 		GetMediaValidityTagRequirement (const MediaID &mediaID, 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

Detailed Description

Controller for a parameter list.

Definition at line 37 of file freParameterListMediaController.h.

Member Typedef Documentation

typedef ParameterListIO FREE::ParameterListMediaController::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 >.

Definition at line 40 of file freParameterListMediaController.h.

typedef StoreableMediaControllerBase<ComponentType> FREE::ParameterListMediaController::Superclass

Reimplemented from FREE::StoreableMediaControllerBase< TMedia >.

Definition at line 41 of file freParameterListMediaController.h.

typedef Superclass::ComponentPointer FREE::ParameterListMediaController::ComponentPointer

SmartPointer of the component class

Reimplemented from FREE::StoreableMediaControllerBase< TMedia >.

Definition at line 42 of file freParameterListMediaController.h.

typedef Superclass::GenericComponentType FREE::ParameterListMediaController::GenericComponentType

Reimplemented from FREE::StoreableMediaControllerBase< TMedia >.

Definition at line 43 of file freParameterListMediaController.h.

typedef Superclass::GenericComponentPointer FREE::ParameterListMediaController::GenericComponentPointer

Reimplemented from FREE::StoreableMediaControllerBase< TMedia >.

Definition at line 44 of file freParameterListMediaController.h.

typedef Superclass::GenericMediaPointer FREE::ParameterListMediaController::GenericMediaPointer

Reimplemented from FREE::StoreableMediaControllerBase< TMedia >.

Definition at line 45 of file freParameterListMediaController.h.

Constructor & Destructor Documentation

FREE::ParameterListMediaController::ParameterListMediaController (  ) 

Definition at line 36 of file freParameterListMediaController.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

FREE::ParameterListMediaController::~ParameterListMediaController (  )  [virtual]

Definition at line 44 of file freParameterListMediaController.cxx.

Member Function Documentation

FREE::ParameterListMediaController::itkTypeMacro ( ParameterListMediaController  ,
StoreableMediaControllerBase   
)

FREE::ParameterListMediaController::DeclareParameterMacro ( ReadMode   ) 

FREE::ParameterListMediaController::DeclareParameterMacro ( ParameterLink   ) 

ParameterListMediaController::GenericMediaPointer FREE::ParameterListMediaController::ComputeActualizedMedia ( GenericMediaType *  pGenericMedia,
GenericMediaType *  pGenericTransformationField 
) const [virtual]

Definition at line 50 of file freParameterListMediaController.cxx.

ParameterListMediaController::GenericMediaPointer FREE::ParameterListMediaController::ComputeActualizedMediaByFunction ( GenericMediaType *  pGenericMedia,
GenericMediaType *  pGenericTransformationFunction 
) const [virtual]

Definition at line 59 of file freParameterListMediaController.cxx.

bool FREE::ParameterListMediaController::SaveMedia ( std::string  sMediaPath,
GenericMediaType *  pMedia 
) const [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 68 of file freParameterListMediaController.cxx.

bool FREE::ParameterListMediaController::SaveMedia ( SessionComponentCache *  pCache  )  const [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 77 of file freParameterListMediaController.cxx.

References FREE::SessionComponentCache::Component(), FREE::SessionComponentCache::ComponentIsAssigned(), FREE::ParameterCollection::GetParameter(), FREE::Parameter::GetParameterName(), FREE::Parameter::GetParameterValue(), FREE::ParameterCollection::GetParameterValue(), FREE::ComponentSetup::Parameters(), FREE::SessionComponentCache::Setup(), FREE::SessionComponentCache::SetupIsAssigned(), FREE::ParameterCollection::Size(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

FREE::SessionComponentCache::ComponentFREE::SessionComponentCache::ComponentIsAssignedFREE::ParameterCollection::GetParameterFREE::Parameter::GetParameterNameFREE::Parameter::GetParameterValueFREE::ParameterCollection::GetParameterValueFREE::ComponentSetup::ParametersFREE::SessionComponentCache::SetupFREE::SessionComponentCache::SetupIsAssignedFREE::ParameterCollection::SizeFREE::SessionComponentCache::ControllerIsAssignedFREE::ComponentControllerInterface::GetGenericComponentFREE::ParameterCollection::GetParameterIndexFREE::Parameter::LayerCount

bool FREE::ParameterListMediaController::LoadMedia ( SessionComponentCache *  pCache  )  const [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 111 of file freParameterListMediaController.cxx.

References FREE::SessionComponentCache::Component(), FREE::SessionComponentCache::ComponentIsAssigned(), FREE::ParameterCollection::GetParameter(), FREE::Parameter::GetParameterName(), FREE::Parameter::GetParameterValue(), FREE::ParameterCollection::GetParameterValue(), FREE::ComponentControllerBase< TMedia >::NotifyProgress(), FREE::ComponentSetup::Parameters(), FREE::SessionComponentCache::Setup(), FREE::SessionComponentCache::SetupIsAssigned(), FREE::ParameterCollection::Size(), and throwCtrlExceptionMacro.

Referenced by BuildMainComponent().

Here is the call graph for this function:

FREE::SessionComponentCache::ComponentFREE::SessionComponentCache::ComponentIsAssignedFREE::ParameterCollection::GetParameterFREE::Parameter::GetParameterNameFREE::Parameter::GetParameterValueFREE::ParameterCollection::GetParameterValueFREE::ComponentControllerBase\< TMedia \>::NotifyProgressFREE::ComponentSetup::ParametersFREE::SessionComponentCache::SetupFREE::SessionComponentCache::SetupIsAssignedFREE::ParameterCollection::SizeFREE::SessionComponentCache::ControllerIsAssignedFREE::ComponentControllerInterface::GetGenericComponentFREE::ParameterCollection::GetParameterIndexFREE::Parameter::LayerCount

unsigned long FREE::ParameterListMediaController::GetMediaDimension (  )  const [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 147 of file freParameterListMediaController.cxx.

ValidityTag::Pointer FREE::ParameterListMediaController::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< TMedia >.

Definition at line 187 of file freParameterListMediaController.cxx.

References FREE::ComponentControllerBase< TMedia >::GetMediaValidityTagRequirement(), and FREE::ValidityTag::New().

Here is the call graph for this function:

FREE::ComponentControllerBase\< TMedia \>::GetMediaValidityTagRequirementFREE::ValidityTag::New

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

Definition at line 154 of file freParameterListMediaController.cxx.

References FREE::StoreableMediaControllerBase< TMedia >::GenerateProfile(), FREE::CtrlProfile::ControllerProfileBase::Parameters(), FREE::Parameter::PVTBool, and FREE::Parameter::PVTIDPath.

Here is the call graph for this function:

FREE::StoreableMediaControllerBase::GenerateProfileFREE::CtrlProfile::ControllerProfileBase::ParametersFREE::ComponentControllerBase\< TMedia \>::GenerateProfile

ParameterListMediaController::ComponentPointer FREE::ParameterListMediaController::BuildMainComponent ( ComponentSetup *  pComponentSetup,
SessionComponentCache *  pComponentCache 
) const [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 169 of file freParameterListMediaController.cxx.

References FREE::MediaControllerBase< TMedia >::BuildMainComponent(), FREE::ParameterCollection::GetParameterValue(), LoadMedia(), FREE::ComponentSetup::Parameters(), FREE::SessionComponentCache::Setup(), and throwCtrlExceptionMacro.

Here is the call graph for this function:

FREE::MediaControllerBase::BuildMainComponentFREE::ParameterCollection::GetParameterValueFREE::ParameterListMediaController::LoadMediaFREE::ComponentSetup::ParametersFREE::SessionComponentCache::SetupFREE::ComponentControllerBase\< TMedia \>::BuildMainComponentFREE::SessionComponentRepositoryKeys::MediaValidityFREE::ValidityTag::NewNullFREE::DirectSessionComponentAccessor::SetRepositoryElementFREE::ValidityTag::NewFREE::ParameterCollection::GetParameterIndexFREE::SessionComponentCache::ComponentFREE::SessionComponentCache::ComponentIsAssignedFREE::ParameterCollection::GetParameterFREE::Parameter::GetParameterNameFREE::Parameter::GetParameterValueFREE::ComponentControllerBase\< TMedia \>::NotifyProgressFREE::SessionComponentCache::SetupIsAssignedFREE::ParameterCollection::SizeFREE::SessionComponentCache::ControllerIsAssignedFREE::ComponentControllerInterface::GetGenericComponentFREE::Parameter::LayerCount

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