tool::iterable< Bottom > Struct Template Reference

Base class to represent iterable objects. More...

#include <wipal/tool/iterable.hh>

Inheritance diagram for tool::iterable< Bottom >:

tool::static_base< Bottom > pcapxx::descriptor< Bottom > tool::window_maker< InputIterator, WSize, Step, Bottom > wifi::frame::filter::non_noisy_prism< InputIterator, Bottom > wifi::frame::filter::uniquely_identifiable< UniqueId, InputIterator, HeaderType, Bottom >

List of all members.

Public Types

typedef HIDDEN exact_type
Iterator types
typedef HIDDEN iterator
typedef iterator const_iterator

Public Member Functions

iterator begin () const
iterator end () const
template<class OutputIterator>
void operator() (const OutputIterator &output) const
Apply a function/functor to each element
template<class Functor>
void for_each (Functor &f) const
template<class Functor>
void for_each (const Functor &f) const
Downcast methods
const exact_typeexact () const
exact_typeexact ()
const exact_typeexact_ptr () const
exact_typeexact_ptr ()


Detailed Description

template<class Bottom = bottom>
struct tool::iterable< Bottom >

Base class to represent iterable objects.

An iterable oject aggregates elements on which iteration is possible. iterable provides basic mechanisms to permorm this iteration. That is, it provides the iterable::iterator and iterable::const_iterator types, begin() / end() methods, and operator()().

In order to subclass iterable, you must define an iterator type for your iterable class. This type must have a similar constructor:

 my_iterator::my_iterator(const my_iterable& e, bool at_end);

The first argument refers to the object you want to iterate on. The second one indicates whether to point the iterator at the begining or past the end of this object's elements.

Once you defined this iterator type, just declare it as part of your iterable class' virtual types :

 template <MyIterableParams>
 struct types< MyIterable<MyIterableParams> >
 {
   typedef my_iterator iterator;
 };

See also:
iterator

Member Typedef Documentation

template<class Bottom = bottom>
typedef HIDDEN tool::iterable< Bottom >::exact_type

Exact type for this template instantiation.

Reimplemented from tool::static_base< Bottom >.

Reimplemented in pcapxx::descriptor< Bottom >.


Member Function Documentation

template<class B>
iterable< B >::iterator tool::iterable< B >::begin (  )  const [inline]

Get an iterator to the first element.

References tool::static_base< Bottom >::exact().

Referenced by tool::iterable< Bottom >::operator()().

template<class B>
iterable< B >::iterator tool::iterable< B >::end (  )  const [inline]

template<class B>
template<class O>
void tool::iterable< B >::operator() ( const O &  output  )  const [inline]

Copy elements to output .

References tool::iterable< Bottom >::begin(), and tool::iterable< Bottom >::end().

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

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.

Referenced by pcapxx::frame_descriptor< PCAPDescriptor >::frame_descriptor().

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 Wed Jul 30 19:51:35 2008 for wipal by  doxygen 1.5.6