Public Types | Public Member Functions

mln::doc::Pixel_Iterator< E > Struct Template Reference

Documentation class for mln::Iterator. More...

#include <pixel_iterator.hh>

Inheritance diagram for mln::doc::Pixel_Iterator< E >:
Inheritance graph

List of all members.

Public Types

typedef void image
 Image associated type (with possible const qualification).
typedef void lvalue
 Type returned by the read-write dereference operator.
typedef void rvalue
 Read-only value associated type.
typedef void value
 Value associated type.

Public Member Functions

imageima () const
 Give the image of this generalized pixel.
void invalidate ()
 Invalidate the iterator.
bool is_valid () const
 Returns true if the iterator is valid, that is, designates an element.
void start ()
 Start an iteration.
lvalue val () const
 Give the pixel value.

Detailed Description

template<typename E>
struct mln::doc::Pixel_Iterator< E >

Documentation class for mln::Iterator.

See also:
mln::Pixel_Iterator

Definition at line 36 of file doc/pixel_iterator.hh.


Member Typedef Documentation

template<typename E >
typedef void mln::doc::Generalized_Pixel< E >::image [inherited]

Image associated type (with possible const qualification).

Definition at line 49 of file doc/generalized_pixel.hh.

template<typename E >
typedef void mln::doc::Pixel_Iterator< E >::lvalue

Type returned by the read-write dereference operator.

Definition at line 41 of file doc/pixel_iterator.hh.

template<typename E >
typedef void mln::doc::Generalized_Pixel< E >::rvalue [inherited]

Read-only value associated type.

Definition at line 55 of file doc/generalized_pixel.hh.

template<typename E >
typedef void mln::doc::Generalized_Pixel< E >::value [inherited]

Value associated type.

Definition at line 52 of file doc/generalized_pixel.hh.


Member Function Documentation

template<typename E >
image& mln::doc::Generalized_Pixel< E >::ima (  )  const [inherited]

Give the image of this generalized pixel.

The constness of a pixel object is not transmitted to the underlying image.

template<typename E >
void mln::doc::Iterator< E >::invalidate (  )  [inherited]

Invalidate the iterator.

template<typename E >
bool mln::doc::Iterator< E >::is_valid (  )  const [inherited]

Returns true if the iterator is valid, that is, designates an element.

template<typename E >
void mln::doc::Iterator< E >::start (  )  [inherited]

Start an iteration.

Make the iterator designate the first element if it exists. If this first element does not exist, the iterator is not valid.

template<typename E >
lvalue mln::doc::Pixel_Iterator< E >::val (  )  const

Give the pixel value.

Returns:
The current pixel value; this value cannot be modified.

Reimplemented from mln::doc::Generalized_Pixel< E >.