FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass > Class Template Reference
[XML streaming]

Template class for all kind of collections. More...

#include <freXMLKeyedCollectionBase.h>

Inheritance diagram for FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >:

[legend]

Collaboration diagram for FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >:

[legend]

List of all members.

Public Types
typedef KeyedCollectionBase < TKey, TXMLElement, TIdentifierClass >	Superclass
typedef Superclass::ElementType	ElementType
typedef Superclass::ElementVectorType	ElementVectorType
typedef Superclass::ElementsCountType	ElementsCountType
Public Member Functions
virtual const char *	GetNameOfClass () const
	XMLKeyedCollectionBase (const std::string &sXMLTag=cXML_Collection)
	XMLKeyedCollectionBase (const XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass > &rCollection)
virtual	~XMLKeyedCollectionBase ()
virtual void	Reset ()
XMLKeyedCollectionBase < TKey, TXMLElement, TIdentifierClass > &	operator= (const XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass > &rCollection)
XMLKeyedCollectionBase < TKey, TXMLElement, TIdentifierClass > &	operator+ (const XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass > &rCollection)
Protected Member Functions
virtual std::string	SaveData (const unsigned int &iDepth, bool &bHasSubElements) const

---

Detailed Description

template<class TKey, class TXMLElement, class TIdentifierClass>
class FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >

Template class for all kind of collections.

The collection has the ability to save to and load from xml, so the used element class must be a derivate of XMLStreamObject.

Remarks:

Loading the collection is not implemented, it must be implemented in derived classes. Saving sub elements is implemented and must not be reimplemented, if no attributes or special sub element treatment is needed.

Definition at line 44 of file freXMLKeyedCollectionBase.h.

---

Member Typedef Documentation

template<class TKey, class TXMLElement, class TIdentifierClass>

typedef KeyedCollectionBase<TKey,TXMLElement,TIdentifierClass> FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::Superclass

Reimplemented from FREE::KeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >.

Reimplemented in FREE::ComponentSetupCollection.

Definition at line 47 of file freXMLKeyedCollectionBase.h.

template<class TKey, class TXMLElement, class TIdentifierClass>

typedef Superclass::ElementType FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::ElementType

Reimplemented from FREE::KeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >.

Definition at line 51 of file freXMLKeyedCollectionBase.h.

template<class TKey, class TXMLElement, class TIdentifierClass>

typedef Superclass::ElementVectorType FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::ElementVectorType

Reimplemented from FREE::KeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >.

Definition at line 52 of file freXMLKeyedCollectionBase.h.

template<class TKey, class TXMLElement, class TIdentifierClass>

typedef Superclass::ElementsCountType FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::ElementsCountType

Reimplemented from FREE::KeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >.

Reimplemented in FREE::ComponentMediaLinks, FREE::CtrlProfile::ProfileMediaMap, FREE::CtrlProfile::ProfileParameters, and FREE::CtrlProfile::ProfileSubComponents.

Definition at line 53 of file freXMLKeyedCollectionBase.h.

---

Constructor & Destructor Documentation

template<class TKey, class TXMLElement, class TIdentifierClass>

FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::XMLKeyedCollectionBase

(

const std::string &

sXMLTag = cXML_Collection

)

[inline]

Normal default Constructor.

Definition at line 56 of file freXMLKeyedCollectionBase.h.

template<class TKey, class TXMLElement, class TIdentifierClass>

FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::XMLKeyedCollectionBase

(

const XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass > &

rCollection

)

[inline]

Copy constructor

Definition at line 60 of file freXMLKeyedCollectionBase.h.

template<class TKey, class TXMLElement, class TIdentifierClass>

virtual FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::~XMLKeyedCollectionBase

(

)

[inline, virtual]

Definition at line 65 of file freXMLKeyedCollectionBase.h.

---

Member Function Documentation

template<class TKey, class TXMLElement, class TIdentifierClass>

virtual const char* FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::GetNameOfClass

(

)

const [inline, virtual]

Reimplemented from FREE::XMLStreamObject.

Reimplemented in FREE::ComponentSetupCollection, and FREE::CtrlProfile::ProfileSubComponents.

Definition at line 47 of file freXMLKeyedCollectionBase.h.

template<class TKey, class TXMLElement, class TIdentifierClass>

void FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::Reset

(

)

[inline, virtual]

Resets the collection array.

Reimplemented from FREE::XMLStreamObject.

Definition at line 34 of file freXMLKeyedCollectionBase.txx.

References FREE::XMLStreamObject::Reset().

Referenced by FREE::ComponentMediaLinks::ComponentMediaLinks(), FREE::CtrlProfile::ProfileMediaMap::ProfileMediaMap(), FREE::CtrlProfile::ProfileParameters::ProfileParameters(), FREE::CtrlProfile::ProfileSubComponents::ProfileSubComponents(), FREE::CtrlProfile::ControllerProfileBase::Reset(), FREE::ComponentSetup::Reset(), FREE::ComponentMediaLinks::~ComponentMediaLinks(), FREE::ComponentSetupCollection::~ComponentSetupCollection(), FREE::CtrlProfile::ProfileMediaMap::~ProfileMediaMap(), FREE::CtrlProfile::ProfileParameters::~ProfileParameters(), FREE::CtrlProfile::ProfileSubComponents::~ProfileSubComponents(), and FREE::XMLKeyedCollectionBase< std::string, FREE::CtrlProfile::Media, FREE::CtrlProfile::MediaIdentifierBase >::~XMLKeyedCollectionBase().

Here is the call graph for this function:

template<class TKey, class TXMLElement, class TIdentifierClass>

XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass > & FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::operator=

(

const XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass > &

rCollection

)

[inline]

Assignment operator. /remark

Definition at line 43 of file freXMLKeyedCollectionBase.txx.

References FREE::XMLStreamObject::LoadFromString(), and FREE::XMLStreamObject::SaveToString().

Here is the call graph for this function:

template<class TKey, class TXMLElement, class TIdentifierClass>

XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass > & FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::operator+

(

const XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass > &

rCollection

)

[inline]

Adds copies of the elements of the passed collection to its own.

Definition at line 55 of file freXMLKeyedCollectionBase.txx.

template<class TKey, class TXMLElement, class TIdentifierClass>

std::string FREE::XMLKeyedCollectionBase< TKey, TXMLElement, TIdentifierClass >::SaveData	(	const unsigned int &	iDepth,
		bool &	bHasSubElements
	)			const [inline, protected, virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 63 of file freXMLKeyedCollectionBase.txx.

References FREE::XMLStreamObject::AddSubElement(), and FREE::CollectionBase< TXMLElement, itk::SmartPointer< TXMLElement > >::m_Elements.

Here is the call graph for this function:

---

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

• freXMLKeyedCollectionBase.h
• freXMLKeyedCollectionBase.txx

---