ball::AttributeContainerListIterator Class Reference

#include <ball_attributecontainerlist.h>

Detailed Description

This class provides an STL-style iterator over a sequence of AttributeContainer object addresses. The behavior of the operator* method is undefined unless the iterator is at a valid position in the sequence of AttributeContainer object addresses (i.e., not the "end") and the referenced element has not been removed since the iterator was constructed.

See ball_attributecontainerlist

Public Member Functions
	AttributeContainerListIterator ()
	AttributeContainerListIterator (const AttributeContainerListIterator &original)
	AttributeContainerListIterator (AttributeContainerList_Node *position)
	~AttributeContainerListIterator ()=default
AttributeContainerListIterator &	operator= (const AttributeContainerListIterator &rhs)
AttributeContainerListIterator	operator++ (int)
AttributeContainerListIterator	operator++ ()
const AttributeContainer *	operator* () const
bool	valid () const

Friends
class	AttributeContainerList
bool	operator== (const AttributeContainerListIterator &, const AttributeContainerListIterator &)

Constructor & Destructor Documentation

AttributeContainerListIterator() [1/3]

ball::AttributeContainerListIterator::AttributeContainerListIterator ( )

inline

Create an uninitialized iterator.

AttributeContainerListIterator() [2/3]

ball::AttributeContainerListIterator::AttributeContainerListIterator ( const AttributeContainerListIterator &  original )

inline

Create an iterator having the same value as the specified original one.

AttributeContainerListIterator() [3/3]

ball::AttributeContainerListIterator::AttributeContainerListIterator ( AttributeContainerList_Node *  position )

inline

Create an iterator at the specified position.

~AttributeContainerListIterator()

ball::AttributeContainerListIterator::~AttributeContainerListIterator ( )

default

Destroy this object.

Member Function Documentation

operator*()

const AttributeContainer * ball::AttributeContainerListIterator::operator* ( ) const

inline

Return the address of the non-modifiable attribute container at which this iterator is positioned.

Precondition

The behavior is undefined unless this iterator is at a valid position in the list.

operator++() [1/2]

AttributeContainerListIterator ball::AttributeContainerListIterator::operator++ ( )

inline

Advance this iterator to the next attribute container in the list and return the value of the iterator prior to this method call.

Precondition

The behavior is undefined unless the iterator is at a valid position in the list.

operator++() [2/2]

AttributeContainerListIterator ball::AttributeContainerListIterator::operator++ ( int  )

inline

Advance this iterator to the next attribute container in the list and return the value of this iterator.

Precondition

The behavior is undefined unless the iterator is at a valid position in the list.

operator=()

AttributeContainerListIterator & ball::AttributeContainerListIterator::operator= ( const AttributeContainerListIterator &  rhs )

inline

Assign this iterator the value of the specified rhs and return a modifiable reference to this iterator.

valid()

bool ball::AttributeContainerListIterator::valid ( ) const

inline

Return true if this iterator is at a valid position in the sequence of AttributeContainer addresses and false otherwise.

Friends And Related Symbol Documentation

AttributeContainerList

friend class AttributeContainerList

friend

operator==

bool operator== ( const AttributeContainerListIterator &  , const AttributeContainerListIterator &    )

friend

Return true if the specified lhs and the specified rhs iterators have the same value and false otherwise. Two iterators have the same value if they refer to the same position in the same list, or if both iterators are at an invalid position in the list (i.e., the "end" of the list, or the default constructed value).

---

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

• ball_attributecontainerlist.h