FREE::Adaptation::AdaptationComponent

FREE::Adaptation::AdaptationComponent Class Reference
[Adaptation]

#include <freAdaptationComponent.h>

Inheritance diagram for FREE::Adaptation::AdaptationComponent:

Inheritance graph
FREE::ComponentSetupFREE::XMLStreamObject
[legend]
Collaboration diagram for FREE::Adaptation::AdaptationComponent:

Collaboration graph
FREE::ComponentSetupFREE::ComponentSetupCollectionFREE::XMLStreamObjectFREE::XMLKeyedCollectionBase\< std::string, FREE::ComponentSetup, FREE::ComponentSetupIdentifier \>FREE::XMLKeyedCollectionBase\< std::string, FREE::ComponentMediaLink, FREE::ComponentMediaLinkIdentifier \>FREE::ParameterCollectionFREE::IDPathFREE::KeyedCollectionBase\< TKey, TXMLElement, TIdentifierClass \>FREE::SmartCollectionBase\< TXMLElement \>FREE::CollectionBase\< TXMLElement, itk::SmartPointer\< TXMLElement \> \>FREE::ComponentMediaLinks
[legend]

List of all members.

Public Types

enum  AdaptationMode {
  AMUnknown = 0, AMOverwrite = 1, AMReplace = 2, AMExtend = 3,
  AMAdapt = 4
}
typedef
AdaptationComponent 		Self
typedef ComponentSetup 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 SetComponentPath (const IDPath &idPath)
const IDPath & GetComponentPath () const
void SetAdaptationMode (const AdaptationMode &am)
const AdaptationMode & GetAdaptationMode () const
virtual
AdaptationComponent & 		operator= (const AdaptationComponent &rComponentSetup)
virtual void Reset ()

Static Public Member Functions

static Pointer New (void)

Protected Member Functions

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

Protected Attributes

IDPath m_ComponentPath
AdaptationMode m_AdaptationMode

Private Member Functions

 AdaptationComponent (const AdaptationComponent &rComponentSetup)

Detailed Description

Definition at line 37 of file freAdaptationComponent.h.

Member Typedef Documentation

typedef AdaptationComponent FREE::Adaptation::AdaptationComponent::Self

Reimplemented from FREE::ComponentSetup.

Definition at line 40 of file freAdaptationComponent.h.

typedef ComponentSetup FREE::Adaptation::AdaptationComponent::Superclass

Reimplemented from FREE::ComponentSetup.

Definition at line 41 of file freAdaptationComponent.h.

typedef itk::SmartPointer<Self> FREE::Adaptation::AdaptationComponent::Pointer

Reimplemented from FREE::ComponentSetup.

Definition at line 42 of file freAdaptationComponent.h.

typedef itk::SmartPointer<const Self> FREE::Adaptation::AdaptationComponent::ConstPointer

Reimplemented from FREE::ComponentSetup.

Definition at line 43 of file freAdaptationComponent.h.

Member Enumeration Documentation

enum FREE::Adaptation::AdaptationComponent::AdaptationMode

Enumerator:
AMUnknown 
AMOverwrite  insert adaptation component, overwrites the old component if it exists. Use this mode only with valid and fully functional adaptation components
AMReplace  replace adaptation component if component exists in setup. Use this mode only with valid and fully functional adaptation components
AMExtend  adapt the component if the component exists in setup. Insert parameters, media or sub component if they are not existing
AMAdapt  adapt existing components.

Definition at line 48 of file freAdaptationComponent.h.

Constructor & Destructor Documentation

FREE::Adaptation::AdaptationComponent::AdaptationComponent (  )  [protected]

Definition at line 58 of file freAdaptationComponent.cxx.

References FREE::cIDPSelf, and m_ComponentPath.

FREE::Adaptation::AdaptationComponent::~AdaptationComponent (  )  [protected, virtual]

Definition at line 64 of file freAdaptationComponent.cxx.

References Reset().

Here is the call graph for this function:

FREE::Adaptation::AdaptationComponent::ResetFREE::ComponentSetup::ResetFREE::XMLKeyedCollectionBase::ResetFREE::XMLStreamObject::ResetFREE::ComponentSetup::ResetParametersFREE::ParameterCollection::ResetFREE::ParameterCollection::ResetParametersFREE::ParameterCollection::DeleteParameterFREE::ParameterCollection::GetParameterIndex

FREE::Adaptation::AdaptationComponent::AdaptationComponent ( const AdaptationComponent &  rComponentSetup  )  [private]

suppresses default copy constructor

Member Function Documentation

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

Reimplemented from FREE::ComponentSetup.

Definition at line 45 of file freAdaptationComponent.h.

static Pointer FREE::Adaptation::AdaptationComponent::New ( void   )  [inline, static]

Reimplemented from FREE::ComponentSetup.

Definition at line 46 of file freAdaptationComponent.h.

Referenced by FREE::Adaptation::Adaptation::SubElementLoadProcessing().

virtual ::itk::LightObject::Pointer FREE::Adaptation::AdaptationComponent::CreateAnother ( void   )  const [inline, virtual]

Reimplemented from FREE::ComponentSetup.

Definition at line 46 of file freAdaptationComponent.h.

void FREE::Adaptation::AdaptationComponent::SetComponentPath ( const IDPath &  idPath  ) 

Function to access the member variable m_ComponentPath.

Parameters:
[in] idPath The new component ID path.
Implementation of FREE::AdaptationComponent ////////////////////////

Definition at line 37 of file freAdaptationComponent.cxx.

References m_ComponentPath.

Referenced by FREE::ImageAdaptationInverter::InvertAdaptation().

const IDPath& FREE::Adaptation::AdaptationComponent::GetComponentPath (  )  const [inline]

Function to access the member variable m_ComponentPath.

Returns:
Reference to the ComponentPath of the AdaptationComponent.

Definition at line 62 of file freAdaptationComponent.h.

References m_ComponentPath.

Referenced by FREE::GenericSetupToImageAdaptor::AdaptSetup(), and operator=().

void FREE::Adaptation::AdaptationComponent::SetAdaptationMode ( const AdaptationMode &  am  ) 

Function to access the member variable m_AdaptationMode.

Parameters:
[in] am The new adpatation mode.

const AdaptationMode& FREE::Adaptation::AdaptationComponent::GetAdaptationMode (  )  const [inline]

Function to access the member variable m_AdaptationMode.

Returns:
Reference to the adaptation mode of the AdaptationComponent.

Definition at line 69 of file freAdaptationComponent.h.

References m_AdaptationMode.

Referenced by FREE::GenericSetupToImageAdaptor::AdaptSetup().

AdaptationComponent & FREE::Adaptation::AdaptationComponent::operator= ( const AdaptationComponent &  rComponentSetup  )  [virtual]

Assignment operator.

Definition at line 44 of file freAdaptationComponent.cxx.

References FREE::IDPath::GetComponentID(), GetComponentPath(), FREE::ComponentSetup::m_ComponentID, m_ComponentPath, FREE::ComponentSetup::operator=(), and Reset().

Here is the call graph for this function:

FREE::IDPath::GetComponentIDFREE::Adaptation::AdaptationComponent::GetComponentPathFREE::ComponentSetup::operator=FREE::Adaptation::AdaptationComponent::ResetFREE::ComponentSetup::ComponentsFREE::ComponentSetup::GetCommentFREE::ComponentSetup::GetComponentIDFREE::ComponentSetup::GetControllerIDFREE::ComponentSetup::GetTemplateIDFREE::ComponentSetup::MediaLinksFREE::ComponentSetup::ParametersFREE::ComponentSetup::ResetFREE::XMLKeyedCollectionBase::ResetFREE::XMLStreamObject::ResetFREE::ComponentSetup::ResetParametersFREE::ParameterCollection::ResetFREE::ParameterCollection::ResetParametersFREE::ParameterCollection::DeleteParameterFREE::ParameterCollection::GetParameterIndex

void FREE::Adaptation::AdaptationComponent::Reset (  )  [virtual]

Resets all properties of the component setup, except the parent reference and the dimension.

Reimplemented from FREE::ComponentSetup.

Definition at line 69 of file freAdaptationComponent.cxx.

References AMOverwrite, FREE::cIDPSelf, m_AdaptationMode, m_ComponentPath, and FREE::ComponentSetup::Reset().

Referenced by operator=(), and ~AdaptationComponent().

Here is the call graph for this function:

FREE::ComponentSetup::ResetFREE::XMLKeyedCollectionBase::ResetFREE::XMLStreamObject::ResetFREE::ComponentSetup::ResetParametersFREE::ParameterCollection::ResetFREE::ParameterCollection::ResetParametersFREE::ParameterCollection::DeleteParameterFREE::ParameterCollection::GetParameterIndex

void FREE::Adaptation::AdaptationComponent::AttributesLoadProcessing ( const AttributesType &  rAttributes  )  [protected, virtual]

Reimplemented from FREE::ComponentSetup.

Definition at line 78 of file freAdaptationComponent.cxx.

References FREE::cXML_Adaptation_Mode, FREE::cXML_ComponentControllerID, FREE::cXML_ComponentID, FREE::IDPath::GetComponentID(), m_AdaptationMode, FREE::ComponentSetup::m_ComponentID, m_ComponentPath, FREE::ComponentSetup::m_sControllerID, and FREE::Convert::ToAdaptationMode().

Here is the call graph for this function:

FREE::IDPath::GetComponentIDFREE::Convert::ToAdaptationModeFREE::Convert::ToStr

void FREE::Adaptation::AdaptationComponent::SaveAttributes ( AttributesSaveListType &  rAttributes  )  const [protected, virtual]

Reimplemented from FREE::ComponentSetup.

Definition at line 91 of file freAdaptationComponent.cxx.

References AMOverwrite, FREE::csUndefinedController, FREE::cXML_Adaptation_Mode, FREE::cXML_ComponentControllerID, FREE::cXML_ComponentID, m_AdaptationMode, m_ComponentPath, FREE::ComponentSetup::m_sControllerID, FREE::Convert::ToStr(), and FREE::IDPath::ToStr().

Here is the call graph for this function:

FREE::Convert::ToStrFREE::IDPath::ToStrFREE::IDPath::Size

Member Data Documentation

IDPath FREE::Adaptation::AdaptationComponent::m_ComponentPath [protected]

path selecting the adapted parts in the setup

Definition at line 90 of file freAdaptationComponent.h.

Referenced by AdaptationComponent(), AttributesLoadProcessing(), GetComponentPath(), operator=(), Reset(), SaveAttributes(), and SetComponentPath().

AdaptationMode FREE::Adaptation::AdaptationComponent::m_AdaptationMode [protected]

indicates how wich adaptation method should be used for this component.

Definition at line 93 of file freAdaptationComponent.h.

Referenced by AttributesLoadProcessing(), GetAdaptationMode(), Reset(), and SaveAttributes().

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