Simbody  3.7
SimTK::Xml::element_iterator Class Reference

This is a bidirectional iterator suitable for moving forward or backward within a list of Element nodes, for writable access. More...

+ Inheritance diagram for SimTK::Xml::element_iterator:

Public Member Functions

 element_iterator (const String &tag="")
 This is the default constructor which leaves the element_iterator empty, and you can optionally set the type of Element which will be iterated over. More...
 
 element_iterator (Element &elt, const String &tag="")
 Constructor an element_iterator pointing to a given Element, and optionally set the type of Element which will be iterated over. More...
 
 element_iterator (const element_iterator &src)
 Copy constructor takes an element_iterator that can be const, but that still allows writing to the Element. More...
 
element_iteratoroperator= (const element_iterator &src)
 Copy assignment takes an element_iterator that can be const, but that still allows writing to the Element. More...
 
element_iteratoroperator++ ()
 
element_iterator operator++ (int)
 
element_iteratoroperator-- ()
 
element_iterator operator-- (int)
 
Elementoperator* () const
 
Elementoperator-> () const
 
bool operator== (const element_iterator &other) const
 
bool operator!= (const element_iterator &other) const
 
- Public Member Functions inherited from SimTK::Xml::node_iterator
 node_iterator (NodeType allowed=AnyNodes)
 
 node_iterator (Node &node, NodeType allowed=AnyNodes)
 
 node_iterator (const node_iterator &src)
 Copy constructor takes a node_iterator that can be const, but that still allows writing to the Node. More...
 
 ~node_iterator ()
 An iterator destructor never deletes the object to which it refers. More...
 
node_iteratoroperator= (const node_iterator &src)
 Copy assignment takes an node_iterator that can be const, but that still allows writing to the Node. More...
 
node_iteratoroperator++ ()
 
node_iterator operator++ (int)
 
node_iteratoroperator-- ()
 
node_iterator operator-- (int)
 
Nodeoperator* ()
 
Nodeoperator-> ()
 
Nodeoperator* () const
 
Nodeoperator-> () const
 
bool operator== (const node_iterator &other) const
 
bool operator!= (const node_iterator &other) const
 

Friends

class Element
 

Additional Inherited Members

- Protected Member Functions inherited from SimTK::Xml::node_iterator
 node_iterator (TiXmlNode *tiNode, NodeType allowed=AnyNodes)
 
void reassign (TiXmlNode *tiNode)
 

Detailed Description

This is a bidirectional iterator suitable for moving forward or backward within a list of Element nodes, for writable access.

By default we will iterate over all elements in a list but you can restrict the element_iterator at construction to find only elements with a particular tag.

Constructor & Destructor Documentation

◆ element_iterator() [1/3]

SimTK::Xml::element_iterator::element_iterator ( const String tag = "")
inlineexplicit

This is the default constructor which leaves the element_iterator empty, and you can optionally set the type of Element which will be iterated over.

◆ element_iterator() [2/3]

SimTK::Xml::element_iterator::element_iterator ( Element elt,
const String tag = "" 
)
inlineexplicit

Constructor an element_iterator pointing to a given Element, and optionally set the type of Element which will be iterated over.

◆ element_iterator() [3/3]

SimTK::Xml::element_iterator::element_iterator ( const element_iterator src)
inline

Copy constructor takes an element_iterator that can be const, but that still allows writing to the Element.

Member Function Documentation

◆ operator=()

element_iterator& SimTK::Xml::element_iterator::operator= ( const element_iterator src)
inline

Copy assignment takes an element_iterator that can be const, but that still allows writing to the Element.

◆ operator++() [1/2]

element_iterator& SimTK::Xml::element_iterator::operator++ ( )

◆ operator++() [2/2]

element_iterator SimTK::Xml::element_iterator::operator++ ( int  )

◆ operator--() [1/2]

element_iterator& SimTK::Xml::element_iterator::operator-- ( )

◆ operator--() [2/2]

element_iterator SimTK::Xml::element_iterator::operator-- ( int  )

◆ operator*()

Element & SimTK::Xml::element_iterator::operator* ( ) const
inline

◆ operator->()

Element * SimTK::Xml::element_iterator::operator-> ( ) const
inline

◆ operator==()

bool SimTK::Xml::element_iterator::operator== ( const element_iterator other) const
inline

◆ operator!=()

bool SimTK::Xml::element_iterator::operator!= ( const element_iterator other) const
inline

Friends And Related Function Documentation

◆ Element

friend class Element
friend

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