Mezzanine::XML::AttributeIterator Class Reference

Attribute iterator (a bidirectional iterator over a collection of Attribute). More...

#include <attributeiterator.h>

Public Types
typedef ptrdiff_t	difference_type
	An Iterator trait.
typedef std::bidirectional_iterator_tag	iterator_category
	An Iterator trait.
typedef Attribute *	pointer
	An Iterator trait.
typedef Attribute &	reference
	An Iterator trait.
typedef Attribute	value_type
	An Iterator trait.

Public Member Functions
	AttributeIterator ()
	Default Constructor, makes a blank iterator.
	AttributeIterator (const Attribute &attr, const Node &GetParent)
	Construct an iterator which points to the specified node. More...
bool	operator!= (const AttributeIterator &rhs) const
	Compares this AttributeIterator to another AttributeIterator for inequality. More...
Attribute &	operator* () const
	Deferences this Iterator. More...
const AttributeIterator &	operator++ ()
	Increment the iterator to the next member of the container. More...
AttributeIterator	operator++ (int)
	Increment the iterator to the next member of the container. More...
const AttributeIterator &	operator-- ()
	Decrement the iterator to the next member of the container. More...
AttributeIterator	operator-- (int)
	Decrement the iterator to the next member of the container. More...
Attribute *	operator-> () const
	Get the pointer the Attribute this points to. More...
bool	operator== (const AttributeIterator &rhs) const
	Compares this AttributeIterator to another AttributeIterator for equality. More...

Friends
class	Node

Detailed Description

Attribute iterator (a bidirectional iterator over a collection of Attribute).

See Also

This behaves similar to XML::NodeIterator

Definition at line 75 of file attributeiterator.h.

Constructor & Destructor Documentation

Mezzanine::XML::AttributeIterator::AttributeIterator	(	const Attribute &	attr,
		const Node &	GetParent
	)

Construct an iterator which points to the specified node.

Parameters

GetParent	A Node that contains the Attribute this iterator will point to.
attr	The Attribute this iterator points to.

Member Function Documentation

bool Mezzanine::XML::AttributeIterator::operator!=

(

const AttributeIterator &

rhs)

const

Compares this AttributeIterator to another AttributeIterator for inequality.

Parameters

rhs	The Right Hand Side AttributeIterator.

Returns

False if the internal data stored in Node this AttributeIterator refers to is the same as the metadata in the other AttributeIterator's Attribute, True otherwise.

Attribute& Mezzanine::XML::AttributeIterator::operator*

(

)

const

Deferences this Iterator.

Returns

a Attribute reference to the Attribute pointed at by this AttributeIterator.

const AttributeIterator& Mezzanine::XML::AttributeIterator::operator++

(

)

Increment the iterator to the next member of the container.

Returns

Returns a const AttributeIterator.

AttributeIterator Mezzanine::XML::AttributeIterator::operator++

(

int

)

Increment the iterator to the next member of the container.

Returns

Returns a AttributeIterator.

const AttributeIterator& Mezzanine::XML::AttributeIterator::operator--

(

)

Decrement the iterator to the next member of the container.

Returns

Returns a const AttributeIterator.

AttributeIterator Mezzanine::XML::AttributeIterator::operator--

(

int

)

Decrement the iterator to the next member of the container.

Returns

Returns a AttributeIterator.

Attribute* Mezzanine::XML::AttributeIterator::operator->

(

)

const

Get the pointer the Attribute this points to.

Returns

A pointer to the Attribute this AttributeIterator references.

bool Mezzanine::XML::AttributeIterator::operator==

(

const AttributeIterator &

rhs)

const

Compares this AttributeIterator to another AttributeIterator for equality.

Parameters

rhs	The Right Hand Side AttributeIterator

Returns

True if the internal data stored in the Attribute this AttributeIterator refers to is the same as the metadata in the other AttributeIterator's Attribute, false otherwise.

---

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

• /home/sqeaky/Code/Mezzanine/Mezzanine/src/XML/attributeiterator.h