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

#include <mln/core/site_set/box_piter.hh>

Public Member Functions

 box_fwd_piter_ ()
 box_fwd_piter_ (const mln::box< P > &b)
void change_target (const box< P > &s)
void change_target_ (const box< P > &s)
void invalidate ()
void invalidate_ ()
bool is_valid () const
bool is_valid_ () const
void next ()
void next_ ()
const box< P >::psitep_hook_ () const
const box< P > & site_set () const
void start ()
void start_ ()
const box< P >::psitesubj_ ()
const box< P > *& target_ ()
const box< P >::siteto_site () const

Protected Attributes

box< P >::psite p_
const box< P > * s_

Public Types

enum  { dim = P::dim }
typedef Site_Proxy< void > category
typedef box_fwd_piter_< P > exact_t
typedef box< P > pset
typedef box< P >::site site
typedef box< P > target

Detailed Description

template<typename P>
class mln::box_fwd_piter_< P >

A generic forward iterator on points of boxes.

The parameter P is the type of points.

See Also
mln::box

Definition at line 50 of file box_piter.hh.

Constructor & Destructor Documentation

template<typename P >
mln::box_fwd_piter_< P >::box_fwd_piter_ ( )

Constructor without argument.

template<typename P >
mln::box_fwd_piter_< P >::box_fwd_piter_ ( const mln::box< P > &  b)

Constructor.

Parameters
[in]bA box.

Member Function Documentation

void mln::internal::site_set_iterator_base< box< P > , box_fwd_piter_< P > >::change_target ( const box< P > &  s)
inherited

Change the site set targeted by this iterator.

void mln::internal::site_set_iterator_base< box< P > , box_fwd_piter_< P > >::change_target_ ( const box< P > &  s)
inherited

Part of the change_target specific to the exact iterator type, empty by default (to be overloaded).

void mln::Site_Iterator< box_fwd_piter_< P > >::invalidate ( )
inherited
template<typename P >
void mln::box_fwd_piter_< P >::invalidate_ ( )

Invalidate the iterator.

bool mln::Site_Iterator< box_fwd_piter_< P > >::is_valid ( ) const
inherited
template<typename P >
bool mln::box_fwd_piter_< P >::is_valid_ ( ) const

INTERNAL_API Test the iterator validity.

void mln::Site_Iterator< box_fwd_piter_< P > >::next ( )
inherited

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 P >
void mln::box_fwd_piter_< P >::next_ ( )

Go to the next point.

const box< P > ::psite& mln::internal::site_set_iterator_base< box< P > , box_fwd_piter_< P > >::p_hook_ ( ) const
inherited

INTERNAL_API Hook to the current location.

const box< P > & mln::internal::site_set_iterator_base< box< P > , box_fwd_piter_< P > >::site_set ( ) const
inherited

Give the site set that this iterator browses.

void mln::Site_Iterator< box_fwd_piter_< P > >::start ( )
inherited
template<typename P >
void mln::box_fwd_piter_< P >::start_ ( )

Start an iteration.

const box< P > ::psite& mln::internal::site_iterator_base< box< P > , box_fwd_piter_< P > >::subj_ ( )
inherited

INTERNAL_API Give the subject (required by the Proxy interface).

const box< P > *& mln::internal::site_iterator_base< box< P > , box_fwd_piter_< P > >::target_ ( )
inherited

Give the target address. It might be 0.

const box< P > ::site& mln::internal::site_iterator_base< box< P > , box_fwd_piter_< P > >::to_site ( ) const
inherited

Return the site it points to (as a Site_Proxy).

Member Data Documentation

box< P > ::psite mln::internal::site_set_iterator_base< box< P > , box_fwd_piter_< P > >::p_
protectedinherited

The psite designated by this iterator.

Definition at line 80 of file site_set_iterator_base.hh.

const box< P > * mln::internal::site_iterator_base< box< P > , box_fwd_piter_< P > >::s_
protectedinherited

The target.

Definition at line 91 of file site_iterator_base.hh.

Member Typedef Documentation

typedef Site_Proxy<void> mln::Site_Proxy< box_fwd_piter_< P > >::category
inherited

Definition at line 68 of file site_proxy.hh.

typedef box_fwd_piter_< P > mln::Object< box_fwd_piter_< P > >::exact_t
inherited

Definition at line 105 of file object.hh.

typedef box< P > mln::internal::site_set_iterator_base< box< P > , box_fwd_piter_< P > >::pset
inherited

The associated site set type.

Definition at line 60 of file site_set_iterator_base.hh.

typedef box< P > ::site mln::internal::site_iterator_base< box< P > , box_fwd_piter_< P > >::site
inherited

The associated site type (as a Site_Proxy).

Definition at line 64 of file site_iterator_base.hh.

typedef box< P > mln::internal::site_iterator_base< box< P > , box_fwd_piter_< P > >::target
inherited

The associated target type.

Definition at line 61 of file site_iterator_base.hh.

Member Enumeration Documentation

template<typename P >
anonymous enum
Enumerator:
dim 

Definition at line 59 of file box_piter.hh.