tool::iterator< Bottom > Struct Template Reference

#include <wipal/tool/iterator.hh>

Inheritance diagram for tool::iterator< Bottom >:

tool::static_base< Bottom > tool::valued_iterator< Bottom > tool::window< InputIterator, WSize, Step, Bottom > wifi::frame::filter::internals::non_noisy_prism_iterator< I, B, Bottom > wifi::frame::filter::internals::uniquely_identifiable_iterator< U, I, H, B, Bottom >

List of all members.


Detailed Description

template<class Bottom>
struct tool::iterator< Bottom >

Base interface for iterators.

iterator provides the standard operators one expects from iterators (== , != , ++ , * , -> ).

To subclass iterator, you must provide the following methods:


Public Types

typedef HIDDEN exact_type
Iterator types.
typedef ssize_t difference_type
typedef HIDDEN value_type
typedef value_type * pointer
typedef value_type & reference
typedef std::input_iterator_tag iterator_category

Public Member Functions

Equality checks
bool operator== (const exact_type &) const
bool operator!= (const exact_type &) const
Increment operators
const exact_typeoperator++ ()
exact_type operator++ (int)
Indirections
const value_type & operator* () const
const value_type * operator-> () const
Downcast methods
const exact_typeexact () const
exact_typeexact ()
const exact_typeexact_ptr () const
exact_typeexact_ptr ()

Protected Member Functions

 ~iterator ()

Member Typedef Documentation

template<class Bottom>
typedef HIDDEN tool::iterator< Bottom >::exact_type


Constructor & Destructor Documentation

template<class B>
tool::iterator< B >::~iterator (  )  [inline, protected]

Protected destructor: iterator is abstract.


Member Function Documentation

template<class Bottom>
const static_base< Bottom >::exact_type & tool::static_base< Bottom >::exact (  )  const [inline, inherited]

Safely downcast to the exact type as a const reference.

template<class Bottom>
static_base< Bottom >::exact_type & tool::static_base< Bottom >::exact (  )  [inline, inherited]

Safely downcast to the exact type as a non-const reference.

template<class Bottom>
const static_base< Bottom >::exact_type * tool::static_base< Bottom >::exact_ptr (  )  const [inline, inherited]

Safely downcast to the exact type as a const pointer.

template<class Bottom>
static_base< Bottom >::exact_type * tool::static_base< Bottom >::exact_ptr (  )  [inline, inherited]

Safely downcast to the exact type as a non-const pointer.


The documentation for this struct was generated from the following files:

Generated on Tue Dec 2 11:12:17 2008 for wipal by  doxygen 1.5.6