bioformats  5.1.3
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
ome::common::xml::dom::NodeList::iterator Class Reference

Iterator for a NodeList. More...

#include <ome/common/xml/dom/NodeList.h>

Public Member Functions

 iterator (const iterator &rhs)
 Copy construct an iterator. More...
 
 ~iterator ()
 Destructor.
 
Nodeoperator* () noexcept
 Dereference the iterator. More...
 
Nodeoperator-> () noexcept
 Dereference the iterator. More...
 
iteratoroperator-- ()
 Move the iterator backward one element. More...
 
iteratoroperator++ ()
 Move the iterator forward one element. More...
 
bool operator== (const iterator &rhs) const noexcept
 Check the equality of two iterators. More...
 
bool operator!= (const iterator &rhs) const noexcept
 Check the non-equality of two iterators. More...
 

Private Member Functions

 iterator ()
 Construct a null iterator. More...
 
 iterator (xercesc::DOMNodeList *xmlnodelist, size_type index)
 Construct an iterator at the specified position for the specified list. More...
 

Private Attributes

size_type index
 Index into the list.
 
xercesc::DOMNodeList * xmlnodelist
 List being iterated over.
 
ome::compat::shared_ptr< Nodexmlnode
 Node at current position.
 

Friends

class NodeList
 

Detailed Description

Iterator for a NodeList.

Constructor & Destructor Documentation

ome::common::xml::dom::NodeList::iterator::iterator ( )
private

Construct a null iterator.

This is used to refer to invalid positions such as past-the-end.

ome::common::xml::dom::NodeList::iterator::iterator ( xercesc::DOMNodeList *  xmlnodelist,
size_type  index 
)
private

Construct an iterator at the specified position for the specified list.

Parameters
xmlnodelistthe NodeList to iterate over.
indexthe index into the NodeList.
ome::common::xml::dom::NodeList::iterator::iterator ( const iterator rhs)

Copy construct an iterator.

Parameters
rhsthe iterator to copy.

Member Function Documentation

bool ome::common::xml::dom::NodeList::iterator::operator!= ( const iterator rhs) const
inlinenoexcept

Check the non-equality of two iterators.

Parameters
rhsthe iterator to compare with.
Returns
true if not equal, otherwise false.
Node & ome::common::xml::dom::NodeList::iterator::operator* ( )
noexcept

Dereference the iterator.

Returns
a reference to the Node at this position.
NodeList::iterator & ome::common::xml::dom::NodeList::iterator::operator++ ( )

Move the iterator forward one element.

Returns
the iterator at the new position.
NodeList::iterator & ome::common::xml::dom::NodeList::iterator::operator-- ( )

Move the iterator backward one element.

Returns
the iterator at the new position.
Node * ome::common::xml::dom::NodeList::iterator::operator-> ( )
noexcept

Dereference the iterator.

Returns
a pointer to the Node at this position.
bool ome::common::xml::dom::NodeList::iterator::operator== ( const iterator rhs) const
noexcept

Check the equality of two iterators.

Parameters
rhsthe iterator to compare with.
Returns
true if equal, otherwise false.

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