eVision::EObjectRunsIterator Class Reference

Iterator to the runs of a coded element. More...

#include <eVision/EasyObject/EasyObject2/EObjectRunsIterator.h>

Collaboration diagram for eVision::EObjectRunsIterator:

Public Member Functions
	EObjectRunsIterator (const eVision::ECodedElement &codedElement)
	Constructs an iterator to the runs of a coded element.
	EObjectRunsIterator (const eVision::EObjectRunsIterator &other)
	Constructs an iterator to the runs of a coded element.
virtual	~EObjectRunsIterator () throw ()
eVision::EObjectRunsIterator &	operator= (const eVision::EObjectRunsIterator &other)
	Assignment operator.
void	First () const
	Rewinds to the first run of the coded element.
bool	IsDone () const
	Tests whether all the runs have been spanned.
void	Next () const
	Advance to the next run in the iterator.
int	GetY () const
	Returns the ordinate (Y-coordinate) of the run the iterator is currently over.
int	GetStartX () const
	Returns the abscissa (X-coordinate) of the leftmost pixel of the run the iterator is currently over.
int	GetEndX () const
	Returns the abscissa (X-coordinate) of the rightmost pixel of the run the iterator is currently over.
unsigned int	GetLength () const
	Returns the lengths of the run the iterator is currently over.
	EObjectRunsIterator (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

Iterator to the runs of a coded element.

This class is responsible for the sequential access to the individual runs of a coded element.

A run is defined as a maximal sequence of consecutive pixels on the same run, that all belong to the same coded element.

License(s): EasyObject

Constructor & Destructor Documentation

EObjectRunsIterator() [1/3]

eVision::EObjectRunsIterator::EObjectRunsIterator

(

const eVision::ECodedElement &

codedElement

)

Constructs an iterator to the runs of a coded element.

Parameters

codedElement

The coded element of interest, in the case the iterator is to be constructed from a given coded element.

EObjectRunsIterator() [2/3]

eVision::EObjectRunsIterator::EObjectRunsIterator

(

const eVision::EObjectRunsIterator &

other

)

Constructs an iterator to the runs of a coded element.

Parameters

other

The iterator to be copied, in the case of the copy constructor.

~EObjectRunsIterator()

eVision::EObjectRunsIterator::~EObjectRunsIterator ( ) throw (  )

virtual

EObjectRunsIterator() [3/3]

eVision::EObjectRunsIterator::EObjectRunsIterator

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

First()

void eVision::EObjectRunsIterator::First

(

)

const

Rewinds to the first run of the coded element.

GetEndX()

int eVision::EObjectRunsIterator::GetEndX

(

)

const

Returns the abscissa (X-coordinate) of the rightmost pixel of the run the iterator is currently over.

An exception is thrown if the iterator has reached its end. Use EObjectRunsIterator::IsDone to check this condition.

GetLength()

unsigned int eVision::EObjectRunsIterator::GetLength

(

)

const

Returns the lengths of the run the iterator is currently over.

An exception is thrown if the iterator has reached its end. Use EObjectRunsIterator::IsDone to check this condition.

GetStartX()

int eVision::EObjectRunsIterator::GetStartX

(

)

const

Returns the abscissa (X-coordinate) of the leftmost pixel of the run the iterator is currently over.

An exception is thrown if the iterator has reached its end. Use EObjectRunsIterator::IsDone to check this condition.

GetY()

int eVision::EObjectRunsIterator::GetY

(

)

const

Returns the ordinate (Y-coordinate) of the run the iterator is currently over.

An exception is thrown if the iterator has reached its end. Use EObjectRunsIterator::IsDone to check this condition.

IsDone()

bool eVision::EObjectRunsIterator::IsDone

(

)

const

Tests whether all the runs have been spanned.

Next()

void eVision::EObjectRunsIterator::Next

(

)

const

Advance to the next run in the iterator.

An exception is thrown if the iterator has reached its end. Use EObjectRunsIterator::IsDone to check this condition.

operator=()

eVision::EObjectRunsIterator & eVision::EObjectRunsIterator::operator=

(

const eVision::EObjectRunsIterator &

other

)

Assignment operator.

Parameters

other

The iterator to be copied.

Member Data Documentation

wrappedClass_

CppWrapperInternal::WrappedClass eVision::EObjectRunsIterator::wrappedClass_