$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::Site_Iterator< E > Struct Template Reference

#include <mln/core/concept/site_iterator.hh>

Public Member Functions

void invalidate ()
bool is_valid () const
void next ()
void start ()

Protected Member Functions

 Site_Iterator ()

Public Types

typedef Site_Proxy< void > category
typedef E exact_t

Detailed Description

template<typename E>
struct mln::Site_Iterator< E >

Base class for implementation of classes of iterator on points.

An iterator on points is an iterator that browse over a set of points.

Definition at line 54 of file site_iterator.hh.

Constructor & Destructor Documentation

template<typename E>
mln::Site_Iterator< E >::Site_Iterator ( )
protected

Member Function Documentation

template<typename E>
void mln::Site_Iterator< E >::invalidate ( )
template<typename E>
bool mln::Site_Iterator< E >::is_valid ( ) const
template<typename E>
void mln::Site_Iterator< E >::next ( )

Go to the next element.

Warning
This is a final method; iterator classes should not re-defined this method. The actual "next" operation has to be defined through the next_ method.
Precondition
The iterator is valid.
template<typename E>
void mln::Site_Iterator< E >::start ( )

Reimplemented in mln::hexa_fwd_piter_< S >.

Member Typedef Documentation

template<typename E>
typedef Site_Proxy<void> mln::Site_Proxy< E >::category
inherited

Definition at line 68 of file site_proxy.hh.

template<typename E>
typedef E mln::Object< E >::exact_t
inherited

Definition at line 105 of file object.hh.