StructureIteratorImpl Class Reference

Class Description

Helper class to contain the implementation-specific information.

Public Member Functions
	~StructureIteratorImpl ()
	Destructor, releases the claim on the structure.
	StructureIteratorImpl (const Structure *s, unsigned int i)
	Constructor, specifies the structure over which to iterate. More...
StructureIteratorImpl &	operator= (const StructureIteratorImpl &rhs)
	Assignment operator, used to facilitate begin()/end() interface. More...
bool	operator== (const StructureIteratorImpl &rhs) const
	Equality operator, used to facilitate begin()/end() interface. More...
bool	operator!= (const StructureIteratorImpl &rhs) const
	Inequality operator, used to facilitate begin()/end() interface. More...
Member &	operator* ()
	Get the Member at the current location of the iterator (mutable version) More...
const Member &	operator* () const
	Get the Member at the current location of the iterator (const version) More...
Member *	operator-> ()
	Get the Member at the current location of the iterator (mutable version) More...
const Member *	operator-> () const
	Get the Member at the current location of the iterator (const version) More...
StructureIteratorImpl &	operator++ ()
	Pre-increment operator. More...
StructureIteratorImpl	operator++ (int)
	Post-increment operator. More...
const Structure &	structure () const
	Get the structure being used by the iterator. More...

Public Attributes
unsigned int	fCurrentIndex
	Current location of the iterator.
const Structure *	fStructure
	Structure over which to iterate.

Constructor & Destructor Documentation

StructureIteratorImpl	(	const Structure *	s,
		unsigned int	i
	)

Constructor, specifies the structure over which to iterate.

Parameters

[in]	s	Structure over which to iterate
[in]	i	Member index at which the iterator starts

Member Function Documentation

StructureIteratorImpl & operator= ( const StructureIteratorImpl &  rhs )

inline

Assignment operator, used to facilitate begin()/end() interface.

Parameters

[in]

rhs

Iterator to be copied

Returns

Reference to the assigned iterator

bool operator== ( const StructureIteratorImpl &  rhs ) const

inline

Equality operator, used to facilitate begin()/end() interface.

Parameters

[in]

rhs

Iterator to be compared

Returns

True if they are the same iterator

bool operator!= ( const StructureIteratorImpl &  rhs ) const

inline

Inequality operator, used to facilitate begin()/end() interface.

Parameters

[in]

rhs

Iterator to be compared

Returns

True if they are not the same iterator

Member & operator* ( )

inline

Get the Member at the current location of the iterator (mutable version)

Exceptions

std::out_of_range

iterator is past the end.

Returns

Reference to the current Member, throws if iteration is done

const Member & operator* ( ) const

inline

Get the Member at the current location of the iterator (const version)

Exceptions

std::out_of_range

iterator is past the end.

Returns

Reference to the current Member, throws if iteration is done

Member * operator-> ( )

inline

Get the Member at the current location of the iterator (mutable version)

Exceptions

std::out_of_range

iterator is past the end.

Returns

Pointer to the current Member, throws if iteration is done

const Member * operator-> ( ) const

inline

Get the Member at the current location of the iterator (const version)

Exceptions

std::out_of_range

iterator is past the end.

Returns

Pointer to the current Member, throws if iteration is done

StructureIteratorImpl & operator++ ( )

inline

Pre-increment operator.

Returns

Reference to this iterator, to allow use as a lhs

StructureIteratorImpl operator++

(

int

)

Post-increment operator.

Makes a copy - use pre-increment where possible

Returns

Copy of the iterator before the advance

const Structure & structure ( ) const

inline

Get the structure being used by the iterator.

Returns

Reference to structure being used by the iterator

---

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

• adskDataStructureIterator.cpp