FREE::CtrlProfile::ProfileOption

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

Base class for component profiles. More...

#include <freProfileOption.h>

Inheritance diagram for FREE::CtrlProfile::ProfileOption:

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

Collaboration graph
FREE::CtrlProfile::ControllerProfileBaseFREE::XMLStreamObjectFREE::XMLKeyedCollectionBase\< std::string, FREE::CtrlProfile::Parameter, FREE::CtrlProfile::ProfileParameterIdentifier \>FREE::XMLKeyedCollectionBase\< std::string, FREE::CtrlProfile::Media, FREE::CtrlProfile::MediaIdentifierBase \>FREE::XMLKeyedCollectionBase\< std::string, FREE::CtrlProfile::SubComponent, FREE::CtrlProfile::ProfileSubCompIdentifier \>FREE::XMLStringMultiMapFREE::CtrlProfile::ProfileParametersFREE::KeyedCollectionBase\< TKey, TXMLElement, TIdentifierClass \>FREE::SmartCollectionBase\< TXMLElement \>FREE::CollectionBase\< TXMLElement, itk::SmartPointer\< TXMLElement \> \>FREE::CtrlProfile::ProfileMediaMapFREE::CtrlProfile::ProfileSubComponentsFREE::CtrlProfile::ProfileInheritance
[legend]

List of all members.

Public Types

typedef ProfileOption Self
typedef
ControllerProfileBase 		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 CheckForControllerID ()
void CheckForInheritance ()
void CheckForDescription ()
void CheckForParameters ()
void CheckForSubComponents ()
void CheckForIO ()
bool ProfileMatchesOption (const ControllerProfileBase &profile) const
ProfileOption & operator= (const ProfileOption &rProfile)
virtual void Reset ()

Static Public Member Functions

static Pointer New (void)

Protected Member Functions

 ProfileOption ()
virtual ~ProfileOption ()
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

Protected Attributes

bool m_bControllerID
bool m_bInheritance
bool m_bDescription
bool m_bParameters
bool m_bSubComponents
bool m_bIO

Private Member Functions

 ProfileOption (const ProfileOption &rProfile)

Detailed Description

Base class for component profiles.

ControllerProfileBase is the base class of profiles characterizing a component and ensure the assembly of reasonable setups. From this base class the real profile is derived as well as profile options for requirement definitions.

Definition at line 41 of file freProfileOption.h.

Member Typedef Documentation

typedef ProfileOption FREE::CtrlProfile::ProfileOption::Self

Reimplemented from FREE::CtrlProfile::ControllerProfileBase.

Definition at line 44 of file freProfileOption.h.

typedef ControllerProfileBase FREE::CtrlProfile::ProfileOption::Superclass

Reimplemented from FREE::CtrlProfile::ControllerProfileBase.

Definition at line 45 of file freProfileOption.h.

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

Reimplemented from FREE::CtrlProfile::ControllerProfileBase.

Definition at line 46 of file freProfileOption.h.

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

Reimplemented from FREE::CtrlProfile::ControllerProfileBase.

Definition at line 47 of file freProfileOption.h.

Constructor & Destructor Documentation

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

Definition at line 108 of file freProfileOption.cxx.

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

Here is the call graph for this function:

FREE::CtrlProfile::ProfileOption::ResetFREE::XMLStreamObject::SetXMLTagFREE::CtrlProfile::ControllerProfileBase::ResetFREE::XMLKeyedCollectionBase::ResetFREE::XMLStreamObject::ResetFREE::XMLStringMultiMap::Reset

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

Definition at line 150 of file freProfileOption.cxx.

References Reset().

Here is the call graph for this function:

FREE::CtrlProfile::ProfileOption::ResetFREE::CtrlProfile::ControllerProfileBase::ResetFREE::XMLKeyedCollectionBase::ResetFREE::XMLStreamObject::ResetFREE::XMLStringMultiMap::Reset

FREE::CtrlProfile::ProfileOption::ProfileOption ( const ProfileOption &  rProfile  )  [private]

suppresses default copy constructor

Member Function Documentation

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

Reimplemented from FREE::CtrlProfile::ControllerProfileBase.

Definition at line 49 of file freProfileOption.h.

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

Reimplemented from FREE::CtrlProfile::ControllerProfileBase.

Definition at line 50 of file freProfileOption.h.

Referenced by FREE::CtrlProfile::ProfileRequirement::AddProfileOption(), and FREE::CtrlProfile::ProfileRequirement::SubElementLoadProcessing().

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

Reimplemented from FREE::CtrlProfile::ControllerProfileBase.

Definition at line 50 of file freProfileOption.h.

void FREE::CtrlProfile::ProfileOption::CheckForControllerID (  )  [inline]

Definition at line 52 of file freProfileOption.h.

References m_bControllerID.

void FREE::CtrlProfile::ProfileOption::CheckForInheritance (  )  [inline]

Definition at line 53 of file freProfileOption.h.

References m_bInheritance.

Referenced by FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::CompareHistogramMetricControllerBase(), FREE::WarpImageFilterControllerBase< FREE::ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::TransformationFieldType >::GenerateProfile(), FREE::VersorTransformOptimizerController::GenerateProfile(), FREE::VersorTransformController::GenerateProfile(), FREE::VersorRigid3DTransformOptimizerController::GenerateProfile(), FREE::VersorRigid3DTransformController::GenerateProfile(), FREE::SVNonLinearOptimizerControllerBase< TControlledOptimizer >::GenerateProfile(), FREE::SetupOptimizationProcessorController::GenerateProfile(), FREE::SetupOptimizationOptimizerControllerBase< TControlledOptimizer >::GenerateProfile(), FREE::SetupOptimizationMetricControllerBase< TControlledMetric >::GenerateProfile(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GenerateProfile(), FREE::ResampleImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::GenerateProfile(), FREE::PrecisionSOMetricController::GenerateProfile(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::GenerateProfile(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GenerateProfile(), FREE::OnePlusOneEvolutionarySOOptimizerController::GenerateProfile(), FREE::OnePlusOneEvolutionaryOptimizerController::GenerateProfile(), FREE::MediaDrainController::GenerateProfile(), FREE::ImageRegistrationControllerBase< TControlledProcessor >::GenerateProfile(), FREE::EvolutionaryStrategySOOptimizerController::GenerateProfile(), FREE::EvolutionaryStrategyOptimizerController::GenerateProfile(), FREE::ESDiscriminativeRecombinatorController::GenerateProfile(), FREE::ESCMAMutationController::GenerateProfile(), FREE::DemonRegistrationControllerBase< FREE::DemonRegistrationProcessor >::GenerateProfile(), FREE::ConstrainedOnePlusOneEvolutionarySOOptimizerController::GenerateProfile(), and FREE::ClosedFormRegistrationControllerBase< TControlledRigidProcessor >::GenerateProfile().

void FREE::CtrlProfile::ProfileOption::CheckForDescription (  )  [inline]

Definition at line 54 of file freProfileOption.h.

References m_bDescription.

void FREE::CtrlProfile::ProfileOption::CheckForParameters (  )  [inline]

Definition at line 55 of file freProfileOption.h.

References m_bParameters.

void FREE::CtrlProfile::ProfileOption::CheckForSubComponents (  )  [inline]

Definition at line 56 of file freProfileOption.h.

References m_bSubComponents.

void FREE::CtrlProfile::ProfileOption::CheckForIO (  )  [inline]

Definition at line 57 of file freProfileOption.h.

References m_bIO.

Referenced by FREE::SetupManager::ActualizeConstraintCache(), FREE::CompareHistogramMetricControllerBase< TControlledCompareHistogramMetric >::CompareHistogramMetricControllerBase(), FREE::WarpImageFilterControllerBase< FREE::ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::TransformationFieldType >::GenerateProfile(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GenerateProfile(), FREE::ResampleImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::GenerateProfile(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::GenerateProfile(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GenerateProfile(), FREE::ImageRegistrationControllerBase< TControlledProcessor >::GenerateProfile(), FREE::DemonRegistrationControllerBase< FREE::DemonRegistrationProcessor >::GenerateProfile(), and FREE::ClosedFormRegistrationControllerBase< TControlledRigidProcessor >::GenerateProfile().

bool FREE::CtrlProfile::ProfileOption::ProfileMatchesOption ( const ControllerProfileBase &  profile  )  const

Function checks of the profile option matches the passed profile and returns the checking result.

Parameters:
profile The profile that should be compared with the profile option (this).
Returns:
True if the passed profile matches the option, false if not.

Definition at line 31 of file freProfileOption.cxx.

References FREE::CtrlProfile::ControllerProfileBase::ControllerID(), FREE::CtrlProfile::ControllerProfileBase::Description(), FREE::CtrlProfile::Media::DT_AllDimensions, FREE::CtrlProfile::ProfileInheritance::GetAncestor(), FREE::CtrlProfile::SubComponent::GetComponentID(), FREE::CtrlProfile::Media::GetDimension(), FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElement(), FREE::Parameter::GetParameterName(), FREE::CtrlProfile::ControllerProfileBase::Inheritance(), FREE::CtrlProfile::ProfileInheritance::IsChildOf(), m_bControllerID, m_bDescription, m_bInheritance, m_bIO, m_bParameters, m_bSubComponents, FREE::CtrlProfile::ControllerProfileBase::m_Inheritance, FREE::CtrlProfile::ControllerProfileBase::m_MediaMap, FREE::CtrlProfile::ControllerProfileBase::m_Parameters, FREE::CtrlProfile::ControllerProfileBase::m_sControllerID, FREE::CtrlProfile::ControllerProfileBase::m_sDescription, FREE::CtrlProfile::ControllerProfileBase::m_SubComponents, FREE::CtrlProfile::ControllerProfileBase::MediaMap(), FREE::CtrlProfile::ProfileParameters::ParameterExists(), FREE::CtrlProfile::ControllerProfileBase::Parameters(), FREE::CollectionBase< TElement, TStorageType >::Size(), FREE::XMLStringMultiMap::Size(), and FREE::CtrlProfile::ControllerProfileBase::SubComponents().

Referenced by FREE::CtrlProfile::ProfileRequirement::ProfileMatchesRequirement().

Here is the call graph for this function:

FREE::CtrlProfile::ControllerProfileBase::ControllerIDFREE::CtrlProfile::ControllerProfileBase::DescriptionFREE::CtrlProfile::ProfileInheritance::GetAncestorFREE::CtrlProfile::SubComponent::GetComponentIDFREE::CtrlProfile::Media::GetDimensionFREE::KeyedCollectionBase::GetElementFREE::Parameter::GetParameterNameFREE::CtrlProfile::ControllerProfileBase::InheritanceFREE::CtrlProfile::ProfileInheritance::IsChildOfFREE::XMLStringMultiMap::SizeFREE::CtrlProfile::ControllerProfileBase::MediaMapFREE::CtrlProfile::ProfileParameters::ParameterExistsFREE::CtrlProfile::ControllerProfileBase::ParametersFREE::CollectionBase::SizeFREE::CtrlProfile::ControllerProfileBase::SubComponentsFREE::XMLStringMultiMap::GetElementDataFREE::KeyedCollectionBase::GetElementIndexFREE::CtrlProfile::ProfileInheritance::IndexOfAncestor

ProfileOption & FREE::CtrlProfile::ProfileOption::operator= ( const ProfileOption &  rProfile  ) 

Assignment operator

Definition at line 116 of file freProfileOption.cxx.

References FREE::CtrlProfile::ControllerProfileBase::ControllerID(), FREE::CtrlProfile::ControllerProfileBase::Description(), FREE::CtrlProfile::ControllerProfileBase::Inheritance(), m_bControllerID, m_bDescription, m_bInheritance, m_bIO, m_bParameters, m_bSubComponents, FREE::CtrlProfile::ControllerProfileBase::m_Inheritance, FREE::CtrlProfile::ControllerProfileBase::m_MediaMap, FREE::CtrlProfile::ControllerProfileBase::m_Parameters, FREE::CtrlProfile::ControllerProfileBase::m_sControllerID, FREE::CtrlProfile::ControllerProfileBase::m_sDescription, FREE::CtrlProfile::ControllerProfileBase::m_SubComponents, FREE::CtrlProfile::ControllerProfileBase::MediaMap(), FREE::CtrlProfile::ControllerProfileBase::Parameters(), and FREE::CtrlProfile::ControllerProfileBase::SubComponents().

Here is the call graph for this function:

FREE::CtrlProfile::ControllerProfileBase::ControllerIDFREE::CtrlProfile::ControllerProfileBase::DescriptionFREE::CtrlProfile::ControllerProfileBase::InheritanceFREE::CtrlProfile::ControllerProfileBase::MediaMapFREE::CtrlProfile::ControllerProfileBase::ParametersFREE::CtrlProfile::ControllerProfileBase::SubComponents

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

Resets the object to default/initial state

Reimplemented from FREE::CtrlProfile::ControllerProfileBase.

Definition at line 137 of file freProfileOption.cxx.

References m_bControllerID, m_bDescription, m_bInheritance, m_bIO, m_bParameters, m_bSubComponents, and FREE::CtrlProfile::ControllerProfileBase::Reset().

Referenced by ProfileOption(), and ~ProfileOption().

Here is the call graph for this function:

FREE::CtrlProfile::ControllerProfileBase::ResetFREE::XMLKeyedCollectionBase::ResetFREE::XMLStreamObject::ResetFREE::XMLStringMultiMap::Reset

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

Reimplemented from FREE::CtrlProfile::ControllerProfileBase.

Definition at line 157 of file freProfileOption.cxx.

References FREE::cXML_CP_ControllerID, FREE::cXML_CP_Description, FREE::cXML_CP_Inheritance, FREE::cXML_CP_MediaMap, FREE::cXML_CP_Parameters, FREE::cXML_CP_SubComponents, FREE::XMLStreamObject::LoadFromString(), m_bControllerID, m_bDescription, m_bInheritance, m_bIO, m_bParameters, m_bSubComponents, FREE::CtrlProfile::ControllerProfileBase::m_Inheritance, FREE::CtrlProfile::ControllerProfileBase::m_MediaMap, FREE::CtrlProfile::ControllerProfileBase::m_Parameters, FREE::CtrlProfile::ControllerProfileBase::m_sControllerID, FREE::CtrlProfile::ControllerProfileBase::m_sDescription, and FREE::CtrlProfile::ControllerProfileBase::m_SubComponents.

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::CtrlProfile::ProfileOption::SaveData ( const unsigned int &  iDepth,
bool &  bHasSubElements 
) const [protected, virtual]

Reimplemented from FREE::CtrlProfile::ControllerProfileBase.

Definition at line 193 of file freProfileOption.cxx.

References FREE::XMLStreamObject::AddSubElement(), FREE::cXML_CP_ControllerID, FREE::cXML_CP_Description, m_bControllerID, m_bDescription, m_bInheritance, m_bIO, m_bParameters, m_bSubComponents, FREE::CtrlProfile::ControllerProfileBase::m_Inheritance, FREE::CtrlProfile::ControllerProfileBase::m_MediaMap, FREE::CtrlProfile::ControllerProfileBase::m_Parameters, FREE::CtrlProfile::ControllerProfileBase::m_sControllerID, FREE::CtrlProfile::ControllerProfileBase::m_sDescription, and FREE::CtrlProfile::ControllerProfileBase::m_SubComponents.

Here is the call graph for this function:

FREE::XMLStreamObject::AddSubElementFREE::XMLStreamObject::AddIndentationFREE::XMLStreamObject::CreateSimpleElementFREE::Convert::ToStr

Member Data Documentation

bool FREE::CtrlProfile::ProfileOption::m_bControllerID [protected]

Flags indicating if the information has been specified in the profile option and should be used when checking for matches.

Definition at line 83 of file freProfileOption.h.

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

bool FREE::CtrlProfile::ProfileOption::m_bInheritance [protected]

Definition at line 84 of file freProfileOption.h.

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

bool FREE::CtrlProfile::ProfileOption::m_bDescription [protected]

Definition at line 85 of file freProfileOption.h.

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

bool FREE::CtrlProfile::ProfileOption::m_bParameters [protected]

Definition at line 86 of file freProfileOption.h.

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

bool FREE::CtrlProfile::ProfileOption::m_bSubComponents [protected]

Definition at line 87 of file freProfileOption.h.

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

bool FREE::CtrlProfile::ProfileOption::m_bIO [protected]

Definition at line 88 of file freProfileOption.h.

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

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