FREE::XMLCollectionBase< TXMLElement > Class Template Reference
[XML streaming]

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

#include <freXMLCollectionBase.h>

Inheritance diagram for FREE::XMLCollectionBase< TXMLElement >:

[legend]

Collaboration diagram for FREE::XMLCollectionBase< TXMLElement >:

[legend]

List of all members.

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

---

Detailed Description

template<class TXMLElement>
class FREE::XMLCollectionBase< TXMLElement >

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 47 of file freXMLCollectionBase.h.

---

Member Typedef Documentation

template<class TXMLElement>

typedef SmartCollectionBase<TXMLElement> FREE::XMLCollectionBase< TXMLElement >::Superclass

Reimplemented from FREE::SmartCollectionBase< TXMLElement >.

Reimplemented in FREE::Adaptation::Adaptation, FREE::Adaptation::AdaptationList, FREE::CtrlProfile::ProfileRequirement, and FREE::CtrlProfile::ProfileRequirements.

Definition at line 50 of file freXMLCollectionBase.h.

template<class TXMLElement>

typedef Superclass::ElementType FREE::XMLCollectionBase< TXMLElement >::ElementType

Reimplemented from FREE::SmartCollectionBase< TXMLElement >.

Definition at line 53 of file freXMLCollectionBase.h.

template<class TXMLElement>

typedef Superclass::ElementVectorType FREE::XMLCollectionBase< TXMLElement >::ElementVectorType

Reimplemented from FREE::SmartCollectionBase< TXMLElement >.

Definition at line 54 of file freXMLCollectionBase.h.

template<class TXMLElement>

typedef Superclass::ElementsCountType FREE::XMLCollectionBase< TXMLElement >::ElementsCountType

Reimplemented from FREE::SmartCollectionBase< TXMLElement >.

Reimplemented in FREE::CtrlProfile::ProfileRequirement, and FREE::CtrlProfile::ProfileRequirements.

Definition at line 55 of file freXMLCollectionBase.h.

---

Constructor & Destructor Documentation

template<class TXMLElement>

FREE::XMLCollectionBase< TXMLElement >::XMLCollectionBase

(

const std::string &

sXMLTag = cXML_Collection

)

[inline]

Normal default Constructor.

Definition at line 59 of file freXMLCollectionBase.h.

template<class TXMLElement>

FREE::XMLCollectionBase< TXMLElement >::XMLCollectionBase

(

const XMLCollectionBase< ElementType > &

rCollection

)

[inline]

Copy constructor

Definition at line 63 of file freXMLCollectionBase.h.

template<class TXMLElement>

virtual FREE::XMLCollectionBase< TXMLElement >::~XMLCollectionBase

(

)

[inline, virtual]

Definition at line 68 of file freXMLCollectionBase.h.

---

Member Function Documentation

template<class TXMLElement>

virtual const char* FREE::XMLCollectionBase< TXMLElement >::GetNameOfClass

(

)

const [inline, virtual]

Reimplemented from FREE::XMLStreamObject.

Reimplemented in FREE::Adaptation::Adaptation, FREE::Adaptation::AdaptationList, and FREE::CtrlProfile::ProfileRequirement.

Definition at line 50 of file freXMLCollectionBase.h.

template<class TXMLElement>

void FREE::XMLCollectionBase< TXMLElement >::Reset

(

)

[inline, virtual]

Resets the sections array.

Reimplemented from FREE::XMLStreamObject.

Reimplemented in FREE::Adaptation::Adaptation, and FREE::CtrlProfile::ProfileRequirement.

Definition at line 34 of file freXMLCollectionBase.txx.

References FREE::XMLStreamObject::Reset().

Referenced by FREE::SetupManager::ActualizeConstraintCache(), FREE::CtrlProfile::ProfileRequirements::ProfileRequirements(), FREE::StatisticDictionary::Reset(), FREE::CtrlProfile::ControllerProfile::Reset(), FREE::SetupManager::SetSetup(), FREE::Adaptation::AdaptationList::~AdaptationList(), FREE::CtrlProfile::ProfileRequirements::~ProfileRequirements(), and FREE::XMLCollectionBase< FREE::Adaptation::AdaptationComponent >::~XMLCollectionBase().

Here is the call graph for this function:

template<class TXMLElement>

XMLCollectionBase< TXMLElement > & FREE::XMLCollectionBase< TXMLElement >::operator=

(

const XMLCollectionBase< TXMLElement > &

rCollection

)

[inline]

Assignment operator. /remark

Definition at line 43 of file freXMLCollectionBase.txx.

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

Here is the call graph for this function:

template<class TXMLElement>

XMLCollectionBase< TXMLElement > & FREE::XMLCollectionBase< TXMLElement >::operator+

(

const XMLCollectionBase< TXMLElement > &

rCollection

)

[inline]

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

Definition at line 55 of file freXMLCollectionBase.txx.

template<class TXMLElement>

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

Reimplemented from FREE::XMLStreamObject.

Reimplemented in FREE::Adaptation::Adaptation, and FREE::Adaptation::AdaptationList.

Definition at line 63 of file freXMLCollectionBase.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:

• freXMLCollectionBase.h
• freXMLCollectionBase.txx

---