eVision.EObjectRunsIterator Class Reference

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

Inheritance diagram for eVision.EObjectRunsIterator:

Collaboration diagram for eVision.EObjectRunsIterator:

Public Member Functions
	EObjectRunsIterator (eVision.ECodedElement codedElement)
	Constructs an iterator to the runs of a coded element.
	EObjectRunsIterator (eVision.EObjectRunsIterator other)
	Constructs an iterator to the runs of a coded element.
void	First ()
	Rewinds to the first run of the coded element.
void	Next ()
	Advance to the next run in the iterator.

Properties
bool	IsDone [get]
	Tests whether all the runs have been spanned.
int	Y [get]
	Returns the ordinate (Y-coordinate) of the run the iterator is currently over.
int	StartX [get]
	Returns the abscissa (X-coordinate) of the leftmost pixel of the run the iterator is currently over.
int	EndX [get]
	Returns the abscissa (X-coordinate) of the rightmost pixel of the run the iterator is currently over.
uint	Length [get]
	Returns the lengths of the run the iterator is currently over.

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/2]

eVision.EObjectRunsIterator.EObjectRunsIterator

(

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/2]

eVision.EObjectRunsIterator.EObjectRunsIterator

(

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.

Member Function Documentation

First()

void eVision.EObjectRunsIterator.First

(

)

Rewinds to the first run of the coded element.

Next()

void eVision.EObjectRunsIterator.Next

(

)

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.

Property Documentation

EndX

int eVision.EObjectRunsIterator.EndX

get

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.

IsDone

bool eVision.EObjectRunsIterator.IsDone

get

Tests whether all the runs have been spanned.

Length

uint eVision.EObjectRunsIterator.Length

get

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.

StartX

int eVision.EObjectRunsIterator.StartX

get

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.

Y

int eVision.EObjectRunsIterator.Y

get

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.