Generic iterator on point sites of a mln::S. More...

#include <p_graph_piter.hh>

Inheritance diagram for mln::p_graph_piter< S, I >:

Public Types
typedef Site_Proxy< void >	category
typedef p_graph_piter< S, I >	exact_t
typedef S	pset
	The associated site set type.
typedef S::site	site
	The associated site type (as a Site_Proxy).
typedef S	target
	The associated target type.
Public Member Functions
void	change_target (const S &s)
	Change the site set targeted by this iterator.
const S::graph_t &	graph () const
	Return the graph associated to the target S.
const iter &	hook_elt_ () const
	Return the underlying graph element iterator.
unsigned	id () const
	Return the graph element id.
void	invalidate ()
bool	is_valid () const
	mln_q_subject (iter) element()
	Return the underlying graph element.
void	next ()
	Go to the next element.
const S::psite &	p_hook_ () const
	Hook to the current location.
const S &	site_set () const
	Give the site set that this iterator browses.
void	start ()
const S::psite &	subj_ ()
	Give the subject (required by the Proxy interface).
const S *&	target_ ()
	Give the target address. It might be 0.
const S::site &	to_site () const
	Return the site it points to (as a Site_Proxy).


	p_graph_piter ()
	Constructors.
	p_graph_piter (const S &pv)


bool	is_valid_ () const
	Manipulation.
void	invalidate_ ()
	Invalidate the iterator.
void	start_ ()
	Start an iteration.
void	next_ ()
	Go to the next point.
Protected Attributes
S::psite	p_
	The psite designated by this iterator.
const S *	s_
	The target.
Private Types
typedef I	iter
typedef p_graph_piter< S, I >	self_
typedef internal::site_set_iterator_base < S, self_ >	super_
Private Member Functions
void	update_ ()
	Update the psite corresponding to this iterator.
Private Attributes
iter	iter_
	The underlying graph iterator.

Detailed Description

template<typename S, typename I>
class mln::p_graph_piter< S, I >

Generic iterator on point sites of a mln::S.

Member Typedef Documentation

typedef Site_Proxy<void> mln::Site_Proxy< p_graph_piter< S, I > >::category [inherited]

Reimplemented from mln::Proxy< p_graph_piter< S, I > >.

typedef p_graph_piter< S, I > mln::Object< p_graph_piter< S, I > >::exact_t [inherited]

template<typename S, typename I>

typedef I mln::p_graph_piter< S, I >::iter [private]

typedef S mln::internal::site_set_iterator_base< S, p_graph_piter< S, I > >::pset [inherited]

The associated site set type.

template<typename S, typename I>

typedef p_graph_piter<S,I> mln::p_graph_piter< S, I >::self_ [private]

typedef S ::site mln::internal::site_iterator_base< S, p_graph_piter< S, I > >::site [inherited]

The associated site type (as a Site_Proxy).

template<typename S, typename I>

typedef internal::site_set_iterator_base< S, self_ > mln::p_graph_piter< S, I >::super_ [private]

Reimplemented from mln::internal::site_iterator_base< S, p_graph_piter< S, I > >.

typedef S mln::internal::site_iterator_base< S, p_graph_piter< S, I > >::target [inherited]

The associated target type.

Constructor & Destructor Documentation

template<typename S , typename I >

mln::p_graph_piter< S, I >::p_graph_piter ( ) [inline]

Constructors.

References mln::Site_Iterator< p_graph_piter< S, I > >::is_valid().

template<typename S , typename I >

mln::p_graph_piter< S, I >::p_graph_piter ( const S & pv ) [inline]

References mln::internal::site_set_iterator_base< S, p_graph_piter< S, I > >::change_target(), and mln::Site_Iterator< p_graph_piter< S, I > >::is_valid().

Member Function Documentation

void mln::internal::site_set_iterator_base< S, p_graph_piter< S, I > >::change_target ( const S & s ) [inherited]

Change the site set targeted by this iterator.

Referenced by mln::p_graph_piter< S, I >::p_graph_piter().

template<typename S , typename I >

const S::graph_t & mln::p_graph_piter< S, I >::graph ( ) const [inline]

Return the graph associated to the target S.

References mln::internal::site_set_iterator_base< S, p_graph_piter< S, I > >::site_set().

template<typename S , typename I >

const I & mln::p_graph_piter< S, I >::hook_elt_ ( ) const [inline]

Return the underlying graph element iterator.

References mln::p_graph_piter< S, I >::iter_.

Referenced by mln::graph_window_piter< S, W, I >::center_at_(), and mln::graph_window_if_piter< S, W, I >::center_at_().

template<typename S , typename I >

unsigned mln::p_graph_piter< S, I >::id ( ) const [inline]

Return the graph element id.

References mln::p_graph_piter< S, I >::iter_.

void mln::Site_Iterator< p_graph_piter< S, I > >::invalidate ( ) [inherited]

template<typename S , typename I >

void mln::p_graph_piter< S, I >::invalidate_ ( ) [inline]

Invalidate the iterator.

References mln::p_graph_piter< S, I >::iter_.

bool mln::Site_Iterator< p_graph_piter< S, I > >::is_valid ( ) const [inherited]

Referenced by mln::p_graph_piter< S, I >::next_(), mln::p_graph_piter< S, I >::p_graph_piter(), mln::p_graph_piter< S, I >::start_(), and mln::p_graph_piter< S, I >::update_().

template<typename S , typename I >

bool mln::p_graph_piter< S, I >::is_valid_ ( ) const [inline]

Manipulation.

Test if the iterator is valid.

References mln::p_graph_piter< S, I >::iter_.

template<typename S, typename I>

mln::p_graph_piter< S, I >::mln_q_subject ( iter )

Return the underlying graph element.

void mln::Site_Iterator< p_graph_piter< S, I > >::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.