FREE::KeyedCollectionBase

FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass > Class Template Reference

Template class for all kind of collections containing keyed elements. The collection is able to contain and handle elements with a key as identifier. The collection uses IdentifierClass for any search or compare operation. More...

#include <freKeyedCollectionBase.h>

Inheritance diagram for FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >:

Inheritance graph
FREE::ComponentCacheCollection\< std::string, TCache, FREE::ComponentCacheIdentifier\< TCache \> \>FREE::XMLKeyedCollectionBase\< std::string, FREE::ComponentMediaLink, FREE::ComponentMediaLinkIdentifier \>FREE::XMLKeyedCollectionBase\< std::string, FREE::ComponentSetup, FREE::ComponentSetupIdentifier \>FREE::XMLKeyedCollectionBase\< std::string, FREE::CtrlProfile::Media, FREE::CtrlProfile::MediaIdentifierBase \>FREE::XMLKeyedCollectionBase\< std::string, FREE::CtrlProfile::Parameter, FREE::CtrlProfile::ProfileParameterIdentifier \>FREE::XMLKeyedCollectionBase\< std::string, FREE::CtrlProfile::SubComponent, FREE::CtrlProfile::ProfileSubCompIdentifier \>FREE::SmartCollectionBase\< TElement \>FREE::CollectionBase\< TElement, itk::SmartPointer\< TElement \> \>
[legend]
Collaboration diagram for FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >:

Collaboration graph
FREE::SmartCollectionBase\< TElement \>FREE::CollectionBase\< TElement, itk::SmartPointer\< TElement \> \>
[legend]

List of all members.

Public Types

typedef TKey KeyType
typedef TIdentifierClass IdentifierType
typedef
SmartCollectionBase
< TElement > 		Superclass
typedef
Superclass::ElementType 		ElementType
typedef
Superclass::ElementVectorType 		ElementVectorType
typedef
Superclass::ElementsCountType 		ElementsCountType

Public Member Functions

virtual const char * GetNameOfClass () const
 KeyedCollectionBase ()
 KeyedCollectionBase (const KeyedCollectionBase< TKey, TElement, TIdentifierClass > &rCollection)
KeyedCollectionBase & operator= (const KeyedCollectionBase &rCollection)
ElementsCountType GetElementIndex (const KeyType &rKey) const
ElementType * GetElement (const KeyType &rKey) const

Detailed Description

template<class TKey, class TElement, class TIdentifierClass>
class FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >

Template class for all kind of collections containing keyed elements. The collection is able to contain and handle elements with a key as identifier. The collection uses IdentifierClass for any search or compare operation.

Definition at line 49 of file freKeyedCollectionBase.h.

Member Typedef Documentation

template<class TKey, class TElement, class TIdentifierClass>
typedef TKey FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::KeyType

Definition at line 52 of file freKeyedCollectionBase.h.

template<class TKey, class TElement, class TIdentifierClass>
typedef TIdentifierClass FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::IdentifierType

Definition at line 53 of file freKeyedCollectionBase.h.

template<class TKey, class TElement, class TIdentifierClass>
typedef SmartCollectionBase<TElement> FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::Superclass

Reimplemented from FREE::SmartCollectionBase< TElement >.

Reimplemented in FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >, FREE::ComponentSetupCollection, FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::Parameter, FREE::CtrlProfile::ProfileParameterIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::ComponentSetup, FREE::ComponentSetupIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::ComponentMediaLink, FREE::ComponentMediaLinkIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::SubComponent, FREE::CtrlProfile::ProfileSubCompIdentifier >, and FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::Media, FREE::CtrlProfile::MediaIdentifierBase >.

Definition at line 54 of file freKeyedCollectionBase.h.

template<class TKey, class TElement, class TIdentifierClass>
typedef Superclass::ElementType FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::ElementType

Reimplemented from FREE::SmartCollectionBase< TElement >.

Reimplemented in FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >, FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::Parameter, FREE::CtrlProfile::ProfileParameterIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::ComponentSetup, FREE::ComponentSetupIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::ComponentMediaLink, FREE::ComponentMediaLinkIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::SubComponent, FREE::CtrlProfile::ProfileSubCompIdentifier >, and FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::Media, FREE::CtrlProfile::MediaIdentifierBase >.

Definition at line 56 of file freKeyedCollectionBase.h.

template<class TKey, class TElement, class TIdentifierClass>
typedef Superclass::ElementVectorType FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::ElementVectorType

Reimplemented from FREE::SmartCollectionBase< TElement >.

Reimplemented in FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >, FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::Parameter, FREE::CtrlProfile::ProfileParameterIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::ComponentSetup, FREE::ComponentSetupIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::ComponentMediaLink, FREE::ComponentMediaLinkIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::SubComponent, FREE::CtrlProfile::ProfileSubCompIdentifier >, and FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::Media, FREE::CtrlProfile::MediaIdentifierBase >.

Definition at line 57 of file freKeyedCollectionBase.h.

template<class TKey, class TElement, class TIdentifierClass>
typedef Superclass::ElementsCountType FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::ElementsCountType

Reimplemented from FREE::SmartCollectionBase< TElement >.

Reimplemented in FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >, FREE::ComponentMediaLinks, FREE::CtrlProfile::ProfileMediaMap, FREE::CtrlProfile::ProfileParameters, FREE::CtrlProfile::ProfileSubComponents, FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::Parameter, FREE::CtrlProfile::ProfileParameterIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::ComponentSetup, FREE::ComponentSetupIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::ComponentMediaLink, FREE::ComponentMediaLinkIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::SubComponent, FREE::CtrlProfile::ProfileSubCompIdentifier >, and FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::Media, FREE::CtrlProfile::MediaIdentifierBase >.

Definition at line 58 of file freKeyedCollectionBase.h.

Constructor & Destructor Documentation

template<class TKey, class TElement, class TIdentifierClass>
FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::KeyedCollectionBase (  )  [inline]

Normal default Constructor.

Definition at line 63 of file freKeyedCollectionBase.h.

template<class TKey, class TElement, class TIdentifierClass>
FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::KeyedCollectionBase ( const KeyedCollectionBase< TKey, TElement, TIdentifierClass > &  rCollection  )  [inline]

Copy constructor

Definition at line 67 of file freKeyedCollectionBase.h.

Member Function Documentation

template<class TKey, class TElement, class TIdentifierClass>
virtual const char* FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetNameOfClass (  )  const [inline, virtual]

Reimplemented from FREE::SmartCollectionBase< TElement >.

Reimplemented in FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >, FREE::ComponentCacheCollection< TCache >, FREE::ComponentSetupCollection, FREE::CtrlProfile::ProfileSubComponents, FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::Parameter, FREE::CtrlProfile::ProfileParameterIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::ComponentSetup, FREE::ComponentSetupIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::ComponentMediaLink, FREE::ComponentMediaLinkIdentifier >, FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::SubComponent, FREE::CtrlProfile::ProfileSubCompIdentifier >, and FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::Media, FREE::CtrlProfile::MediaIdentifierBase >.

Definition at line 60 of file freKeyedCollectionBase.h.

template<class TKey, class TElement, class TIdentifierClass>
KeyedCollectionBase< TKey, TElement, TIdentifierClass > & FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::operator= ( const KeyedCollectionBase< TKey, TElement, TIdentifierClass > &  rCollection  )  [inline]

Assignment operator. /remark

Definition at line 34 of file freKeyedCollectionBase.txx.

References FREE::CollectionBase< TElement, itk::SmartPointer< TElement > >::AddElements(), and FREE::CollectionBase< TElement, itk::SmartPointer< TElement > >::Reset().

Here is the call graph for this function:

FREE::CollectionBase\< TElement, itk::SmartPointer\< TElement \> \>::AddElementsFREE::CollectionBase\< TElement, itk::SmartPointer\< TElement \> \>::Reset

template<class TKey, class TElement, class TIdentifierClass>
KeyedCollectionBase< TKey, TElement, TIdentifierClass >::ElementsCountType FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElementIndex ( const KeyType &  rKey  )  const [inline]

Returns the index of an element.

Parameters:
[in] rKey Key/ID of the wanted element.
Returns:
The index within the collection. If the parameter does not exist, the return is -1.

Definition at line 60 of file freKeyedCollectionBase.txx.

References FREE::CollectionBase< TElement, itk::SmartPointer< TElement > >::m_Elements, and FREE::CollectionBase< TElement, itk::SmartPointer< TElement > >::NULL_Index.

Referenced by FREE::GenericSetupToImageAdaptor::AdaptComponent(), FREE::GenericSetupToImageAdaptor::ExtendComponent(), and FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElement().

template<class TKey, class TElement, class TIdentifierClass>
KeyedCollectionBase< TKey, TElement, TIdentifierClass >::ElementType * FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElement ( const KeyType &  rKey  )  const [inline]

Returns a pointer to an element.

Parameters:
[in] rKey Key/ID of the wanted element.
Returns:
A pointer to the element. If the element does not exist, the return is NULL.

Definition at line 47 of file freKeyedCollectionBase.txx.

References FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElementIndex(), and FREE::CollectionBase< TElement, itk::SmartPointer< TElement > >::NULL_Index.

Referenced by FREE::SetupManager::ActualizeConstraintCache(), FREE::GenericSetupToImageAdaptor::AdaptComponent(), FREE::ComponentControllerBase< TControlledComponent >::BuildSubComponents(), FREE::SessionBuilder::CheckComponentNecessity(), FREE::ProcessorControllerBase< TControlledProcessor >::CompareValidityTagRequirement(), 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(), FREE::ComponentSetup::GetComponentByIDPath(), FREE::SessionComponentCache::GetConstCacheByIDPath(), FREE::SessionAccessor::GetLinkedMedia(), FREE::FEMRegistrationProcessor< VImageDimension >::GetMaxIterationCount(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::MediaBridgeController::GetMediaCasted(), FREE::MediaActualizerController::GetMediaCasted(), FREE::ClosedFormRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::MediaContainerController::GetMediaControllerID(), 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::SetupManager::InitializeComponentSetup(), FREE::SetupInterpolator::InterpolateComponent(), FREE::SessionBuilder::LinkMediaToComponent(), FREE::SessionBuilder::LinkMediaToComponentByID(), FREE::GenericSetupToImageAdaptor::OverwriteComponent(), FREE::CtrlProfile::ProfileOption::ProfileMatchesOption(), FREE::MediaDrainController::SaveAllMedia(), FREE::SetupSavingHelper::SaveData(), FREE::MediaDrainController::SaveMedia(), and FREE::MediaBridgeController::SetMediaCasted().

Here is the call graph for this function:

FREE::KeyedCollectionBase::GetElementIndex

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