MIRA
Public Types | Public Member Functions | List of all members
XMLDom::data_iterator< Type > Class Template Reference

Iterator for iterating over data nodes. More...

#include <xml/XMLDom.h>

Public Types

typedef std::string value_type
 STL-conform typedefs. More...
 
typedef std::string * pointer
 The pointer type. More...
 
typedef 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

 data_iterator ()
 Constructor. More...
 
 data_iterator (_xmlNode *iNode)
 Constructor. More...
 
const data_iteratoroperator= (const std::string &value)
 Set the data value of the node. More...
 
bool operator== (const data_iterator &other) const
 Compare two iterators. More...
 
bool operator!= (const data_iterator &other) const
 Compare two iterators. More...
 
data_iteratoroperator++ ()
 Preincrement. More...
 
data_iteratoroperator-- ()
 Predecrement. More...
 
std::string operator* () const
 Dereference operator to std::string. More...
 
data_iterator remove ()
 Removes the data node the iterator points to. More...
 

Detailed Description

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

Iterator for iterating over data nodes.

Member Typedef Documentation

◆ value_type

typedef std::string value_type

STL-conform typedefs.

The value type.

◆ pointer

typedef std::string* pointer

The pointer type.

◆ reference

typedef 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

◆ data_iterator() [1/2]

Constructor.

◆ data_iterator() [2/2]

data_iterator ( _xmlNode *  iNode)

Constructor.

Parameters
[in]iNodeThe current node.

Member Function Documentation

◆ operator=()

const data_iterator& operator= ( const std::string &  value)

Set the data value of the node.

Parameters
[in]valueThe value.

◆ operator==()

bool operator== ( const data_iterator< Type > &  other) const

Compare two iterators.

Parameters
[in]otherThe other iterator
Returns
true if equal

◆ operator!=()

bool operator!= ( const data_iterator< Type > &  other) const

Compare two iterators.

Parameters
[in]otherThe other iterator
Returns
true if not equal

◆ operator++()

data_iterator& operator++ ( )

Preincrement.

◆ operator--()

data_iterator& operator-- ( )

Predecrement.

◆ operator*()

std::string operator* ( ) const

Dereference operator to std::string.

Returns
Returns the data value.

◆ remove()

data_iterator remove ( )

Removes the data node the iterator points to.

Returns
The iterator pointing to the next data node after the deleted one

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