FREE::CtrlProfile::Parameter

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

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

#include <freProfileParameter.h>

Inheritance diagram for FREE::CtrlProfile::Parameter:

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

Collaboration graph
FREE::ParameterFREE::XMLStreamObject
[legend]

List of all members.

Public Types

typedef Parameter Self
typedef FREE::Parameter Superclass
typedef
itk::SmartPointer
< Self > 		Pointer
typedef
itk::SmartPointer
< const Self > 		ConstPointer

Public Member Functions

virtual const char * GetNameOfClass () const
virtual
::itk::LightObject::Pointer 		CreateAnother (void) const
void SetHint (std::string sHint)
std::string GetHint () const
bool GetIsArbitrarilyLayered () const
void SetLayerCount (int iLayerCount)
int GetLayerCount () const
void SetIsMultiResDynamic (bool bDynamic)
bool GetIsMultiResDynamic () const
void SetInternal (bool bInternal)
bool GetInternal () const
void SetParameterSize (ValueCountType iSize)
void SetValueType (ParameterValueType valueType)
ParameterValueType GetValueType () const
void SetGroup (unsigned int iGroup)
unsigned int GetGroup () const
void SetAccess (const DataAccessType &da)
DataAccessType GetAccess () const
bool GetHasDefault () const
virtual void Reset ()
virtual Parameter & operator= (const Parameter &rParameter)

Static Public Member Functions

static Pointer New (void)

Protected Member Functions

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

Protected Attributes

std::string m_sHint
int m_iLayerCount
bool m_bDynamic
ParameterValueType m_ValueType
bool m_bInternal
DataAccessType m_Access
unsigned int m_iGroup

Private Member Functions

 Parameter (const Parameter &rParameter)

Detailed Description

Class providing the possibility to store and retrieve characteristics of parameter values.

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

Definition at line 41 of file freProfileParameter.h.

Member Typedef Documentation

typedef Parameter FREE::CtrlProfile::Parameter::Self

Reimplemented from FREE::Parameter.

Definition at line 44 of file freProfileParameter.h.

typedef FREE::Parameter FREE::CtrlProfile::Parameter::Superclass

Reimplemented from FREE::Parameter.

Definition at line 45 of file freProfileParameter.h.

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

Reimplemented from FREE::Parameter.

Definition at line 46 of file freProfileParameter.h.

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

Reimplemented from FREE::Parameter.

Definition at line 47 of file freProfileParameter.h.

Constructor & Destructor Documentation

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

Reimplemented from FREE::Parameter.

Definition at line 64 of file freProfileParameter.cxx.

References FREE::cXML_CP_Parameter, Reset(), and FREE::XMLStreamObject::SetXMLTag().

Here is the call graph for this function:

FREE::CtrlProfile::Parameter::ResetFREE::XMLStreamObject::SetXMLTagFREE::Parameter::ResetFREE::Parameter::DeleteParameterLayerFREE::XMLStreamObject::Reset

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

Reimplemented from FREE::Parameter.

Definition at line 71 of file freProfileParameter.cxx.

FREE::CtrlProfile::Parameter::Parameter ( const Parameter &  rParameter  )  [private]

Member Function Documentation

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

Run-time type information (and related methods).

Reimplemented from FREE::Parameter.

Definition at line 49 of file freProfileParameter.h.

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

Reimplemented from FREE::Parameter.

Definition at line 51 of file freProfileParameter.h.

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

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

Reimplemented from FREE::Parameter.

Definition at line 51 of file freProfileParameter.h.

void FREE::CtrlProfile::Parameter::SetHint ( std::string  sHint  )  [inline]

Definition at line 53 of file freProfileParameter.h.

References m_sHint.

std::string FREE::CtrlProfile::Parameter::GetHint (  )  const [inline]

Definition at line 54 of file freProfileParameter.h.

References m_sHint.

Referenced by operator=().

bool FREE::CtrlProfile::Parameter::GetIsArbitrarilyLayered (  )  const [inline]

Definition at line 56 of file freProfileParameter.h.

References m_iLayerCount.

void FREE::CtrlProfile::Parameter::SetLayerCount ( int  iLayerCount  )  [inline]

Definition at line 58 of file freProfileParameter.h.

References m_iLayerCount.

int FREE::CtrlProfile::Parameter::GetLayerCount (  )  const [inline]

Returns the number of layers a parameter may/must have.

Remarks:
The difference between this member function and LayerCount() is, that LayerCount() returns the number of defined default layers the controller uses to initialize the setup. GetLayerCount() returns the number of layers the parameter must/may have after initialization

Definition at line 65 of file freProfileParameter.h.

References m_iLayerCount.

Referenced by operator=().

void FREE::CtrlProfile::Parameter::SetIsMultiResDynamic ( bool  bDynamic  )  [inline]

Definition at line 67 of file freProfileParameter.h.

References m_bDynamic.

bool FREE::CtrlProfile::Parameter::GetIsMultiResDynamic (  )  const [inline]

Definition at line 68 of file freProfileParameter.h.

References m_bDynamic.

Referenced by operator=().

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

Definition at line 70 of file freProfileParameter.h.

References m_bInternal.

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

Definition at line 71 of file freProfileParameter.h.

References m_bInternal.

Referenced by operator=().

void FREE::CtrlProfile::Parameter::SetParameterSize ( ValueCountType  iSize  ) 

Implementation of FREE::CtrlProfile::Parameter /////////////////////

Definition at line 38 of file freProfileParameter.cxx.

References FREE::Parameter::m_iLayerSize, and FREE::Parameter::Resize().

Here is the call graph for this function:

FREE::Parameter::Resize

void FREE::CtrlProfile::Parameter::SetValueType ( ParameterValueType  valueType  )  [inline]

Definition at line 75 of file freProfileParameter.h.

References m_ValueType.

ParameterValueType FREE::CtrlProfile::Parameter::GetValueType (  )  const [inline]

Definition at line 76 of file freProfileParameter.h.

References m_ValueType.

Referenced by operator=().

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

Definition at line 78 of file freProfileParameter.h.

References m_iGroup.

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

Definition at line 79 of file freProfileParameter.h.

References m_iGroup.

Referenced by operator=().

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

Definition at line 81 of file freProfileParameter.h.

References m_Access.

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

Definition at line 82 of file freProfileParameter.h.

References m_Access.

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

bool FREE::CtrlProfile::Parameter::GetHasDefault (  )  const [inline]

Definition at line 84 of file freProfileParameter.h.

References FREE::Parameter::LayerCount().

Here is the call graph for this function:

FREE::Parameter::LayerCount

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

Resets to no layers, but layer size stays unchanged.

Reimplemented from FREE::Parameter.

Definition at line 77 of file freProfileParameter.cxx.

References FREE::DAAny, m_Access, m_bDynamic, m_bInternal, m_iGroup, m_iLayerCount, m_sHint, m_ValueType, FREE::Parameter::PVTString, and FREE::Parameter::Reset().

Referenced by Parameter().

Here is the call graph for this function:

FREE::Parameter::ResetFREE::Parameter::DeleteParameterLayerFREE::XMLStreamObject::Reset

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

Assignment operator.

Definition at line 46 of file freProfileParameter.cxx.

References GetAccess(), GetGroup(), GetHint(), GetInternal(), GetIsMultiResDynamic(), GetLayerCount(), GetValueType(), m_Access, m_bDynamic, m_bInternal, m_iGroup, m_iLayerCount, m_sHint, m_ValueType, and FREE::Parameter::operator=().

Here is the call graph for this function:

FREE::CtrlProfile::Parameter::GetAccessFREE::CtrlProfile::Parameter::GetGroupFREE::CtrlProfile::Parameter::GetHintFREE::CtrlProfile::Parameter::GetInternalFREE::CtrlProfile::Parameter::GetIsMultiResDynamicFREE::CtrlProfile::Parameter::GetLayerCountFREE::CtrlProfile::Parameter::GetValueTypeFREE::Parameter::operator=FREE::Parameter::AddParameterLayerFREE::Parameter::ParameterSizeFREE::Parameter::GetParameterLayerFREE::Parameter::LayerCountFREE::Parameter::GetParameterNameFREE::Parameter::GetTemplateIDFREE::Parameter::ResizeFREE::ParameterLayer::New

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

Reimplemented from FREE::Parameter.

Definition at line 92 of file freProfileParameter.cxx.

References FREE::cXML_CP_Group, FREE::cXML_CP_MediaAccess, FREE::cXML_CP_MediaInternal, FREE::cXML_CP_ParamDynamic, FREE::cXML_CP_ParamHint, FREE::cXML_CP_ParamLayerCount, FREE::cXML_CP_ParamName, FREE::cXML_CP_ParamSize, FREE::cXML_CP_ParamType, m_Access, m_bDynamic, m_bInternal, m_iGroup, m_iLayerCount, FREE::Parameter::m_iLayerSize, m_sHint, FREE::Parameter::m_sParameterName, m_ValueType, FREE::Convert::ToBool(), FREE::Convert::ToDataAccessType(), FREE::Convert::ToInt(), and FREE::Convert::ToParameterValueType().

Here is the call graph for this function:

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

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

Reimplemented from FREE::Parameter.

Definition at line 110 of file freProfileParameter.cxx.

References FREE::cXML_CP_Group, FREE::cXML_CP_MediaAccess, FREE::cXML_CP_MediaInternal, FREE::cXML_CP_ParamDynamic, FREE::cXML_CP_ParamHint, FREE::cXML_CP_ParamLayerCount, FREE::cXML_CP_ParamName, FREE::cXML_CP_ParamType, FREE::DAAny, m_Access, m_bDynamic, m_bInternal, m_iGroup, m_iLayerCount, FREE::Parameter::m_iLayerSize, m_sHint, FREE::Parameter::m_sParameterName, m_ValueType, and FREE::Convert::ToStr().

Here is the call graph for this function:

FREE::Convert::ToStr

Member Data Documentation

std::string FREE::CtrlProfile::Parameter::m_sHint [protected]

Hint with information about the nature of the parameter and its handling

Definition at line 104 of file freProfileParameter.h.

Referenced by AttributesLoadProcessing(), GetHint(), operator=(), Reset(), SaveAttributes(), and SetHint().

int FREE::CtrlProfile::Parameter::m_iLayerCount [protected]

Indicates the number of layers a parameter has. A Count of -1 indecates, that the number is not fixed and can freely be defined.

Definition at line 108 of file freProfileParameter.h.

Referenced by AttributesLoadProcessing(), GetIsArbitrarilyLayered(), GetLayerCount(), operator=(), Reset(), SaveAttributes(), and SetLayerCount().

bool FREE::CtrlProfile::Parameter::m_bDynamic [protected]

Indicates if the parameter has different values depending on the actual resolution level of the registration. If m_bDynamic is true, m_bLayered must also be true, because every layer is related to a resolution level.

Definition at line 114 of file freProfileParameter.h.

Referenced by AttributesLoadProcessing(), GetIsMultiResDynamic(), operator=(), Reset(), SaveAttributes(), and SetIsMultiResDynamic().

ParameterValueType FREE::CtrlProfile::Parameter::m_ValueType [protected]

Type of the parameter

Definition at line 117 of file freProfileParameter.h.

Referenced by AttributesLoadProcessing(), GetValueType(), operator=(), Reset(), SaveAttributes(), and SetValueType().

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

Indicates if the parameter is private, thus it should not be shown in interfaces that allow users to change the parameter (e.g. a setup editor). Normaly this kind of parameters have the access type "Get"..

Definition at line 122 of file freProfileParameter.h.

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

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

Indicates how image data will be handled.

Definition at line 125 of file freProfileParameter.h.

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

unsigned int FREE::CtrlProfile::Parameter::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.

Definition at line 131 of file freProfileParameter.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:45 2007 for f.r.e.e. - Flexible Registration and Evaluation Engine by doxygen 1.5.3 written by Dimitri van Heesch, © 1997-2000