FREE::PointSetToXMLStreamObject< TPointSet > Class Template Reference

Helper class that is used to store and load a point set via XML. More...

#include <frePointSetToXMLStreamObject.h>

Inheritance diagram for FREE::PointSetToXMLStreamObject< TPointSet >:

[legend]

Collaboration diagram for FREE::PointSetToXMLStreamObject< TPointSet >:

[legend]

List of all members.

Public Types
typedef PointSetToXMLStreamObject	Self
typedef XMLStreamObject	Superclass
typedef TPointSet	PointSetType
typedef PointSetType::Pointer	PointSetPointer
typedef PointSetType::PointType	PointType
Public Member Functions
	itkTypeMacro (PointSetToXMLStreamObject, XMLStreamObject)
PointSetType *	GetPointSet ()
void	SetPointSet (PointSetType *pSet)
	PointSetToXMLStreamObject ()
Protected Member Functions
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
PointSetPointer	m_PointSet

---

Detailed Description

template<class TPointSet>
class FREE::PointSetToXMLStreamObject< TPointSet >

Helper class that is used to store and load a point set via XML.

Definition at line 40 of file frePointSetToXMLStreamObject.h.

---

Member Typedef Documentation

template<class TPointSet>

typedef PointSetToXMLStreamObject FREE::PointSetToXMLStreamObject< TPointSet >::Self

Standard class typedefs.

Definition at line 45 of file frePointSetToXMLStreamObject.h.

template<class TPointSet>

typedef XMLStreamObject FREE::PointSetToXMLStreamObject< TPointSet >::Superclass

Definition at line 46 of file frePointSetToXMLStreamObject.h.

template<class TPointSet>

typedef TPointSet FREE::PointSetToXMLStreamObject< TPointSet >::PointSetType

Definition at line 47 of file frePointSetToXMLStreamObject.h.

template<class TPointSet>

typedef PointSetType::Pointer FREE::PointSetToXMLStreamObject< TPointSet >::PointSetPointer

Definition at line 48 of file frePointSetToXMLStreamObject.h.

template<class TPointSet>

typedef PointSetType::PointType FREE::PointSetToXMLStreamObject< TPointSet >::PointType

Definition at line 49 of file frePointSetToXMLStreamObject.h.

---

Constructor & Destructor Documentation

template<class TPointSet>

FREE::PointSetToXMLStreamObject< TPointSet >::PointSetToXMLStreamObject

(

)

[inline]

Definition at line 34 of file frePointSetToXMLStreamObject.txx.

---

Member Function Documentation

template<class TPointSet>

FREE::PointSetToXMLStreamObject< TPointSet >::itkTypeMacro	(	PointSetToXMLStreamObject< TPointSet >	,
		XMLStreamObject
	)

Run-time type information (and related methods).

template<class TPointSet>

PointSetToXMLStreamObject< TPointSet >::PointSetType * FREE::PointSetToXMLStreamObject< TPointSet >::GetPointSet

(

)

[inline]

Definition at line 117 of file frePointSetToXMLStreamObject.txx.

References FREE::PointSetToXMLStreamObject< TPointSet >::m_PointSet.

template<class TPointSet>

void FREE::PointSetToXMLStreamObject< TPointSet >::SetPointSet

(

PointSetType *

pSet

)

[inline]

Definition at line 125 of file frePointSetToXMLStreamObject.txx.

References FREE::PointSetToXMLStreamObject< TPointSet >::m_PointSet.

Referenced by FREE::PointSetMediaControllerBase< PixelType, 2 >::LoadMedia(), and FREE::PointSetMediaControllerBase< PixelType, 2 >::SaveMedia().

template<class TPointSet>

void FREE::PointSetToXMLStreamObject< TPointSet >::SubElementLoadProcessing	(	const std::string &	rsXMLSubTag,
		const std::string &	rsXMLSubElement,
		const std::string &	rsXMLSubData
	)			[inline, protected, virtual]

Reimplemented from FREE::XMLStreamObject.

Definition at line 44 of file frePointSetToXMLStreamObject.txx.

References FREE::XMLValueSet::GetValue(), FREE::XMLStreamObject::LoadFromString(), FREE::PointSetToXMLStreamObject< TPointSet >::m_PointSet, and FREE::XMLStreamObject::SetXMLTag().

Here is the call graph for this function:

template<class TPointSet>

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

Function that returns the data of the object converted to a xml element. This function is called by SaveToString() to compose the whole xml string and should contain the data/value of the xml element couples.

Parameters:

[in]	iDepth	The depth of the data within the xml structure tree. Used to realize correct indentation of the formated data by AddIndentation().
[out]	bHasSubElements	Indicates whether the data string contains sub elements or just a plain value. By default bHasSubElements is true when the functon is called by SaveToString(). Reset the value to reset behavior of SaveToString. Example: <element attr1="1" attr2="a">aaaaaa<subElement>bbbbbb</subelement></element> For this xml string the function should return: "aaaaaa<subElement>bbbbbb</subElement>"

Returns:

Data of the xml as xml string.

Reimplemented from FREE::XMLStreamObject.

Definition at line 67 of file frePointSetToXMLStreamObject.txx.

References FREE::XMLStreamObject::AddSubElement(), FREE::cXML_ParameterValue, FREE::PointSetToXMLStreamObject< TPointSet >::m_PointSet, and FREE::Convert::ToStr().

Here is the call graph for this function:

template<class TPointSet>

void FREE::PointSetToXMLStreamObject< TPointSet >::AttributesLoadProcessing

(

const AttributesType &

rAttributes

)

[inline, protected, virtual]

Definition at line 91 of file frePointSetToXMLStreamObject.txx.

References FREE::XMLStreamObject::AttributesLoadProcessing(), throwExceptionMacro, and FREE::Convert::ToUInt().

Here is the call graph for this function:

template<class TPointSet>

void FREE::PointSetToXMLStreamObject< TPointSet >::SaveAttributes

(

AttributesSaveListType &

rAttributes

)

const [inline, protected, virtual]

Definition at line 107 of file frePointSetToXMLStreamObject.txx.

References FREE::XMLStreamObject::SaveAttributes(), and FREE::Convert::ToStr().

Here is the call graph for this function:

---

Member Data Documentation

template<class TPointSet>

PointSetPointer FREE::PointSetToXMLStreamObject< TPointSet >::m_PointSet [protected]

Definition at line 70 of file frePointSetToXMLStreamObject.h.

Referenced by FREE::PointSetToXMLStreamObject< TPointSet >::GetPointSet(), FREE::PointSetToXMLStreamObject< TPointSet >::SaveData(), FREE::PointSetToXMLStreamObject< TPointSet >::SetPointSet(), and FREE::PointSetToXMLStreamObject< TPointSet >::SubElementLoadProcessing().

---

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

• frePointSetToXMLStreamObject.h
• frePointSetToXMLStreamObject.txx

---