FREE::CtrlProfile::Media

FREE::CtrlProfile::Media Class Reference
[Controller profile]

Class providing the possibility to store and retrieve characteristics of streams... More...

#include <freProfileMedia.h>

Inheritance diagram for FREE::CtrlProfile::Media:

Inheritance graph
FREE::XMLStreamObject
[legend]
Collaboration diagram for FREE::CtrlProfile::Media:

Collaboration graph
FREE::XMLStreamObject
[legend]

List of all members.

Public Types

typedef Media Self
typedef XMLStreamObject Superclass
typedef
itk::SmartPointer
< Self > 		Pointer
typedef
itk::SmartPointer
< const Self > 		ConstPointer
typedef
MediaDomainDimensionType 		DimensionType

Public Member Functions

virtual const char * GetNameOfClass () const
virtual
::itk::LightObject::Pointer 		CreateAnother (void) const
void SetName (const std::string &sName)
std::string GetName () const
void SetAccess (const DataAccessType &da)
DataAccessType GetAccess () const
void SetDimension (DimensionType dimension)
DimensionType GetDimension () const
void SetDataType (const std::string &typeID)
const std::string & GetDataType () const
void SetInternal (bool bInternal)
bool GetInternal () const
void SetIsTemplate (bool bTemplate)
bool GetIsTemplate () const
void SetGroup (unsigned int iGroup)
unsigned int GetGroup () const
virtual void Reset ()
virtual Media & operator= (const Media &Media)

Static Public Member Functions

static Pointer New (void)

Static Public Attributes

static const
DimensionType 		DT_AllDimensions = cMDDAny

Protected Member Functions

 Media ()
virtual ~Media ()
virtual void AttributesLoadProcessing (const AttributesType &rAttributes)
virtual void SaveAttributes (AttributesSaveListType &rAttributes) const

Protected Attributes

std::string m_Name
DataAccessType m_Access
DimensionType m_Dimension
std::string m_MediaType
bool m_bInternal
bool m_bTemplate
unsigned int m_iGroup

Private Member Functions

 Media (const Media &Media)

Detailed Description

Class providing the possibility to store and retrieve characteristics of streams...

Parameter is used to store all characteristic information about a stream within the component profile.

Definition at line 43 of file freProfileMedia.h.

Member Typedef Documentation

typedef Media FREE::CtrlProfile::Media::Self

Definition at line 46 of file freProfileMedia.h.

typedef XMLStreamObject FREE::CtrlProfile::Media::Superclass

Definition at line 47 of file freProfileMedia.h.

typedef itk::SmartPointer<Self> FREE::CtrlProfile::Media::Pointer

Definition at line 48 of file freProfileMedia.h.

typedef itk::SmartPointer<const Self> FREE::CtrlProfile::Media::ConstPointer

Definition at line 49 of file freProfileMedia.h.

typedef MediaDomainDimensionType FREE::CtrlProfile::Media::DimensionType

Definition at line 53 of file freProfileMedia.h.

Constructor & Destructor Documentation

FREE::CtrlProfile::Media::Media (  )  [protected]

Definition at line 53 of file freProfileMedia.cxx.

References Reset().

Here is the call graph for this function:

FREE::CtrlProfile::Media::ResetFREE::XMLStreamObject::Reset

FREE::CtrlProfile::Media::~Media (  )  [protected, virtual]

Definition at line 59 of file freProfileMedia.cxx.

FREE::CtrlProfile::Media::Media ( const Media &  Media  )  [private]

suppresses default copy constructor

Member Function Documentation

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

Reimplemented from FREE::XMLStreamObject.

Definition at line 51 of file freProfileMedia.h.

static Pointer FREE::CtrlProfile::Media::New ( void   )  [inline, static]

Definition at line 53 of file freProfileMedia.h.

Referenced by FREE::CtrlProfile::ProfileMediaMap::AddMedia(), FREE::ComponentControllerBase< TControlledComponent >::GenerateProfileTemplateRealization(), and FREE::CtrlProfile::ProfileMediaMap::SubElementLoadProcessing().

virtual ::itk::LightObject::Pointer FREE::CtrlProfile::Media::CreateAnother ( void   )  const [inline, virtual]

Definition at line 53 of file freProfileMedia.h.

void FREE::CtrlProfile::Media::SetName ( const std::string &  sName  )  [inline]

Definition at line 59 of file freProfileMedia.h.

References m_Name.

std::string FREE::CtrlProfile::Media::GetName (  )  const [inline]

Definition at line 60 of file freProfileMedia.h.

References m_Name.

Referenced by FREE::CtrlProfile::MediaIdentifierBase::KeyMatches().

void FREE::CtrlProfile::Media::SetAccess ( const DataAccessType &  da  )  [inline]

Definition at line 62 of file freProfileMedia.h.

References m_Access.

DataAccessType FREE::CtrlProfile::Media::GetAccess (  )  const [inline]

Definition at line 63 of file freProfileMedia.h.

References m_Access.

Referenced by operator=().

void FREE::CtrlProfile::Media::SetDimension ( DimensionType  dimension  )  [inline]

Definition at line 65 of file freProfileMedia.h.

References m_Dimension.

DimensionType FREE::CtrlProfile::Media::GetDimension (  )  const [inline]

Definition at line 66 of file freProfileMedia.h.

References m_Dimension.

Referenced by operator=(), and FREE::CtrlProfile::ProfileOption::ProfileMatchesOption().

void FREE::CtrlProfile::Media::SetDataType ( const std::string &  typeID  )  [inline]

Definition at line 68 of file freProfileMedia.h.

References m_MediaType.

const std::string& FREE::CtrlProfile::Media::GetDataType (  )  const [inline]

Definition at line 69 of file freProfileMedia.h.

References m_MediaType.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::GetMediaControllerID(), and operator=().

void FREE::CtrlProfile::Media::SetInternal ( bool  bInternal  )  [inline]

Definition at line 71 of file freProfileMedia.h.

References m_bInternal.

bool FREE::CtrlProfile::Media::GetInternal (  )  const [inline]

Definition at line 72 of file freProfileMedia.h.

References m_bInternal.

Referenced by operator=().

void FREE::CtrlProfile::Media::SetIsTemplate ( bool  bTemplate  )  [inline]

Definition at line 74 of file freProfileMedia.h.

References m_bTemplate.

bool FREE::CtrlProfile::Media::GetIsTemplate (  )  const [inline]

Definition at line 75 of file freProfileMedia.h.

References m_bTemplate.

Referenced by operator=().

void FREE::CtrlProfile::Media::SetGroup ( unsigned int  iGroup  )  [inline]

Definition at line 77 of file freProfileMedia.h.

References m_iGroup.

unsigned int FREE::CtrlProfile::Media::GetGroup (  )  const [inline]

Definition at line 78 of file freProfileMedia.h.

References m_iGroup.

Referenced by operator=().

void FREE::CtrlProfile::Media::Reset (  )  [virtual]

Resets the object to default/initial state

Reimplemented from FREE::XMLStreamObject.

Definition at line 65 of file freProfileMedia.cxx.

References FREE::DAAny, DT_AllDimensions, m_Access, m_bInternal, m_bTemplate, m_Dimension, m_iGroup, m_MediaType, and FREE::XMLStreamObject::Reset().

Referenced by Media().

Here is the call graph for this function:

FREE::XMLStreamObject::Reset

Media & FREE::CtrlProfile::Media::operator= ( const Media &  Media  )  [virtual]

Assignment operator.

Definition at line 38 of file freProfileMedia.cxx.

References GetAccess(), GetDataType(), GetDimension(), GetGroup(), GetInternal(), GetIsTemplate(), m_Access, m_bInternal, m_bTemplate, m_Dimension, m_iGroup, and m_MediaType.

Here is the call graph for this function:

FREE::CtrlProfile::Media::GetAccessFREE::CtrlProfile::Media::GetDataTypeFREE::CtrlProfile::Media::GetDimensionFREE::CtrlProfile::Media::GetGroupFREE::CtrlProfile::Media::GetInternalFREE::CtrlProfile::Media::GetIsTemplate

void FREE::CtrlProfile::Media::AttributesLoadProcessing ( const AttributesType &  rAttributes  )  [protected, virtual]

Definition at line 79 of file freProfileMedia.cxx.

References FREE::cXML_CP_Group, FREE::cXML_CP_MediaAccess, FREE::cXML_CP_MediaDim, FREE::cXML_CP_MediaInternal, FREE::cXML_CP_MediaName, FREE::cXML_CP_MediaType, FREE::cXML_CP_Template, m_Access, m_bInternal, m_bTemplate, m_Dimension, m_iGroup, m_MediaType, m_Name, FREE::Convert::ToBool(), FREE::Convert::ToDataAccessType(), and FREE::Convert::ToInt().

Here is the call graph for this function:

FREE::Convert::ToBoolFREE::Convert::ToDataAccessTypeFREE::Convert::ToIntFREE::Convert::ToStr

void FREE::CtrlProfile::Media::SaveAttributes ( AttributesSaveListType &  rAttributes  )  const [protected, virtual]

Definition at line 95 of file freProfileMedia.cxx.

References FREE::cXML_CP_Group, FREE::cXML_CP_MediaAccess, FREE::cXML_CP_MediaDim, FREE::cXML_CP_MediaInternal, FREE::cXML_CP_MediaName, FREE::cXML_CP_MediaType, FREE::cXML_CP_Template, FREE::DAAny, DT_AllDimensions, m_Access, m_bInternal, m_bTemplate, m_Dimension, m_iGroup, m_MediaType, m_Name, and FREE::Convert::ToStr().

Here is the call graph for this function:

FREE::Convert::ToStr

Member Data Documentation

const Media::DimensionType FREE::CtrlProfile::Media::DT_AllDimensions = cMDDAny [static]

Implementation of FREE::CtrlProfile::Media /////////////////////////

Definition at line 57 of file freProfileMedia.h.

Referenced by FREE::MediaActualizerController::GenerateProfile(), FREE::CtrlProfile::ProfileOption::ProfileMatchesOption(), Reset(), and SaveAttributes().

std::string FREE::CtrlProfile::Media::m_Name [protected]

Definition at line 96 of file freProfileMedia.h.

Referenced by AttributesLoadProcessing(), GetName(), SaveAttributes(), and SetName().

DataAccessType FREE::CtrlProfile::Media::m_Access [protected]

Indicates how image data will be handled.

Definition at line 99 of file freProfileMedia.h.

Referenced by AttributesLoadProcessing(), GetAccess(), operator=(), Reset(), SaveAttributes(), and SetAccess().

DimensionType FREE::CtrlProfile::Media::m_Dimension [protected]

Indicates the dimension of the stream and so the processed image data.

Definition at line 102 of file freProfileMedia.h.

Referenced by AttributesLoadProcessing(), GetDimension(), operator=(), Reset(), SaveAttributes(), and SetDimension().

std::string FREE::CtrlProfile::Media::m_MediaType [protected]

the ID of the controller responsible for this media type, hence the media type itself.

Definition at line 105 of file freProfileMedia.h.

Referenced by AttributesLoadProcessing(), GetDataType(), operator=(), Reset(), SaveAttributes(), and SetDataType().

bool FREE::CtrlProfile::Media::m_bInternal [protected]

Indicates if the media link is private, thus it should not be shown in interfaces that allow users to change the media (e.g. a setup editor), also this kind of media are not automatically linked by the SessionBuilder. Normaly this kind of media have the access type "Get"..

Definition at line 111 of file freProfileMedia.h.

Referenced by AttributesLoadProcessing(), GetInternal(), operator=(), Reset(), SaveAttributes(), and SetInternal().

bool FREE::CtrlProfile::Media::m_bTemplate [protected]

Indicates if the media profile is a template, thus it is allowed to have multiple medias based on this specification.

Definition at line 115 of file freProfileMedia.h.

Referenced by AttributesLoadProcessing(), GetIsTemplate(), operator=(), Reset(), SaveAttributes(), and SetIsTemplate().

unsigned int FREE::CtrlProfile::Media::m_iGroup [protected]

Indicates by ID, if it is member of a semantic group.
0: no group member
otherwise the parameter is grouped with other parameters, subcomponents or media of the component by the ID. The whole group must be set if one member is present.

Remarks:
The group 1 is the group of required subcomponents, therefore media with the ID 1 are always required.

Definition at line 124 of file freProfileMedia.h.

Referenced by AttributesLoadProcessing(), GetGroup(), operator=(), Reset(), SaveAttributes(), and SetGroup().

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