XMLDom::const_data_iterator< Type > Class Template Reference

Const iterator for iterating over data nodes. More...

#include <xml/XMLDom.h>

Public Types
typedef std::string	value_type
	STL-conform typedefs. More...
typedef const std::string *	pointer
	The pointer type. More...
typedef const std::string &	reference
	The reference type. More...
typedef ptrdiff_t	difference_type
	The difference type. More...
typedef std::bidirectional_iterator_tag	iterator_category
	The iterator category. More...

Public Member Functions
	const_data_iterator ()
	Constructor. More...
	const_data_iterator (_xmlNode *iNode)
	Constructor. More...
uint32	line () const
	Gets the underlying line number of the loaded document for this node. More...
size_t	position () const
bool	operator== (const const_data_iterator &other) const
	Compare two iterators. More...
bool	operator!= (const const_data_iterator &other) const
	Compare two iterators. More...
const_data_iterator &	operator++ ()
	Preincrement. More...
const_data_iterator &	operator-- ()
	Predecrement. More...
std::string	operator* () const
	Dereference operator to std::string. More...

Friends
class	sibling_iterator

Detailed Description

template<int Type>
class mira::XMLDom::const_data_iterator< Type >

Const iterator for iterating over data nodes.

Member Typedef Documentation

value_type

typedef std::string value_type

STL-conform typedefs.

The value type.

pointer

typedef const std::string* pointer

The pointer type.

reference

typedef const std::string& reference

The reference type.

difference_type

typedef ptrdiff_t difference_type

The difference type.

iterator_category

typedef std::bidirectional_iterator_tag iterator_category

The iterator category.

Constructor & Destructor Documentation

const_data_iterator() [1/2]

const_data_iterator

(

)

Constructor.

const_data_iterator() [2/2]

const_data_iterator

(

_xmlNode *

iNode

)

Constructor.

Parameters

[in]

iNode

The current node

Member Function Documentation

line()

uint32 line

(

)

const

Gets the underlying line number of the loaded document for this node.

Returns

Line number

position()

size_t position

(

)

const

Returns

the position (index) of the node in the parent or npos if invalid

operator==()

bool operator==

(

const const_data_iterator< Type > &

other

)

const

Compare two iterators.

Parameters

[in]

other

The other iterator

Returns

true if equal

operator!=()

bool operator!=

(

const const_data_iterator< Type > &

other

)

const

Compare two iterators.

Parameters

[in]

other

The other iterator

Returns

true if not equal

operator++()

const_data_iterator& operator++

(

)

Preincrement.

operator--()

const_data_iterator& operator--

(

)

Predecrement.

operator*()

std::string operator*

(

)

const

Dereference operator to std::string.

Returns

Returns the data value.

Friends And Related Function Documentation

sibling_iterator

friend class sibling_iterator

friend

---

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

• base/include/xml/XMLDom.h