BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits > Class Template Reference

#include <BALL/CONCEPT/bidirectionalIterator.h>

Inheritance diagram for BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >:
Inheritance graph
[legend]

List of all members.

Public Types

Typedefs

typedef
std::bidirectional_iterator_tag 
iterator_category
typedef ConstForwardIterator
< Container, DataType,
Position, Traits > 
Base

Public Member Functions

Constructors and destructor.

BALL_INLINE ConstBidirectionalIterator ()
BALL_INLINE ConstBidirectionalIterator (const ConstBidirectionalIterator &iterator)
BALL_INLINE ~ConstBidirectionalIterator ()

Protected Member Functions

BALL_INLINE ConstBidirectionalIterator (const Container &container)
 Construct an iterator bound to a specific container.

Iterator methods



BALL_INLINE void toBegin () throw (Exception::Precondition)
 Move the iterator to the beginning of the container.
BALL_INLINE bool isBegin () const
 Check whether the iterator points to the item at the beginning of the container.
void toEnd () throw (Exception::Precondition)
 Move the iterator to the position after the last item of the container.
BALL_INLINE bool isEnd () const
 Check whether the iterator points to the position after the last item of the container.
void toRBegin () throw (Exception::Precondition)
 Move the iterator to the "reverse" beginning of the container.
BALL_INLINE bool isRBegin () const
 Test whether the iterator points to the "reverse" first element of the container.
void toREnd () throw (Exception::Precondition)
 Move the iterator to the position before the first element.
BALL_INLINE bool isREnd () const
 Test wheter the iterator points to the position before the first element.
BALL_INLINE
ConstBidirectionalIterator
operator++ () throw (Exception::Precondition)
 Increment operator.
BALL_INLINE
ConstBidirectionalIterator 
operator++ (int) throw (Exception::Precondition)
 Postfix increment operator.
BALL_INLINE
ConstBidirectionalIterator
operator-- () throw (Exception::Precondition)
 Decrement operator.
BALL_INLINE
ConstBidirectionalIterator 
operator-- (int) throw (Exception::Precondition)
 Postfix decrement operator.
static ConstBidirectionalIterator begin (const Container &container) throw (Exception::Precondition)
 Return an iterator pointingto the first item of the container.
static ConstBidirectionalIterator end (const Container &container) throw (Exception::Precondition)
 Return an iterator pointing to the position after the last element.
static ConstBidirectionalIterator rbegin (const Container &container) throw (Exception::Precondition)
 Return an iterator pointing to the last element.
static ConstBidirectionalIterator rend (const Container &container) throw (Exception::Precondition)
 Return an iterator pointing to the positon before the first element.

Detailed Description

template<typename Container, typename DataType, typename Position, typename Traits>
class BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >

Constant Bidirectional Iterator.

Definition at line 23 of file bidirectionalIterator.h.


Member Typedef Documentation

template<typename Container, typename DataType, typename Position, typename Traits>
typedef ConstForwardIterator<Container, DataType, Position, Traits> BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::Base
template<typename Container, typename DataType, typename Position, typename Traits>
typedef std::bidirectional_iterator_tag BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::iterator_category

Constructor & Destructor Documentation

template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::ConstBidirectionalIterator (  )  [inline]

Definition at line 43 of file bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::ConstBidirectionalIterator ( const ConstBidirectionalIterator< Container, DataType, Position, Traits > &  iterator  )  [inline]

Definition at line 46 of file bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::~ConstBidirectionalIterator (  )  [inline]

Definition at line 52 of file bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::ConstBidirectionalIterator ( const Container &  container  )  [inline, protected]

Construct an iterator bound to a specific container.

Definition at line 111 of file bidirectionalIterator.h.


Member Function Documentation

template<typename Container, typename DataType , typename Position , typename Traits >
BALL_INLINE ConstBidirectionalIterator< Container, DataType, Position, Traits > BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::begin ( const Container &  container  )  throw (Exception::Precondition) [inline, static]
template<typename Container, typename DataType , typename Position , typename Traits >
BALL_INLINE ConstBidirectionalIterator< Container, DataType, Position, Traits > BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::end ( const Container &  container  )  throw (Exception::Precondition) [inline, static]
template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE bool BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::isBegin (  )  const [inline]

Check whether the iterator points to the item at the beginning of the container.

Reimplemented from BALL::ConstForwardIterator< Container, DataType, Position, Traits >.

Definition at line 63 of file bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE bool BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::isEnd (  )  const [inline]

Check whether the iterator points to the position after the last item of the container.

Reimplemented from BALL::ConstForwardIterator< Container, DataType, Position, Traits >.

Definition at line 69 of file bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE bool BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::isRBegin (  )  const [inline]

Test whether the iterator points to the "reverse" first element of the container.

Definition at line 75 of file bidirectionalIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE bool BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::isREnd (  )  const [inline]

Test wheter the iterator points to the position before the first element.

Definition at line 81 of file bidirectionalIterator.h.

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE ConstBidirectionalIterator< Container, DataType, Position, Traits > BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::operator++ ( int   )  throw (Exception::Precondition) [inline]
template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE ConstBidirectionalIterator< Container, DataType, Position, Traits > & BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::operator++ (  )  throw (Exception::Precondition) [inline]
template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE ConstBidirectionalIterator< Container, DataType, Position, Traits > BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::operator-- ( int   )  throw (Exception::Precondition) [inline]
template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE ConstBidirectionalIterator< Container, DataType, Position, Traits > & BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::operator-- (  )  throw (Exception::Precondition) [inline]
template<typename Container, typename DataType , typename Position , typename Traits >
BALL_INLINE ConstBidirectionalIterator< Container, DataType, Position, Traits > BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::rbegin ( const Container &  container  )  throw (Exception::Precondition) [inline, static]
template<typename Container, typename DataType , typename Position , typename Traits >
BALL_INLINE ConstBidirectionalIterator< Container, DataType, Position, Traits > BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::rend ( const Container &  container  )  throw (Exception::Precondition) [inline, static]
template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE void BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::toBegin (  )  throw (Exception::Precondition) [inline]

Move the iterator to the beginning of the container.

Reimplemented from BALL::ConstForwardIterator< Container, DataType, Position, Traits >.

Definition at line 120 of file bidirectionalIterator.h.

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE void BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::toEnd (  )  throw (Exception::Precondition) [inline]

Move the iterator to the position after the last item of the container.

Reimplemented from BALL::ConstForwardIterator< Container, DataType, Position, Traits >.

Definition at line 129 of file bidirectionalIterator.h.

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE void BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::toRBegin (  )  throw (Exception::Precondition) [inline]

Move the iterator to the "reverse" beginning of the container.

Definition at line 138 of file bidirectionalIterator.h.

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE void BALL::ConstBidirectionalIterator< Container, DataType, Position, Traits >::toREnd (  )  throw (Exception::Precondition) [inline]

Move the iterator to the position before the first element.

Definition at line 147 of file bidirectionalIterator.h.

Generated by  doxygen 1.6.3