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

#include <mln/core/box_runstart_piter.hh>

Public Member Functions

 box_runstart_piter (const box< P > &b)
 box_runstart_piter ()
void change_target (const box< P > &s)
void change_target_ (const box< P > &s)
void init_ (const box< P > &b)
void invalidate ()
bool is_valid () const
void next ()
const box< P >::psitep_hook_ () const
unsigned run_length () const
const box< P > & site_set () const
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 = super_::dim }
typedef Site_Proxy< void > category
typedef box_runstart_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_runstart_piter< P >

Definition at line 52 of file box_runstart_piter.hh.

Constructor & Destructor Documentation

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

Constructor.

Parameters
[in]bA box.
template<typename P>
mln::box_runstart_piter< P >::box_runstart_piter ( )

Member Function Documentation

void mln::internal::site_set_iterator_base< box< P > , box_runstart_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_runstart_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).

template<typename P>
void mln::box_runstart_piter< P >::init_ ( const box< P > &  b)

INTERNAL_API Delayed initialization.

void mln::Site_Iterator< box_runstart_piter< P > >::invalidate ( )
inherited
bool mln::Site_Iterator< box_runstart_piter< P > >::is_valid ( ) const
inherited
void mln::Site_Iterator< box_runstart_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.
const box< P > ::psite& mln::internal::site_set_iterator_base< box< P > , box_runstart_piter< P > >::p_hook_ ( ) const
inherited

INTERNAL_API Hook to the current location.

template<typename P>
unsigned mln::box_runstart_piter< P >::run_length ( ) const

Give the lenght of the run.

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

Give the site set that this iterator browses.

void mln::Site_Iterator< box_runstart_piter< P > >::start ( )
inherited
const box< P > ::psite& mln::internal::site_iterator_base< box< P > , box_runstart_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_runstart_piter< P > >::target_ ( )
inherited

Give the target address. It might be 0.

const box< P > ::site& mln::internal::site_iterator_base< box< P > , box_runstart_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_runstart_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_runstart_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_runstart_piter< P > >::category
inherited

Definition at line 68 of file site_proxy.hh.

typedef box_runstart_piter< P > mln::Object< box_runstart_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_runstart_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_runstart_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_runstart_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 61 of file box_runstart_piter.hh.