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 >:

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
ima::qlf_value **	address_ () const
	Give a hook to the value address.
image &	ima () 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	next_ ()
	Go to the next element.
void	start ()
	Start an iteration.
lvalue	val () const
	Give the pixel value.
Protected Member Functions
	Pixel_Iterator ()

---

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.

---

Constructor & Destructor Documentation

template<typename E >

mln::doc::Pixel_Iterator< E >::Pixel_Iterator

(

)

[protected]

---

Member Function Documentation

template<typename E >

ima ::qlf_value** mln::doc::Generalized_Pixel< E >::address_

(

)

const [inherited]

Give a hook to the value address.

This method allows for iterators to refer to a generalized pixel.

Returns:

A pointer to the value address.

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 >::next_

(

)

[inherited]

Go to the next element.

Make the iterator jump from the current element to the next one. The current element is thus updated.

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 >.