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

#include <BALL/CONCEPT/forwardIterator.h>

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

List of all members.

Public Types

Typedefs

typedef std::forward_iterator_tag iterator_category
typedef BaseIterator
< Container, DataType,
Position, Traits > 
Base
typedef std::forward_iterator_tag iterator_category
typedef BaseIterator
< Container, DataType,
Position, Traits > 
Base

Public Member Functions

Constructors and Destructors

BALL_INLINE ConstForwardIterator ()
 Default constructor.
BALL_INLINE ConstForwardIterator (const ConstForwardIterator &iterator)
 Copy constructor.
BALL_INLINE ~ConstForwardIterator ()
 ConstForwardIterator () throw ()
 Default constructor.
 ConstForwardIterator (const ConstForwardIterator &iterator) throw ()
 Copy constructor.
 ~ConstForwardIterator () throw ()
Assignment

BALL_INLINE ConstForwardIteratoroperator= (const ConstForwardIterator &iterator)
BALL_INLINE void swap (ConstForwardIterator &iterator)
ConstForwardIteratoroperator= (const ConstForwardIterator &iterator) throw ()
void swap (ConstForwardIterator &iterator) throw ()

Protected Member Functions

BALL_INLINE ConstForwardIterator (const Container &container)
 ConstForwardIterator (const Container &container) throw ()

Iterator methods



BALL_INLINE void toBegin () throw (Exception::Precondition)
 Move the iterator to the item at the beginning of the container.
BALL_INLINE bool isBegin () const
 Check whether the iterator points to the first item of the container.
BALL_INLINE void toEnd () throw (Exception::Precondition)
 Move the iterator behind the last item of the container.
BALL_INLINE bool isEnd () const
 Check whether the iterator points behind the last item of the container.
BALL_INLINE ConstForwardIteratoroperator++ () throw (Exception::Precondition)
 Increment operator.
BALL_INLINE ConstForwardIterator operator++ (int) throw (Exception::Precondition)
 Postfix increment operator.
void toBegin () throw (Exception::SingularIterator)
 Move the iterator to the item at the beginning of the container.
bool isBegin () const throw ()
 Check whether the iterator points to the first item of the container.
void toEnd () throw (Exception::SingularIterator)
 Move the iterator behind the last item of the container.
bool isEnd () const throw ()
 Check whether the iterator points behind the last item of the container.
ConstForwardIteratoroperator++ () throw (Exception::InvalidIterator)
 Increment operator.
ConstForwardIterator operator++ (int) throw (Exception::InvalidIterator)
 Postfix increment operator.
static ConstForwardIterator begin (const Container &container) throw (Exception::Precondition)
 Return an iterator pointing to the beginning of the container.
static ConstForwardIterator end (const Container &container) throw (Exception::Precondition)
 Return an iterator pointing at the end of the container.
static ConstForwardIterator begin (const Container &container) throw (Exception::Precondition)
 Return an iterator pointing to the beginning of the container.
static ConstForwardIterator end (const Container &container) throw (Exception::Precondition)
 Return an iterator pointing at the end of the container.

Detailed Description

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

Generic non-mutable forward itterator

Generic non-mutable forward iterator

Definition at line 24 of file CONCEPT/forwardIterator.h.


Member Typedef Documentation

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

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 44 of file CONCEPT/forwardIterator.h.

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

Copy constructor.

Definition at line 47 of file CONCEPT/forwardIterator.h.

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

Definition at line 53 of file CONCEPT/forwardIterator.h.

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

Definition at line 117 of file CONCEPT/forwardIterator.h.

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

Default constructor.

Definition at line 41 of file MATHS/LINALG/forwardIterator.h.

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

Copy constructor.

Definition at line 44 of file MATHS/LINALG/forwardIterator.h.

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

Definition at line 50 of file MATHS/LINALG/forwardIterator.h.

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

Definition at line 122 of file MATHS/LINALG/forwardIterator.h.


Member Function Documentation

template<typename Container, typename DataType, typename Position, typename Traits>
static ConstForwardIterator BALL::ConstForwardIterator< Container, DataType, Position, Traits >::begin ( const Container &  container  )  throw (Exception::Precondition) [static]
template<typename Container, typename DataType , typename Position , typename Traits >
ConstForwardIterator< Container, DataType, Position, Traits > BALL::ConstForwardIterator< Container, DataType, Position, Traits >::begin ( const Container &  container  )  throw (Exception::Precondition) [inline, static]
template<typename Container, typename DataType, typename Position, typename Traits>
static ConstForwardIterator BALL::ConstForwardIterator< Container, DataType, Position, Traits >::end ( const Container &  container  )  throw (Exception::Precondition) [static]
template<typename Container, typename DataType , typename Position , typename Traits >
ConstForwardIterator< Container, DataType, Position, Traits > BALL::ConstForwardIterator< Container, DataType, Position, Traits >::end ( const Container &  container  )  throw (Exception::Precondition) [inline, static]
template<typename Container, typename DataType, typename Position, typename Traits>
bool BALL::ConstForwardIterator< Container, DataType, Position, Traits >::isBegin (  )  const throw ()
template<typename Container , typename DataType , typename Position , typename Traits >
bool BALL::ConstForwardIterator< Container, DataType, Position, Traits >::isBegin (  )  const [inline]
template<typename Container, typename DataType, typename Position, typename Traits>
bool BALL::ConstForwardIterator< Container, DataType, Position, Traits >::isEnd (  )  const throw ()
template<typename Container , typename DataType , typename Position , typename Traits >
bool BALL::ConstForwardIterator< Container, DataType, Position, Traits >::isEnd (  )  const [inline]
template<typename Container, typename DataType, typename Position, typename Traits>
ConstForwardIterator BALL::ConstForwardIterator< Container, DataType, Position, Traits >::operator++ ( int   )  throw (Exception::InvalidIterator) [inline]
template<typename Container, typename DataType, typename Position, typename Traits>
ConstForwardIterator& BALL::ConstForwardIterator< Container, DataType, Position, Traits >::operator++ (  )  throw (Exception::InvalidIterator) [inline]
template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE ConstForwardIterator BALL::ConstForwardIterator< Container, DataType, Position, Traits >::operator++ ( int   )  throw (Exception::Precondition) [inline]
template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE ConstForwardIterator& BALL::ConstForwardIterator< Container, DataType, Position, Traits >::operator++ (  )  throw (Exception::Precondition) [inline]
template<typename Container, typename DataType, typename Position, typename Traits>
ConstForwardIterator& BALL::ConstForwardIterator< Container, DataType, Position, Traits >::operator= ( const ConstForwardIterator< Container, DataType, Position, Traits > &  iterator  )  throw () [inline]

Definition at line 58 of file MATHS/LINALG/forwardIterator.h.

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

Definition at line 61 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
void BALL::ConstForwardIterator< Container, DataType, Position, Traits >::swap ( ConstForwardIterator< Container, DataType, Position, Traits > &  iterator  )  throw () [inline]

Definition at line 65 of file MATHS/LINALG/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
BALL_INLINE void BALL::ConstForwardIterator< Container, DataType, Position, Traits >::swap ( ConstForwardIterator< Container, DataType, Position, Traits > &  iterator  )  [inline]

Definition at line 68 of file CONCEPT/forwardIterator.h.

template<typename Container, typename DataType, typename Position, typename Traits>
void BALL::ConstForwardIterator< Container, DataType, Position, Traits >::toBegin (  )  throw (Exception::SingularIterator)
template<typename Container , typename DataType , typename Position , typename Traits >
void BALL::ConstForwardIterator< Container, DataType, Position, Traits >::toBegin (  )  throw (Exception::Precondition) [inline]
template<typename Container, typename DataType, typename Position, typename Traits>
void BALL::ConstForwardIterator< Container, DataType, Position, Traits >::toEnd (  )  throw (Exception::SingularIterator)
template<typename Container , typename DataType , typename Position , typename Traits >
void BALL::ConstForwardIterator< Container, DataType, Position, Traits >::toEnd (  )  throw (Exception::Precondition) [inline]
Generated by  doxygen 1.6.3