bdlc::IndexClerkIter Class Reference

#include <bdlc_indexclerk.h>

List of all members.

Public Member Functions
	BSLMF_NESTED_TRAIT_DECLARATION (IndexClerkIter, bsl::is_trivially_copyable)
	IndexClerkIter ()
	IndexClerkIter (const int *index)
	IndexClerkIter (const IndexClerkIter &original)
IndexClerkIter &	operator= (const IndexClerkIter &rhs)
IndexClerkIter &	operator++ ()
IndexClerkIter &	operator-- ()
int	operator* () const
Friends
bool	operator== (const IndexClerkIter &lhs, const IndexClerkIter &rhs)
bool	operator!= (const IndexClerkIter &lhs, const IndexClerkIter &rhs)

---

Detailed Description

This class defines an in-core value-semantic iterator providing sequential read-only access to the decommissioned indices of a IndexClerk. The order of iteration is implementation dependent.

See Component bdlc_indexclerk

---

Constructor & Destructor Documentation

bdlc::IndexClerkIter::IndexClerkIter

(

)

Create an unbound iterator.

bdlc::IndexClerkIter::IndexClerkIter

(

const int *

index

)

Create an iterator referring to the specified integer index.

bdlc::IndexClerkIter::IndexClerkIter

(

const IndexClerkIter &

original

)

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

---

Member Function Documentation

bdlc::IndexClerkIter::BSLMF_NESTED_TRAIT_DECLARATION	(	IndexClerkIter	,
		bsl::is_trivially_copyable
	)

IndexClerkIter& bdlc::IndexClerkIter::operator=

(

const IndexClerkIter &

rhs

)

Create an iterator having the same value as the specified rhs iterator.

IndexClerkIter& bdlc::IndexClerkIter::operator++

(

)

Increment this iterator to refer to the next index in the corresponding sequence of decommissioned indices. Return a reference to this modifiable iterator. The behavior is undefined unless the current index is within the range [ begin() .. end() ).

IndexClerkIter& bdlc::IndexClerkIter::operator--

(

)

Decrement this iterator to refer to the previous index in the corresponding sequence of decommissioned indices. Return a reference to this modifiable iterator. The behavior is undefined unless the current index is within the range ( begin() .. end() ].

int bdlc::IndexClerkIter::operator*

(

)

const

Return the value of the integer to which this iterator currently refers. The behavior is undefined unless the iterator is within the range [ begin() .. end() ).

---

Friends And Related Function Documentation

bool operator==	(	const IndexClerkIter &	lhs,
		const IndexClerkIter &	rhs
	)			[friend]

Return true if lhs and rhs have the same value and false otherwise. Two iterators have the same value if they refer to the same element of the same container or if they both have the end iterator value for the same container. The behavior is undefined unless lhs and rhs refer to the same container and are non-singular (i.e., are not default-constructed or copies of singular iterators).

bool operator!=	(	const IndexClerkIter &	lhs,
		const IndexClerkIter &	rhs
	)			[friend]

Return true if lhs and rhs do not have the same value and false otherwise. Two iterators do not have the same value if they do not refer to the same element of the same container or if one has the end iterator value of a container and the other refers to an element (not the end) of the same container. The behavior is undefined unless lhs and rhs refer to the same container and are non-singular (i.e., are not default-constructed or copies of singular iterators).

---

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

• bdlc_indexclerk.h