ticpp::Iterator< T > Class Template Reference

Iterator for conveniently stepping through Nodes and Attributes. More...

#include <ticpp.h>

Public Member Functions
T *	begin (const Node *parent) const
	For for loop comparisons. More...
T *	end () const
	For for loop comparisons. More...
	Iterator (const std::string &value="")
	Constructor. More...
	Iterator (T *node, const std::string &value="")
	Constructor. More...
	Iterator (const Iterator &it)
	Constructor. More...
T *	Get () const
	Gets internal pointer. More...
Iterator &	operator= (const Iterator &it)
	Sets internal pointer. More...
Iterator &	operator= (T *p)
	Sets internal pointer. More...
Iterator &	operator++ ()
	Sets internal pointer to the Next Sibling, or Iterator::END, if there are no more siblings. More...
Iterator	operator++ (int)
	Sets internal pointer to the Next Sibling, or Iterator::END, if there are no more siblings. More...
Iterator &	operator-- ()
	Sets internal pointer to the Previous Sibling, or Iterator::END, if there are no prior siblings. More...
Iterator	operator-- (int)
	Sets internal pointer to the Previous Sibling, or Iterator::END, if there are no prior siblings. More...
bool	operator!= (const T *p) const
	Compares internal pointer. More...
bool	operator!= (const Iterator &it) const
	Compares internal pointer. More...
bool	operator== (T *p) const
	Compares internal pointer*. More...
bool	operator== (const Iterator &it) const
	Compares internal pointer. More...
T *	operator-> () const
	So Iterator behaves like a STL iterator. More...
T &	operator* () const
	So Iterator behaves like a STL iterator. More...

Detailed Description

template<class T = Node>
class ticpp::Iterator< T >

Iterator for conveniently stepping through Nodes and Attributes.

TinyXML++ introduces iterators:

ticpp::Iterator< ticpp::Node > child;
for ( child = child.begin( parent ); child != child.end(); child++ )

Iterators have the added advantage of filtering by type:

// Only iterates through Comment nodes
ticpp::Iterator< ticpp::Comment > child;
for ( child = child.begin( parent ); child != child.end(); child++ )

// Only iterates through Element nodes with value "ElementValue"
ticpp::Iterator< ticpp::Element > child( "ElementValue" );
for ( child = child.begin( parent ); child != child.end(); child++ )

Finally, Iterators also work with Attributes

ticpp::Iterator< ticpp::Attribute > attribute;
for ( attribute = attribute.begin( element ); attribute != attribute.end();
attribute++ )

Definition at line 1112 of file ticpp.h.

Constructor & Destructor Documentation

Iterator() [1/3]

template<class T = Node>

ticpp::Iterator< T >::Iterator ( const std::string &  value = "" )

inline

Constructor.

Parameters

value

If not empty, this iterator will only visit nodes with matching value. // Only iterates through Element nodes with value "ElementValue" ticpp::Iterator< ticpp::Element > child( "ElementValue" ); for ( child = child.begin( parent ); child != child.end(); child++ )

Definition at line 1152 of file ticpp.h.

        : m_p(0)
        , m_value(value) {}

Iterator() [2/3]

template<class T = Node>

ticpp::Iterator< T >::Iterator ( T *  node, const std::string &  value = ""  )

inline

Constructor.

Definition at line 1157 of file ticpp.h.

        : m_p(node)
        , m_value(value) {}

Iterator() [3/3]

template<class T = Node>

ticpp::Iterator< T >::Iterator ( const Iterator< T > &  it )

inline

Constructor.

Definition at line 1162 of file ticpp.h.

        : m_p(it.m_p)
        , m_value(it.m_value) {}

Member Function Documentation

begin()

template<class T = Node>

T* ticpp::Iterator< T >::begin ( const Node *  parent ) const

inline

For for loop comparisons.

Parameters

parent

The parent of the nodes to iterate.

Returns

The first child of type T.

ticpp::Iterator< ticpp::Node > child;
for ( child = child.begin( parent ); child != child.end(); child++ )

Definition at line 1127 of file ticpp.h.

References ticpp::Node::IterateFirst().

                                       {
      T* pointer;
      parent->IterateFirst(m_value, &pointer);
      return pointer;
    }

Here is the call graph for this function:

end()

template<class T = Node>

T* ticpp::Iterator< T >::end ( ) const

inline

For for loop comparisons.

Returns

nullptr

ticpp::Iterator< ticpp::Node > child;
for ( child = child.begin( parent ); child != child.end(); child++ )

Definition at line 1141 of file ticpp.h.

{ return 0; }

Get()

template<class T = Node>

T* ticpp::Iterator< T >::Get ( ) const

inline

Gets internal pointer.

Returns

The internal pointer.

Definition at line 1170 of file ticpp.h.

{ return m_p; }

operator!=() [1/2]

template<class T = Node>

bool ticpp::Iterator< T >::operator!= ( const T *  p ) const

inline

Compares internal pointer.

Definition at line 1220 of file ticpp.h.

                                      {
      if (m_p == p) {
        return false;
      }

      if (0 == m_p || 0 == p) {
        return true;
      }

      return *m_p != *p;
    }

operator!=() [2/2]

template<class T = Node>

bool ticpp::Iterator< T >::operator!= ( const Iterator< T > &  it ) const

inline

Compares internal pointer.

Definition at line 1233 of file ticpp.h.

References ticpp::Iterator< T >::m_p, and ticpp::Iterator< T >::operator!=().

Referenced by ticpp::Iterator< T >::operator!=().

{ return operator!=(it.m_p); }

Here is the call graph for this function:

Here is the caller graph for this function:

operator*()

template<class T = Node>

T& ticpp::Iterator< T >::operator* ( ) const

inline

So Iterator behaves like a STL iterator.

Definition at line 1255 of file ticpp.h.

{ return *m_p; }

operator++() [1/2]

template<class T = Node>

Iterator& ticpp::Iterator< T >::operator++ ( )

inline

Sets internal pointer to the Next Sibling, or Iterator::END, if there are no more siblings.

Definition at line 1188 of file ticpp.h.

                           {
      m_p->IterateNext(m_value, &m_p);
      return *this;
    }

operator++() [2/2]

template<class T = Node>

Iterator ticpp::Iterator< T >::operator++ ( int  )

inline

Sets internal pointer to the Next Sibling, or Iterator::END, if there are no more siblings.

Definition at line 1196 of file ticpp.h.

                             {
      Iterator tmp(*this);
      ++(*this);
      return tmp;
    }

operator--() [1/2]

template<class T = Node>

Iterator& ticpp::Iterator< T >::operator-- ( )

inline

Sets internal pointer to the Previous Sibling, or Iterator::END, if there are no prior siblings.

Definition at line 1205 of file ticpp.h.

                           {
      m_p->IteratePrevious(m_value, &m_p);
      return *this;
    }

operator--() [2/2]

template<class T = Node>

Iterator ticpp::Iterator< T >::operator-- ( int  )

inline

Sets internal pointer to the Previous Sibling, or Iterator::END, if there are no prior siblings.

Definition at line 1213 of file ticpp.h.

                             {
      Iterator tmp(*this);
      --(*this);
      return tmp;
    }

operator->()

template<class T = Node>

T* ticpp::Iterator< T >::operator-> ( ) const

inline

So Iterator behaves like a STL iterator.

Definition at line 1252 of file ticpp.h.

{ return m_p; }

operator=() [1/2]

template<class T = Node>

Iterator& ticpp::Iterator< T >::operator= ( const Iterator< T > &  it )

inline

Sets internal pointer.

Definition at line 1173 of file ticpp.h.

References ticpp::Iterator< T >::m_p, and ticpp::Iterator< T >::m_value.

                                            {
      m_p = it.m_p;
      m_value = it.m_value;
      return *this;
    }

operator=() [2/2]

template<class T = Node>

Iterator& ticpp::Iterator< T >::operator= ( T *  p )

inline

Sets internal pointer.

Definition at line 1180 of file ticpp.h.

                              {
      m_p = p;
      return *this;
    }

operator==() [1/2]

template<class T = Node>

bool ticpp::Iterator< T >::operator== ( T *  p ) const

inline

Compares internal pointer*.

Definition at line 1236 of file ticpp.h.

                                {
      if (m_p == p) {
        return true;
      }

      if (0 == m_p || 0 == p) {
        return false;
      }

      return *m_p == *p;
    }

operator==() [2/2]

template<class T = Node>

bool ticpp::Iterator< T >::operator== ( const Iterator< T > &  it ) const

inline

Compares internal pointer.

Definition at line 1249 of file ticpp.h.

References ticpp::Iterator< T >::m_p, and ticpp::Iterator< T >::operator==().

Referenced by ticpp::Iterator< T >::operator==().

{ return operator==(it.m_p); }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_p

template<class T = Node>

T* ticpp::Iterator< T >::m_p

private

Internal Pointer.

Definition at line 1114 of file ticpp.h.

Referenced by ticpp::Iterator< T >::operator!=(), ticpp::Iterator< T >::operator=(), and ticpp::Iterator< T >::operator==().

m_value

template<class T = Node>

std::string ticpp::Iterator< T >::m_value

private

Value for NextSibling calls.

Definition at line 1115 of file ticpp.h.

Referenced by ticpp::Iterator< T >::operator=().

---

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

• agrum/external/tinyxml/ticpp/ticpp.h