$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E > Class Template Reference

#include <mln/topo/internal/complex_relative_iterator_sequence.hh>

Public Member Functions

void next ()
 complex_relative_iterator_sequence ()
template<typename Fref >
 complex_relative_iterator_sequence (const Fref &f_ref)
void center_at (const center_type &c)
bool is_valid () const
void invalidate ()
void start ()
void next_ ()
 operator typename const_face_type_< I1 >::ret () const

Protected Member Functions

void update_ ()

Protected Attributes

face_type f_
I1 iter1_
I2 iter2_

Public Types

typedef Object< void > category
typedef I1::center_type center_type
typedef E exact_t
typedef I1::face_type face_type

Detailed Description

template<typename I1, typename I2, typename E>
class mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >

Definition at line 73 of file complex_relative_iterator_sequence.hh.

Constructor & Destructor Documentation

template<typename I1, typename I2, typename E>
mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::complex_relative_iterator_sequence ( )

Construction and assignment.

template<typename I1, typename I2, typename E>
template<typename Fref >
mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::complex_relative_iterator_sequence ( const Fref &  f_ref)

Member Function Documentation

template<typename I1, typename I2, typename E>
void mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::center_at ( const center_type c)

Manipulation.

Change the center face.

template<typename I1, typename I2, typename E>
void mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::invalidate ( )

Invalidate the iterator.

template<typename I1, typename I2, typename E>
bool mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::is_valid ( ) const

Test if the iterator is valid.

template<typename E>
void mln::Iterator< E >::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 I1, typename I2, typename E>
void mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::next_ ( )

Go to the next point.

template<typename I1, typename I2, typename E>
mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::operator typename const_face_type_< I1 >::ret ( ) const

Conversion.

Return a reference to the corresponding face handle.

template<typename I1, typename I2, typename E>
void mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::start ( )

Start an iteration.

template<typename I1, typename I2, typename E>
void mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::update_ ( )
protected

Update the target face.

Member Data Documentation

template<typename I1, typename I2, typename E>
face_type mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::f_
protected

The face handle this iterator is pointing to.

Definition at line 124 of file complex_relative_iterator_sequence.hh.

template<typename I1, typename I2, typename E>
I1 mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::iter1_
protected

The first complex relative iterator.

Definition at line 119 of file complex_relative_iterator_sequence.hh.

template<typename I1, typename I2, typename E>
I2 mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::iter2_
protected

The second complex relative iterator.

Definition at line 121 of file complex_relative_iterator_sequence.hh.

Member Typedef Documentation

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

Definition at line 106 of file object.hh.

template<typename I1, typename I2, typename E>
typedef I1::center_type mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::center_type

The type of the center face.

Definition at line 79 of file complex_relative_iterator_sequence.hh.

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

Definition at line 105 of file object.hh.

template<typename I1, typename I2, typename E>
typedef I1::face_type mln::topo::internal::complex_relative_iterator_sequence< I1, I2, E >::face_type

The type of the iterated faces.

Definition at line 81 of file complex_relative_iterator_sequence.hh.