FREE::ComponentSetup

FREE::ComponentSetup Class Reference
[Setup]

Generic class of setup information for components. More...

#include <freComponentSetup.h>

Inheritance diagram for FREE::ComponentSetup:

Inheritance graph
FREE::Adaptation::AdaptationComponentFREE::XMLStreamObject
[legend]
Collaboration diagram for FREE::ComponentSetup:

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

List of all members.

Public Types

typedef ComponentSetup Self
typedef itk::LightObject 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
bool ControllerIsAssigned () const
void SetControllerID (const std::string &sControllerID)
std::string GetControllerID () const
void SetComment (const std::string &sComment)
std::string GetComment () const
void SetComponentID (const ComponentID &componentID)
const ComponentID & GetComponentID () const
ComponentID & GetComponentID ()
void SetTemplateID (const std::string &sTemplateID)
const std::string & GetTemplateID () const
bool IsTemplateBased () const
ParameterCollection & Parameters ()
const
ParameterCollection & 		Parameters () const
ComponentMediaLinks & MediaLinks ()
const
ComponentMediaLinks & 		MediaLinks () const
ComponentSetupCollection & Components ()
const
ComponentSetupCollection & 		Components () const
bool HasParentComponent () const
const ComponentSetup * GetParentComponent () const
ComponentSetup * GetParentComponent ()
const ComponentSetup * GetRootComponent () const
ComponentSetup * GetRootComponent ()
ComponentSetup * GetComponentByIDPath (const IDPath &idPath)
IDPath GetIDPath () const
bool operator== (const std::string &sControllerID) const
virtual ComponentSetup & operator= (const ComponentSetup &rComponentSetup)
virtual void ResetParameters ()
virtual void Reset ()

Static Public Member Functions

static Pointer New (void)
static Pointer New (ComponentSetup *pParentComponent, const ComponentID &compID=cComp_NotDefined)

Protected Member Functions

 ComponentSetup ()
 ComponentSetup (ComponentSetup *pParentComponent, const ComponentID &compID=cComp_NotDefined)
virtual ~ComponentSetup ()
virtual void SubElementLoadProcessing (const std::string &rsXMLSubTag, const std::string &rsXMLSubElement, const std::string &rsXMLSubData)
virtual std::string SaveData (const unsigned int &iDepth, bool &bHasSubElements) const
virtual void AttributesLoadProcessing (const AttributesType &rAttributes)
virtual void SaveAttributes (AttributesSaveListType &rAttributes) const

Protected Attributes

std::string m_sControllerID
std::string m_sComment
ComponentID m_ComponentID
std::string m_sTemplateID
ParameterCollection m_Parameters
ComponentMediaLinks m_Links
ComponentSetupCollection * m_Components
ComponentSetup * m_pParent

Private Member Functions

 ComponentSetup (const ComponentSetup &rComponentSetup)

Detailed Description

Generic class of setup information for components.

ComponentSetup is used to contain all needed information of a component, including optional subcomponents. A controller needs a setup to manage a component or to get the parameters set by the user. Most of the elements are unspecified at instantiation and will be determined by the associated controller.

Definition at line 49 of file freComponentSetup.h.

Member Typedef Documentation

typedef ComponentSetup FREE::ComponentSetup::Self

Reimplemented in FREE::Adaptation::AdaptationComponent.

Definition at line 52 of file freComponentSetup.h.

typedef itk::LightObject FREE::ComponentSetup::Superclass

Reimplemented in FREE::Adaptation::AdaptationComponent.

Definition at line 53 of file freComponentSetup.h.

typedef itk::SmartPointer<Self> FREE::ComponentSetup::Pointer

Reimplemented in FREE::Adaptation::AdaptationComponent.

Definition at line 54 of file freComponentSetup.h.

typedef itk::SmartPointer<const Self> FREE::ComponentSetup::ConstPointer

Reimplemented in FREE::Adaptation::AdaptationComponent.

Definition at line 55 of file freComponentSetup.h.

Constructor & Destructor Documentation

FREE::ComponentSetup::ComponentSetup (  )  [protected]

default constructor

Definition at line 164 of file freComponentSetup.cxx.

References FREE::cComp_NotDefined, m_ComponentID, m_Components, m_pParent, and Reset().

Referenced by New().

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

FREE::ComponentSetup::ComponentSetup ( ComponentSetup *  pParentComponent,
const ComponentID &  compID = cComp_NotDefined 
) [protected]

This is a constructor for ComponentSetups within a setup structure.

Parameters:
[in] pParentComponent Pointer to the component setup of which the newly created component is a subcomponent of.
[in] compID The component ID of the component setup

Definition at line 175 of file freComponentSetup.cxx.

References m_Components, m_pParent, Reset(), and SetComponentID().

Here is the call graph for this function:

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

FREE::ComponentSetup::~ComponentSetup (  )  [protected, virtual]

Definition at line 205 of file freComponentSetup.cxx.

References m_Components, and Reset().

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

FREE::ComponentSetup::ComponentSetup ( const ComponentSetup &  rComponentSetup  )  [private]

Member Function Documentation

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

Reimplemented from FREE::XMLStreamObject.

Reimplemented in FREE::Adaptation::AdaptationComponent.

Definition at line 57 of file freComponentSetup.h.

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

Reimplemented in FREE::Adaptation::AdaptationComponent.

Definition at line 58 of file freComponentSetup.h.

Referenced by FREE::ComponentAdaptorBase::CreateAndAdapt(), FREE::Setup::Setup(), and FREE::SetupLoadingHelper::SubElementLoadProcessing().

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

Reimplemented in FREE::Adaptation::AdaptationComponent.

Definition at line 58 of file freComponentSetup.h.

ComponentSetup::Pointer FREE::ComponentSetup::New ( ComponentSetup *  pParentComponent,
const ComponentID &  compID = cComp_NotDefined 
) [static]

Definition at line 189 of file freComponentSetup.cxx.

References ComponentSetup().

Here is the call graph for this function:

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

bool FREE::ComponentSetup::ControllerIsAssigned (  )  const [inline]

Definition at line 61 of file freComponentSetup.h.

References FREE::csUndefinedController, and GetControllerID().

Referenced by FREE::SessionBuilder::BuildComponent(), FREE::SessionBuilder::CheckComponentNecessity(), FREE::MediaDrainController::GenerateProfile(), FREE::SetupTransform::GetParameterValueType(), and FREE::SetupManager::InitializeComponentSetup().

Here is the call graph for this function:

FREE::ComponentSetup::GetControllerID

void FREE::ComponentSetup::SetControllerID ( const std::string &  sControllerID  ) 

Function to set the member variable m_ControllerID.

Parameters:
[in] sControllerID String containing the new name.
Implementation of FREE::ComponentSetup /////////////////////////////

Definition at line 36 of file freComponentSetup.cxx.

References m_sControllerID.

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

std::string FREE::ComponentSetup::GetControllerID (  )  const [inline]

Function to access the member variable m_ControllerID.

Returns:
String containing the name of the controller who is responsible for managing this ComponentSetup.

Definition at line 69 of file freComponentSetup.h.

References m_sControllerID.

Referenced by FREE::SetupManager::ActualizeConstraintCache(), FREE::SessionBuilder::BuildComponent(), ControllerIsAssigned(), FREE::SessionBuilder::GeneratePassiveComponentCache(), FREE::MediaDrainController::GenerateProfile(), FREE::MediaContainerController::GetMediaControllerID(), FREE::SetupTransform::GetParameterValueType(), FREE::ComponentControllerBase< TControlledComponent >::GetProfile(), FREE::SetupManager::InitializeComponentSetup(), FREE::SetupInterpolator::InterpolateParameter(), operator=(), FREE::GenericSetupToImageAdaptor::ReplaceComponent(), and FREE::GenericSetupToImageAdaptor::ValidateController().

void FREE::ComponentSetup::SetComment ( const std::string &  sComment  )  [inline]

Function to set the member variable m_sComment.

Parameters:
[in] sComment String containing the new comment.

Definition at line 73 of file freComponentSetup.h.

References m_sComment.

std::string FREE::ComponentSetup::GetComment (  )  const [inline]

Function to access the member variable m_sComment.

Definition at line 75 of file freComponentSetup.h.

References m_sComment.

Referenced by operator=().

void FREE::ComponentSetup::SetComponentID ( const ComponentID &  componentID  ) 

Function to access the member variable m_ComponentID.

Parameters:
[in] componentID The new ComponentID.

Definition at line 43 of file freComponentSetup.cxx.

References m_ComponentID.

Referenced by ComponentSetup(), and FREE::SetupManager::InitializeComponentSetup().

const ComponentID& FREE::ComponentSetup::GetComponentID (  )  const [inline]

Function to access the member variable m_ComponentID.

Returns:
Reference to the ComponentID of the ComponentSetup.

Definition at line 82 of file freComponentSetup.h.

References m_ComponentID.

Referenced by FREE::GenericSetupToImageAdaptor::AdaptComponent(), FREE::SessionBuilder::BuildComponent(), FREE::ComponentControllerBase< TControlledComponent >::BuildSubComponents(), FREE::GenericSetupToImageAdaptor::ExtendComponent(), FREE::MediaDrainController::GenerateProfile(), FREE::ComponentControllerBase< TControlledComponent >::GenerateProfileTemplateRealization(), FREE::SessionComponentCache::GetComponentID(), FREE::SetupManager::InitializeComponentSetup(), FREE::SetupInterpolator::InterpolateParameter(), FREE::ComponentSetupIdentifier::KeyMatches(), operator=(), and FREE::GenericSetupToImageAdaptor::OverwriteComponent().

ComponentID& FREE::ComponentSetup::GetComponentID (  )  [inline]

Function to access the member variable m_ComponentID.

Returns:
Reference to the ComponentID of the ComponentSetup.

Definition at line 85 of file freComponentSetup.h.

References m_ComponentID.

void FREE::ComponentSetup::SetTemplateID ( const std::string &  sTemplateID  )  [inline]

Sets the template ID (ID of the subcomponent (in the profile) that was the template for this component

Definition at line 89 of file freComponentSetup.h.

References m_sTemplateID.

const std::string& FREE::ComponentSetup::GetTemplateID (  )  const [inline]

Gets the template id

Definition at line 91 of file freComponentSetup.h.

References m_sTemplateID.

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

bool FREE::ComponentSetup::IsTemplateBased (  )  const [inline]

Indicates if the component is based on a profile template (true) or a concrete profile definition .

Definition at line 94 of file freComponentSetup.h.

References m_sTemplateID.

Referenced by FREE::MediaDrainController::GenerateProfile(), FREE::ComponentControllerBase< TControlledComponent >::GenerateProfileTemplateRealization(), and SaveAttributes().

ParameterCollection& FREE::ComponentSetup::Parameters (  )  [inline]

Function to access the member variable m_Parameters.

Returns:
Reference to m_Parameters.

Definition at line 98 of file freComponentSetup.h.

References m_Parameters.

Referenced by FREE::TransformControllerBase< TControlledTransform, iDimension >::ActualizeMainComponent(), FREE::SetupOptimizationOptimizerControllerBase< TControlledOptimizer >::ActualizeMainComponent(), FREE::SetupOptimizationMetricControllerBase< TControlledMetric >::ActualizeMainComponent(), FREE::PrecisionSOMetricController::ActualizeMainComponent(), FREE::CenteredRigid3DTransformController::ActualizeReferencesMainComponent(), FREE::GenericSetupToImageAdaptor::AdaptComponent(), FREE::ParameterListMediaController::BuildMainComponent(), FREE::MultiRigidRegistrationProcessor< VImageDimension >::ComputeRegistration(), FREE::DemonRegistrationProcessor< VImageDimension >::ComputeRegistration(), FREE::GenericSetupToImageAdaptor::ExtendComponent(), FREE::SetupTransformControllerBase< FREE::ConstrainedSetupTransform >::GenerateProfile(), FREE::OrientImageFilterControllerBase< FREE::ImageTypes< 3 >::InternalImageType, 3 >::GenerateProfile(), FREE::MutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::GenerateProfile(), FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::GenerateProfile(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::GenerateProfile(), FREE::ConstrainedSetupTransformController::GenerateProfile(), FREE::BSplineDeformableTransformControllerBase< 3, 3 >::GenerateProfile(), FREE::ComponentControllerBase< TControlledComponent >::GenerateProfileTemplateRealization(), FREE::FEMRegistrationProcessor< VImageDimension >::GetMaxIterationCount(), FREE::StoreableMediaControllerBase< TMedia >::GetMediaFile(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::GetParameter(), FREE::ComponentControllerBase< TControlledComponent >::GetParameter(), FREE::SetupInterpolator::InterpolateComponent(), FREE::SetupInterpolator::InterpolateParameter(), FREE::ParameterListIO::LoadListFromFile(), FREE::PointSetMediaControllerBase< PixelType, 2 >::LoadMedia(), FREE::ParameterListMediaController::LoadMedia(), FREE::PointSetMediaControllerBase< PixelType, 2 >::LoadSetFromSetup(), operator=(), FREE::GenericSetupToImageAdaptor::ReplaceComponent(), FREE::FEMRegistrationProcessor< VImageDimension >::SaveLandmarksToFile(), FREE::PointSetMediaControllerBase< PixelType, 2 >::SaveMedia(), FREE::ParameterListMediaController::SaveMedia(), FREE::PointSetMediaControllerBase< PixelType, 2 >::SaveSetToSetup(), FREE::VersorRigid3DTransformController::SetInitialTransformValues(), FREE::TranslationTransformControllerBase< 3 >::SetInitialTransformValues(), FREE::Similarity2DTransformController::SetInitialTransformValues(), FREE::ScaleTransformControllerBase< 3 >::SetInitialTransformValues(), FREE::Rigid2DTransformController::SetInitialTransformValues(), FREE::Euler3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid3DTransformController::SetInitialTransformValues(), FREE::CenteredRigid2DTransformController::SetInitialTransformValues(), FREE::CenteredEuler3DTransformController::SetInitialTransformValues(), FREE::CenteredAffine3DTransformController::SetInitialTransformValues(), FREE::CenteredAffine2DTransformController::SetInitialTransformValues(), FREE::BSplineDeformableTransformControllerBase< 3, 3 >::SetInitialTransformValues(), FREE::StoreableMediaControllerBase< TMedia >::SetMediaFile(), and FREE::FEMRegistrationProcessor< VImageDimension >::SetRegistrationParameters().

const ParameterCollection& FREE::ComponentSetup::Parameters (  )  const [inline]

Definition at line 99 of file freComponentSetup.h.

References m_Parameters.

ComponentMediaLinks& FREE::ComponentSetup::MediaLinks (  )  [inline]

Function to access the member variable m_Links.

Returns:
Reference to m_Links.

Definition at line 103 of file freComponentSetup.h.

References m_Links.

Referenced by FREE::GenericSetupToImageAdaptor::AdaptComponent(), FREE::ProcessorControllerBase< TControlledProcessor >::CompareValidityTagRequirement(), FREE::GenericSetupToImageAdaptor::ExtendComponent(), FREE::ComponentControllerBase< TControlledComponent >::GenerateProfileTemplateRealization(), FREE::SessionAccessor::GetLinkedMedia(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::MediaBridgeController::GetMediaCasted(), FREE::MediaActualizerController::GetMediaCasted(), FREE::ClosedFormRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::MediaBridgeController::GetMediaControllerID(), FREE::MediaActualizerController::GetMediaControllerID(), FREE::ComponentControllerBase< TControlledComponent >::GetMediaControllerID(), FREE::MediaBridgeController::GetMediaValidityTag(), FREE::MediaActualizerController::GetMediaValidityTag(), FREE::MediaBridgeController::GetMediaValidityTagRequirement(), FREE::MediaActualizerController::GetMediaValidityTagRequirement(), FREE::FEMRegistrationControllerBase< FREE::FEMRegistrationProcessor >::GetMediaValidityTagRequirement(), FREE::DemonRegistrationControllerBase< FREE::DemonRegistrationProcessor >::GetMediaValidityTagRequirement(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetValidityTagRequirement(), FREE::SessionBuilder::LinkMediaToComponent(), FREE::SessionBuilder::LinkMediaToComponentByID(), operator=(), FREE::GenericSetupToImageAdaptor::ReplaceComponent(), FREE::MediaDrainController::SaveAllMedia(), FREE::MediaDrainController::SaveMedia(), and FREE::MediaBridgeController::SetMediaCasted().

const ComponentMediaLinks& FREE::ComponentSetup::MediaLinks (  )  const [inline]

Definition at line 104 of file freComponentSetup.h.

References m_Links.

ComponentSetupCollection& FREE::ComponentSetup::Components (  )  [inline]

Function to access the member variable m_Components.

Returns:
Reference to m_Components.

Definition at line 108 of file freComponentSetup.h.

References m_Components.

Referenced by FREE::SetupManager::ActualizeConstraintCache(), FREE::GenericSetupToImageAdaptor::AdaptComponent(), FREE::ComponentControllerBase< TControlledComponent >::BuildSubComponents(), FREE::SessionBuilder::CheckComponentNecessity(), FREE::MultiRigidRegistrationProcessor< VImageDimension >::ComputeRegistration(), FREE::SingleRigidRegistrationProcessorBase< TRegistrationMethod, TTransformBase, TInterpolateBase, TMetricBase, TOptimizerBase, VImageDimension >::ComputeRegistration(), FREE::PointSetRegistrationProcessor< VImageDimension >::ComputeRegistration(), FREE::ClosedFormRegistrationProcessor< VImageDimension >::ComputeRegistration(), FREE::ComponentSetupBrowser::CrawlComponentByIDPath(), FREE::GenericSetupToImageAdaptor::ExtendComponent(), FREE::SessionBuilder::GeneratePassiveComponentCache(), FREE::MediaDrainController::GenerateProfile(), FREE::ComponentControllerBase< TControlledComponent >::GenerateProfileTemplateRealization(), GetComponentByIDPath(), FREE::FEMRegistrationProcessor< VImageDimension >::GetMaxIterationCount(), FREE::MediaContainerController::GetMediaControllerID(), FREE::SetupManager::InitializeComponentSetup(), FREE::SetupInterpolator::InterpolateComponent(), operator=(), FREE::GenericSetupToImageAdaptor::OverwriteComponent(), FREE::GenericSetupToImageAdaptor::ReplaceComponent(), FREE::SetupSavingHelper::SaveData(), and FREE::SetupLoadingHelper::SubElementLoadProcessing().

const ComponentSetupCollection& FREE::ComponentSetup::Components (  )  const [inline]

Definition at line 109 of file freComponentSetup.h.

References m_Components.

bool FREE::ComponentSetup::HasParentComponent (  )  const

Returns true if the component has a parent component

Definition at line 80 of file freComponentSetup.cxx.

References m_pParent.

Referenced by GetIDPath().

const ComponentSetup * FREE::ComponentSetup::GetParentComponent (  )  const

Returns a pointer to the parent component.

Returns:
If no parent has been specified, the return is NULL.

Definition at line 87 of file freComponentSetup.cxx.

References m_pParent.

Referenced by FREE::ComponentSetupBrowser::CrawlComponentByIDPath(), GetComponentByIDPath(), and FREE::SetupManager::GetPossibleControllers().

ComponentSetup * FREE::ComponentSetup::GetParentComponent (  ) 

Definition at line 92 of file freComponentSetup.cxx.

References m_pParent.

const ComponentSetup * FREE::ComponentSetup::GetRootComponent (  )  const

Returns a pointer to the first component without parent.

Remarks:
If no parent has been specified, the return is the this pointer, because an item is at least its own root. So there is never an item without a root.

Definition at line 97 of file freComponentSetup.cxx.

References GetRootComponent(), and m_pParent.

Referenced by FREE::ComponentSetupBrowser::CrawlComponentByIDPath(), GetComponentByIDPath(), and GetRootComponent().

Here is the call graph for this function:

ComponentSetup * FREE::ComponentSetup::GetRootComponent (  ) 

Definition at line 105 of file freComponentSetup.cxx.

References GetRootComponent(), and m_pParent.

Here is the call graph for this function:

FREE::ComponentSetup::GetRootComponent

ComponentSetup * FREE::ComponentSetup::GetComponentByIDPath ( const IDPath &  idPath  ) 

Retrieve a component by a given component ID path

Parameters:
[in] idPath The component ID path addressing the wanted component.
Returns:
Returns the pointer to the addressed component. If no component has been found under the specified path, the return is NULL

Definition at line 113 of file freComponentSetup.cxx.

References Components(), GetComponentByIDPath(), FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElement(), FREE::IDPath::GetFirstComponent(), GetParentComponent(), GetRootComponent(), FREE::IDPath::GetSubIDPath(), FREE::IDPath::IsAbsolute(), FREE::IDPath::IsEmpty(), FREE::IDPath::PTAnyChild, FREE::IDPath::PTAnyDescendant, FREE::IDPath::PTComponent, FREE::IDPath::PTNULL, FREE::IDPath::PTParent, FREE::IDPath::SetAbsolute(), throwExceptionMacro, and FREE::IDPath::ToStr().

Referenced by FREE::HistogramMetricControllerBase< TControlledCompareHistogramMetric >::ActualizeMainComponent(), FREE::ExhaustiveSOOptimizerController::ActualizeMainComponent(), FREE::ConjugateGradientOptimizerController::ActualizeMainComponent(), FREE::AmoebaOptimizerController::ActualizeMainComponent(), GetComponentByIDPath(), and FREE::ParameterListIO::LoadListFromFile().

Here is the call graph for this function:

FREE::ComponentSetup::ComponentsFREE::KeyedCollectionBase::GetElementFREE::IDPath::GetFirstComponentFREE::ComponentSetup::GetParentComponentFREE::ComponentSetup::GetRootComponentFREE::IDPath::GetSubIDPathFREE::IDPath::SetAbsoluteFREE::IDPath::IsAbsoluteFREE::IDPath::IsEmptyFREE::IDPath::ToStrFREE::KeyedCollectionBase::GetElementIndexFREE::IDPath::GetComponentFREE::IDPath::SizeFREE::IDPath::AssembleIDPathFREE::IDPath::AddComponent

IDPath FREE::ComponentSetup::GetIDPath (  )  const

Returns the complete component ID path of this setup component.

Definition at line 154 of file freComponentSetup.cxx.

References GetIDPath(), HasParentComponent(), m_ComponentID, and m_pParent.

Referenced by FREE::SetupManager::ActualizeConstraintCache(), FREE::SessionBuilder::BuildComponent(), FREE::SessionComponentCache::GetIDPath(), GetIDPath(), FREE::SetupManager::GetPossibleControllers(), FREE::SetupManager::InitializeComponentSetup(), and FREE::SetupInterpolator::InterpolateComponent().

Here is the call graph for this function:

FREE::ComponentSetup::HasParentComponent

bool FREE::ComponentSetup::operator== ( const std::string &  sControllerID  )  const

Operator compares the m_Name variable with the second operand. In case of identity the result is true, otherwise it is false.

Definition at line 50 of file freComponentSetup.cxx.

References m_sControllerID.

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

Assignment operator.

Definition at line 57 of file freComponentSetup.cxx.

References Components(), GetComment(), GetComponentID(), GetControllerID(), GetTemplateID(), m_ComponentID, m_Components, m_Links, m_Parameters, m_sComment, m_sControllerID, m_sTemplateID, MediaLinks(), Parameters(), and Reset().

Referenced by FREE::Adaptation::AdaptationComponent::operator=().

Here is the call graph for this function:

FREE::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::ComponentSetup::ResetParameters (  )  [virtual]

Definition at line 224 of file freComponentSetup.cxx.

References m_Parameters, and FREE::ParameterCollection::Reset().

Referenced by FREE::ComponentAdaptorBase::Adapt(), and Reset().

Here is the call graph for this function:

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

void FREE::ComponentSetup::Reset (  )  [virtual]

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

Reimplemented from FREE::XMLStreamObject.

Reimplemented in FREE::Adaptation::AdaptationComponent.

Definition at line 211 of file freComponentSetup.cxx.

References m_ComponentID, m_Components, m_Links, m_sComment, m_sControllerID, m_sTemplateID, FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::Reset(), FREE::XMLStreamObject::Reset(), and ResetParameters().

Referenced by ComponentSetup(), FREE::SetupManager::InitializeComponentSetup(), operator=(), FREE::Adaptation::AdaptationComponent::Reset(), and ~ComponentSetup().

Here is the call graph for this function:

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

void FREE::ComponentSetup::SubElementLoadProcessing ( const std::string &  rsXMLSubTag,
const std::string &  rsXMLSubElement,
const std::string &  rsXMLSubData 
) [protected, virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 231 of file freComponentSetup.cxx.

References FREE::cXML_ComponentComment, FREE::cXML_ComponentParameters, FREE::cXML_Components, FREE::cXML_MediaLinks, FREE::XMLStreamObject::cXML_Text, FREE::XMLStreamObject::LoadFromString(), m_Components, m_Links, m_Parameters, m_sComment, and throwExceptionMacro.

Here is the call graph for this function:

FREE::XMLStreamObject::LoadFromStringFREE::XMLStreamObject::CB_Static_EndElementFREE::XMLStreamObject::CB_Static_StartElementFREE::XMLStreamObject::CheckValidLoadingFREE::XMLStreamObject::FinalizeLoadingFREE::XMLStreamObject::ResetFREE::XMLStreamObject::ResetLoadingHelpersFREE::XMLStreamObject::ResetRequirementsFREE::Convert::ToStrFREE::XMLStreamObject::CB_EndElementFREE::XMLStreamObject::CB_Static_CharacterDataHandlerFREE::XMLStreamObject::CommitSubElementFREE::XMLStreamObject::CB_CharacterDataHandlerFREE::XMLStreamObject::ExtractSubElementContentStringFREE::XMLStreamObject::ExtractSubElementXmlStringFREE::XMLStreamObject::NotifyFoundSubElementFREE::XMLStreamObject::SubElementLoadProcessingFREE::XMLStreamObject::CB_StartElementFREE::XMLStreamObject::AttributesLoadProcessingFREE::XMLStreamObject::ConvertExpatAttrToMapFREE::XMLStreamObject::GetXMLTagFREE::XMLStreamObject::SetNeededSubElements

std::string FREE::ComponentSetup::SaveData ( const unsigned int &  iDepth,
bool &  bHasSubElements 
) const [protected, virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 254 of file freComponentSetup.cxx.

References FREE::XMLStreamObject::AddSubElement(), FREE::cXML_ComponentComment, m_Components, m_Links, m_Parameters, m_sComment, FREE::CollectionBase< TElement, TStorageType >::Size(), and FREE::ParameterCollection::Size().

Here is the call graph for this function:

FREE::XMLStreamObject::AddSubElementFREE::CollectionBase::SizeFREE::ParameterCollection::SizeFREE::XMLStreamObject::AddIndentationFREE::XMLStreamObject::CreateSimpleElementFREE::Convert::ToStr

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

Reimplemented in FREE::Adaptation::AdaptationComponent.

Definition at line 267 of file freComponentSetup.cxx.

References FREE::cXML_ComponentControllerID, FREE::cXML_ComponentID, FREE::cXML_TemplateID, m_ComponentID, m_sControllerID, and m_sTemplateID.

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

Reimplemented in FREE::Adaptation::AdaptationComponent.

Definition at line 279 of file freComponentSetup.cxx.

References FREE::csUndefinedController, FREE::cXML_ComponentControllerID, FREE::cXML_ComponentID, FREE::cXML_TemplateID, IsTemplateBased(), m_ComponentID, m_sControllerID, and m_sTemplateID.

Here is the call graph for this function:

FREE::ComponentSetup::IsTemplateBased

Member Data Documentation

std::string FREE::ComponentSetup::m_sControllerID [protected]

m_sControllerID should contain the identification name of the controller, who is going to initialize the setup and work with it. If m_sControllerID is "" there is no controller chosen yet and the component is not ready for service.

Definition at line 177 of file freComponentSetup.h.

Referenced by AttributesLoadProcessing(), FREE::Adaptation::AdaptationComponent::AttributesLoadProcessing(), GetControllerID(), operator=(), operator==(), Reset(), SaveAttributes(), FREE::Adaptation::AdaptationComponent::SaveAttributes(), and SetControllerID().

std::string FREE::ComponentSetup::m_sComment [protected]

Can be used to store a description or comment on the component.

Definition at line 180 of file freComponentSetup.h.

Referenced by GetComment(), operator=(), Reset(), SaveData(), SetComment(), and SubElementLoadProcessing().

ComponentID FREE::ComponentSetup::m_ComponentID [protected]

m_ComponentID is the ComponentID for this component setup. As an identifier, it is unique in the set of all sibling components (so with same parent) and the basis for the IDPathes.

Definition at line 185 of file freComponentSetup.h.

Referenced by AttributesLoadProcessing(), FREE::Adaptation::AdaptationComponent::AttributesLoadProcessing(), ComponentSetup(), GetComponentID(), GetIDPath(), operator=(), FREE::Adaptation::AdaptationComponent::operator=(), Reset(), SaveAttributes(), and SetComponentID().

std::string FREE::ComponentSetup::m_sTemplateID [protected]

If a component is a subcomponent and based on a component template of the profile, the component ID of this template will be stored as template ID to mark this fact. This is needed for example to allow the generation of proper component profiles. (see also ComponentControllerBase::GenerateProfileTemplateRealization()

Definition at line 192 of file freComponentSetup.h.

Referenced by AttributesLoadProcessing(), GetTemplateID(), IsTemplateBased(), operator=(), Reset(), SaveAttributes(), and SetTemplateID().

ParameterCollection FREE::ComponentSetup::m_Parameters [protected]

Parameters of this component

Definition at line 195 of file freComponentSetup.h.

Referenced by operator=(), Parameters(), ResetParameters(), SaveData(), and SubElementLoadProcessing().

ComponentMediaLinks FREE::ComponentSetup::m_Links [protected]

media links of this component

Definition at line 198 of file freComponentSetup.h.

Referenced by MediaLinks(), operator=(), Reset(), SaveData(), and SubElementLoadProcessing().

ComponentSetupCollection* FREE::ComponentSetup::m_Components [protected]

Subcomponents of this section/component

Definition at line 201 of file freComponentSetup.h.

Referenced by Components(), ComponentSetup(), operator=(), Reset(), SaveData(), SubElementLoadProcessing(), and ~ComponentSetup().

ComponentSetup* FREE::ComponentSetup::m_pParent [protected]

Pointer to the parent component. If Pointer is NULL no parent has been defined.

Definition at line 204 of file freComponentSetup.h.

Referenced by ComponentSetup(), GetIDPath(), GetParentComponent(), GetRootComponent(), and HasParentComponent().

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