FREE::ComponentAdaptorBase Class Reference
[Setup component adapter]

Base class of setup component adaptors. More...

#include <freComponentSetupAdaptor.h>

Inheritance diagram for FREE::ComponentAdaptorBase:

[legend]

List of all members.

Public Types
typedef ComponentSetup::Pointer	ComponentSetupPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
ComponentSetup *	operator() () const
ComponentSetup *	operator() (ComponentSetup *pComponent)
virtual ComponentSetup *	Adapt (ComponentSetup *pComponent)
ComponentSetupPointer	CreateAndAdapt (const ComponentID &compID=cComp_NotDefined)
ComponentSetup *	GetActualComponent () const
void	SetActualComponent (ComponentSetup *pComponent)
Protected Member Functions
	ComponentAdaptorBase (ComponentSetup *pComponent=NULL)
virtual	~ComponentAdaptorBase ()
Protected Attributes
ComponentSetupPointer	m_pComponent

---

Detailed Description

Base class of setup component adaptors.

ComponentAdaptorBase is the base class of setup component adaptors. Component adaptors are used to initialize a ComponentSetup with the basic parameters of a special controller type (e.g. TransformController). And also the adapter offers member functions to access these parameters in a more specialized way, than the generic GetParameterValue() and SetParameterValue() functions. Also direct access to subcomponents could be offered.

Definition at line 43 of file freComponentSetupAdaptor.h.

---

Member Typedef Documentation

typedef ComponentSetup::Pointer FREE::ComponentAdaptorBase::ComponentSetupPointer

Definition at line 46 of file freComponentSetupAdaptor.h.

---

Constructor & Destructor Documentation

FREE::ComponentAdaptorBase::ComponentAdaptorBase

(

ComponentSetup *

pComponent = NULL

)

[protected]

Default Constructor. Sets the actual setup component by SetActualComponent().
Con

Implementation of FREE::ComponentAdaptorBase ///////////////////////

Definition at line 35 of file freComponentSetupAdaptor.cxx.

References SetActualComponent().

Here is the call graph for this function:

FREE::ComponentAdaptorBase::~ComponentAdaptorBase

(

)

[protected, virtual]

Definition at line 41 of file freComponentSetupAdaptor.cxx.

---

Member Function Documentation

virtual const char* FREE::ComponentAdaptorBase::GetNameOfClass

(

)

const [inline, virtual]

Definition at line 46 of file freComponentSetupAdaptor.h.

ComponentSetup * FREE::ComponentAdaptorBase::operator()

(

)

const

This operator is equal to the member function GetActualComponent().

Definition at line 47 of file freComponentSetupAdaptor.cxx.

References GetActualComponent().

Here is the call graph for this function:

ComponentSetup * FREE::ComponentAdaptorBase::operator()

(

ComponentSetup *

pComponent

)

This operator is equal to the member function Adapt().

Definition at line 54 of file freComponentSetupAdaptor.cxx.

References Adapt().

Here is the call graph for this function:

ComponentSetup * FREE::ComponentAdaptorBase::Adapt

(

ComponentSetup *

pComponent

)

[virtual]

The function takes the passed ComponentSetup resets it and adds the basic parameters. After the adaptation the component becomes the current component of the adaptor and is the return of the function.

Parameters:

[in,out]

pComponent

Pointer to the component that should be adapted.

Returns:

Pointer to the adapted setup component. (The return is equal to pComponent)

Reimplemented in FREE::TransformSetupAdaptor.

Definition at line 61 of file freComponentSetupAdaptor.cxx.

References FREE::ComponentSetup::ResetParameters(), and SetActualComponent().

Referenced by FREE::TransformSetupAdaptor::Adapt(), CreateAndAdapt(), and operator()().

Here is the call graph for this function:

ComponentAdaptorBase::ComponentSetupPointer FREE::ComponentAdaptorBase::CreateAndAdapt

(

const ComponentID &

compID = cComp_NotDefined

)

The function creates a new ComponentSetup with the passed values and adapts it with Adapt().

Parameters:

[in]

compID

Component ID of the new component.

Returns:

Pointer to the created and adapted setup component.

Definition at line 70 of file freComponentSetupAdaptor.cxx.

References Adapt(), and FREE::ComponentSetup::New().

Here is the call graph for this function:

ComponentSetup * FREE::ComponentAdaptorBase::GetActualComponent

(

)

const

Returns the pointer to the current setup component.

Remarks:

By default the actual component is NULL. So access is only valid if one of the following functions has been called at least once:
Adapt(), CreateAndAdapt() or SetActualComponent().

Definition at line 79 of file freComponentSetupAdaptor.cxx.

References m_pComponent.

Referenced by operator()().

void FREE::ComponentAdaptorBase::SetActualComponent

(

ComponentSetup *

pComponent

)

Sets the pointer to the actual setup component.

Definition at line 86 of file freComponentSetupAdaptor.cxx.

References m_pComponent.

Referenced by Adapt(), and ComponentAdaptorBase().

---

Member Data Documentation

ComponentSetupPointer FREE::ComponentAdaptorBase::m_pComponent [protected]

Pointer to the actual setup component.

Definition at line 85 of file freComponentSetupAdaptor.h.

Referenced by FREE::TransformSetupAdaptor::Adapt(), GetActualComponent(), FREE::TransformSetupAdaptor::GetCurrentTransformParameters(), FREE::TransformSetupAdaptor::GetInitialTransformParameters(), FREE::TransformSetupAdaptor::GetScales(), SetActualComponent(), FREE::TransformSetupAdaptor::SetCurrentTransformParameters(), FREE::TransformSetupAdaptor::SetInitialTransformParameters(), and FREE::TransformSetupAdaptor::SetScales().

---

The documentation for this class was generated from the following files:

• freComponentSetupAdaptor.h
• freComponentSetupAdaptor.cxx

---