DGtal::FreemanChain< TInteger >::ConstIterator Class Reference

#include <DGtal/geometry/curves/FreemanChain.h>

Inheritance diagram for DGtal::FreemanChain< TInteger >::ConstIterator:

Public Member Functions
	ConstIterator ()
	ConstIterator (ConstAlias< FreemanChain > aChain, Index n=0)
	ConstIterator (ConstAlias< FreemanChain > aChain, Index n, const Point &XY)
	ConstIterator (const ConstIterator &aOther)
ConstIterator &	operator= (const ConstIterator &other)
	~ConstIterator ()
const Point &	operator* () const
const Point &	get () const
ConstIterator &	operator++ ()
ConstIterator	operator++ (int)
void	next ()
void	nextInLoop ()
Index	position () const
const FreemanChain *	getChain () const
char	getCode () const
ConstIterator &	operator-- ()
ConstIterator	operator-- (int)
void	previous ()
void	previousInLoop ()
bool	operator== (const ConstIterator &aOther) const
bool	operator!= (const ConstIterator &aOther) const
bool	operator< (const ConstIterator &aOther) const

Private Attributes
const FreemanChain *	myFc
	The Freeman chain visited by the iterator. More...
Index	myPos
	The current position in the word. More...
Point	myXY
	The current coordinates of the iterator. More...

Detailed Description

template<typename TInteger>
class DGtal::FreemanChain< TInteger >::ConstIterator

This class represents an iterator on points defined by freeman chain, storing the current coordinate.

Examples

geometry/curves/exampleAlphaThickSegment.cpp.

Definition at line 141 of file FreemanChain.h.

Constructor & Destructor Documentation

ConstIterator() [1/4]

template<typename TInteger >

DGtal::FreemanChain< TInteger >::ConstIterator::ConstIterator ( )

inline

Default Constructor. The object is not valid.

Definition at line 165 of file FreemanChain.h.

          : myFc( NULL ), myPos( 0 )
        { }

ConstIterator() [2/4]

template<typename TInteger >

DGtal::FreemanChain< TInteger >::ConstIterator::ConstIterator	(	ConstAlias< FreemanChain >	aChain,
		Index	n = 0
	)

Constructor. Nb: complexity in O(n).

Parameters

aChain	a Freeman chain,
n	the position in [chain] (within 0 and chain.size()).

ConstIterator() [3/4]

template<typename TInteger >

DGtal::FreemanChain< TInteger >::ConstIterator::ConstIterator ( ConstAlias< FreemanChain >  aChain, Index  n, const Point &  XY  )

inline

Constructor. It is the user's responsability to make sure that the data's are consistent. No verification is performed.

Nb: complexity in O(1).

Parameters

aChain	a Freeman chain,
n	the position in [chain] (within 0 and chain.size()).
XY	the point corresponding to the 'n'-th position of 'chain'.

Definition at line 190 of file FreemanChain.h.

          : myFc( &aChain ), myPos( n ), myXY ( XY ) 
        { }

ConstIterator() [4/4]

template<typename TInteger >

DGtal::FreemanChain< TInteger >::ConstIterator::ConstIterator ( const ConstIterator &  aOther )

inline

Copy constructor.

Parameters

aOther

the iterator to clone.

Definition at line 198 of file FreemanChain.h.

          : myFc( aOther.myFc ), myPos( aOther.myPos ), myXY( aOther.myXY )
        { } 

~ConstIterator()

template<typename TInteger >

DGtal::FreemanChain< TInteger >::ConstIterator::~ConstIterator ( )

inline

Destructor. Does nothing.

Definition at line 212 of file FreemanChain.h.

        { }

Member Function Documentation

get()

template<typename TInteger >

const Point & DGtal::FreemanChain< TInteger >::ConstIterator::get ( ) const

inline

Returns

the current coordinates.

Definition at line 230 of file FreemanChain.h.

        {
          return myXY;
        }

References DGtal::FreemanChain< TInteger >::ConstIterator::myXY.

getChain()

template<typename TInteger >

const FreemanChain * DGtal::FreemanChain< TInteger >::ConstIterator::getChain ( ) const

inline

Returns

the associated Freeman chain.

Definition at line 279 of file FreemanChain.h.

        {
          return myFc;
        }

References DGtal::FreemanChain< TInteger >::ConstIterator::myFc.

getCode()

template<typename TInteger >

char DGtal::FreemanChain< TInteger >::ConstIterator::getCode ( ) const

inline

Returns

the current Freeman code (specifies the movement to the next point).

Definition at line 289 of file FreemanChain.h.

        {
          ASSERT( myFc != 0 );
          return myFc->code( myPos );
        }

References DGtal::FreemanChain< TInteger >::code(), DGtal::FreemanChain< TInteger >::ConstIterator::myFc, and DGtal::FreemanChain< TInteger >::ConstIterator::myPos.

next()

template<typename TInteger >

void DGtal::FreemanChain< TInteger >::ConstIterator::next

(

)

Goes to the next point on the chain.

Referenced by DGtal::FreemanChain< TInteger >::ConstIterator::operator++().

nextInLoop()

template<typename TInteger >

void DGtal::FreemanChain< TInteger >::ConstIterator::nextInLoop

(

)

Goes to the next point on the chain as if on a loop.

operator!=()

template<typename TInteger >

bool DGtal::FreemanChain< TInteger >::ConstIterator::operator!= ( const ConstIterator &  aOther ) const

inline

Inequality operator.

Parameters

aOther

the iterator to compare with (must be defined on the same chain).

Returns

'true' if their current positions differs.

Definition at line 353 of file FreemanChain.h.

        {
          ASSERT( myFc == aOther.myFc );
          return myPos != aOther.myPos;
        }

References DGtal::FreemanChain< TInteger >::ConstIterator::myFc, and DGtal::FreemanChain< TInteger >::ConstIterator::myPos.

operator*()

template<typename TInteger >

const Point & DGtal::FreemanChain< TInteger >::ConstIterator::operator* ( ) const

inline

Returns

the current coordinates.

Definition at line 222 of file FreemanChain.h.

        {
          return myXY;
        }

References DGtal::FreemanChain< TInteger >::ConstIterator::myXY.

operator++() [1/2]

template<typename TInteger >

ConstIterator & DGtal::FreemanChain< TInteger >::ConstIterator::operator++ ( )

inline

Pre-increment. Goes to the next point on the chain.

Definition at line 239 of file FreemanChain.h.

        {
          this->next();
          return *this;
        }

References DGtal::FreemanChain< TInteger >::ConstIterator::next().

operator++() [2/2]

template<typename TInteger >

ConstIterator DGtal::FreemanChain< TInteger >::ConstIterator::operator++ ( int  )

inline

Post-increment. Goes to the next point on the chain.

Definition at line 249 of file FreemanChain.h.

        {
          ConstIterator tmp(*this);
          this->next();
          return tmp;
        }

References DGtal::FreemanChain< TInteger >::ConstIterator::next().

operator--() [1/2]

template<typename TInteger >

ConstIterator & DGtal::FreemanChain< TInteger >::ConstIterator::operator-- ( )

inline

Pre-decrement. Goes to the previous point on the chain.

Definition at line 300 of file FreemanChain.h.

        {
          this->previous();
          return *this;
        }

References DGtal::FreemanChain< TInteger >::ConstIterator::previous().

operator--() [2/2]

template<typename TInteger >

ConstIterator DGtal::FreemanChain< TInteger >::ConstIterator::operator-- ( int  )

inline

Post-decrement. Goes to the previous point on the chain.

Definition at line 310 of file FreemanChain.h.

        {
          ConstIterator tmp(*this);
          this->previous();
          return tmp;
        }

References DGtal::FreemanChain< TInteger >::ConstIterator::previous().

operator<()

template<typename TInteger >

bool DGtal::FreemanChain< TInteger >::ConstIterator::operator< ( const ConstIterator &  aOther ) const

inline

Inferior operator.

Parameters

aOther

the iterator to compare with (must be defined on the same chain).

Returns

'true' if the current position of 'this' is before the current position of [aOther].

Definition at line 368 of file FreemanChain.h.

        {
          ASSERT( myFc == aOther.myFc );
          return myPos < aOther.myPos;
        }

References DGtal::FreemanChain< TInteger >::ConstIterator::myFc, and DGtal::FreemanChain< TInteger >::ConstIterator::myPos.

operator=()

template<typename TInteger >

ConstIterator & DGtal::FreemanChain< TInteger >::ConstIterator::operator=

(

const ConstIterator &

other

)

Assignment.

Parameters

other

the iterator to copy.

Returns

a reference on 'this'.

operator==()

template<typename TInteger >

bool DGtal::FreemanChain< TInteger >::ConstIterator::operator== ( const ConstIterator &  aOther ) const

inline

Equality operator.

Parameters

aOther

the iterator to compare with (must be defined on the same chain).

Returns

'true' if their current positions coincide.

Definition at line 338 of file FreemanChain.h.

        {
          ASSERT( myFc == aOther.myFc );
          return myPos == aOther.myPos;
        }

References DGtal::FreemanChain< TInteger >::ConstIterator::myFc, and DGtal::FreemanChain< TInteger >::ConstIterator::myPos.

position()

template<typename TInteger >

Index DGtal::FreemanChain< TInteger >::ConstIterator::position ( ) const

inline

Returns

the current position (as an index in the Freeman chain).

Definition at line 270 of file FreemanChain.h.

        {
          return myPos;
        }

References DGtal::FreemanChain< TInteger >::ConstIterator::myPos.

previous()

template<typename TInteger >

void DGtal::FreemanChain< TInteger >::ConstIterator::previous

(

)

Goes to the previous point on the chain if possible.

Referenced by DGtal::FreemanChain< TInteger >::ConstIterator::operator--().

previousInLoop()

template<typename TInteger >

void DGtal::FreemanChain< TInteger >::ConstIterator::previousInLoop

(

)

Goes to the previous point on the chain as if on a loop.

Field Documentation

myFc

template<typename TInteger >

const FreemanChain* DGtal::FreemanChain< TInteger >::ConstIterator::myFc

private

The Freeman chain visited by the iterator.

Definition at line 150 of file FreemanChain.h.

Referenced by DGtal::FreemanChain< TInteger >::ConstIterator::getChain(), DGtal::FreemanChain< TInteger >::ConstIterator::getCode(), DGtal::FreemanChain< TInteger >::ConstIterator::operator!=(), DGtal::FreemanChain< TInteger >::ConstIterator::operator<(), and DGtal::FreemanChain< TInteger >::ConstIterator::operator==().

myPos

template<typename TInteger >

Index DGtal::FreemanChain< TInteger >::ConstIterator::myPos

private

The current position in the word.

Definition at line 153 of file FreemanChain.h.

Referenced by DGtal::FreemanChain< TInteger >::ConstIterator::getCode(), DGtal::FreemanChain< TInteger >::ConstIterator::operator!=(), DGtal::FreemanChain< TInteger >::ConstIterator::operator<(), DGtal::FreemanChain< TInteger >::ConstIterator::operator==(), and DGtal::FreemanChain< TInteger >::ConstIterator::position().

myXY

template<typename TInteger >

Point DGtal::FreemanChain< TInteger >::ConstIterator::myXY

private

The current coordinates of the iterator.

Definition at line 156 of file FreemanChain.h.

Referenced by DGtal::FreemanChain< TInteger >::ConstIterator::get(), and DGtal::FreemanChain< TInteger >::ConstIterator::operator*().

---

The documentation for this class was generated from the following file:

• FreemanChain.h