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

#include <BALL/CONCEPT/forwardIterator.h>

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

List of all members.

Public Types

Typedefs

typedef DataType & reference
typedef DataType * pointer
typedef ConstForwardIterator
< Container, DataType,
Position, Traits > 
Base
typedef DataType & reference
typedef DataType * pointer
typedef ConstForwardIterator
< Container, DataType,
Position, Traits > 
Base

Public Member Functions

Constructors and Destructors

BALL_INLINE ForwardIterator ()
BALL_INLINE ForwardIterator (const ForwardIterator &iterator)
BALL_INLINE ~ForwardIterator ()
 ForwardIterator () throw ()
 ForwardIterator (const ForwardIterator &iterator) throw ()
 ~ForwardIterator () throw ()
Assignemnt

BALL_INLINE ForwardIteratoroperator= (const ForwardIterator &iterator)
BALL_INLINE void swap (ForwardIterator &iterator)
ForwardIteratoroperator= (const ForwardIterator &iterator) throw ()
void swap (ForwardIterator &iterator) throw ()

Protected Member Functions

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

Iterator methods



BALL_INLINE reference operator* () const
 Convert an iterator to its Datatype by returning a reference to the current data.
BALL_INLINE pointer operator-> () const
 Return a pointer to the current data.
BALL_INLINE ForwardIteratoroperator++ () throw (Exception::Precondition)
 Increment operator.
BALL_INLINE ForwardIterator operator++ (int) throw (Exception::Precondition)
 Postfix increment operator.
reference operator* () const throw ()
 Convert an iterator to its Datatype by returning a reference to the current data.
pointer operator-> () const throw ()
 Return a pointer to the current data.
ForwardIteratoroperator++ () throw (Exception::InvalidIterator)
 Increment operator.
ForwardIterator operator++ (int) throw (Exception::InvalidIterator)
 Postfix increment operator.
static ForwardIterator begin (const Container &container) throw (Exception::Precondition)
 Return an iterator pointing to the beginning of the container.
static ForwardIterator end (const Container &container) throw (Exception::Precondition)
 Return an iterator pointing at the end of the container.
static ForwardIterator begin (const Container &container) throw (Exception::Precondition)
 Return an iterator pointing to the beginning of the container.
static ForwardIterator 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::ForwardIterator< Container, DataType, Position, Traits >

Generic mutable forward iterator class

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


Member Typedef Documentation

template<typename Container , typename DataType , typename Position , typename Traits >
typedef ConstForwardIterator<Container, DataType, Position, Traits> BALL::ForwardIterator< Container, DataType, Position, Traits >::Base
template<typename Container , typename DataType , typename Position , typename Traits >
typedef ConstForwardIterator<Container, DataType, Position, Traits> BALL::ForwardIterator< Container, DataType, Position, Traits >::Base
template<typename Container , typename DataType , typename Position , typename Traits >
typedef DataType* BALL::ForwardIterator< Container, DataType, Position, Traits >::pointer
template<typename Container , typename DataType , typename Position , typename Traits >
typedef DataType* BALL::ForwardIterator< Container, DataType, Position, Traits >::pointer
template<typename Container , typename DataType , typename Position , typename Traits >
typedef DataType& BALL::ForwardIterator< Container, DataType, Position, Traits >::reference
template<typename Container , typename DataType , typename Position , typename Traits >
typedef DataType& BALL::ForwardIterator< Container, DataType, Position, Traits >::reference

Constructor & Destructor Documentation

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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


Member Function Documentation

template<typename Container , typename DataType , typename Position , typename Traits >
static ForwardIterator BALL::ForwardIterator< Container, DataType, Position, Traits >::begin ( const Container &  container  )  throw (Exception::Precondition) [static]

Return an iterator pointing to the beginning of the container.

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

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

Return an iterator pointing to the beginning of the container.

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

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

template<typename Container , typename DataType , typename Position , typename Traits >
static ForwardIterator BALL::ForwardIterator< Container, DataType, Position, Traits >::end ( const Container &  container  )  throw (Exception::Precondition) [static]

Return an iterator pointing at the end of the container.

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

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

Return an iterator pointing at the end of the container.

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

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

template<typename Container , typename DataType , typename Position , typename Traits >
reference BALL::ForwardIterator< Container, DataType, Position, Traits >::operator* (  )  const throw () [inline]

Convert an iterator to its Datatype by returning a reference to the current data.

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

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE reference BALL::ForwardIterator< Container, DataType, Position, Traits >::operator* (  )  const [inline]

Convert an iterator to its Datatype by returning a reference to the current data.

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

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

template<typename Container , typename DataType , typename Position , typename Traits >
ForwardIterator BALL::ForwardIterator< Container, DataType, Position, Traits >::operator++ ( int   )  throw (Exception::InvalidIterator) [inline]

Postfix increment operator.

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

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

template<typename Container , typename DataType , typename Position , typename Traits >
ForwardIterator& BALL::ForwardIterator< Container, DataType, Position, Traits >::operator++ (  )  throw (Exception::InvalidIterator) [inline]

Increment operator.

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

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE ForwardIterator BALL::ForwardIterator< Container, DataType, Position, Traits >::operator++ ( int   )  throw (Exception::Precondition) [inline]

Postfix increment operator.

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

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE ForwardIterator& BALL::ForwardIterator< Container, DataType, Position, Traits >::operator++ (  )  throw (Exception::Precondition) [inline]

Increment operator.

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

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

template<typename Container , typename DataType , typename Position , typename Traits >
pointer BALL::ForwardIterator< Container, DataType, Position, Traits >::operator-> (  )  const throw () [inline]

Return a pointer to the current data.

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

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

template<typename Container , typename DataType , typename Position , typename Traits >
BALL_INLINE pointer BALL::ForwardIterator< Container, DataType, Position, Traits >::operator-> (  )  const [inline]

Return a pointer to the current data.

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

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

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

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

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

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

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

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

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

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

Generated by  doxygen 1.6.3