Ilwis::FeatureIterator Class Reference

#include <featureiterator.h>

Inheritance diagram for Ilwis::FeatureIterator:

Public Member Functions
	FeatureIterator ()
	FeatureIterator (const Ilwis::IFeatureCoverage &fcoverage)
	FeatureIterator (const Ilwis::IFeatureCoverage &fcoverage, IlwisTypes types)
	FeatureIterator (const Ilwis::IFeatureCoverage &fcoverage, const std::vector< quint32 > &subset)
	FeatureIterator (const FeatureIterator &iter)
FeatureIterator &	operator++ ()
FeatureIterator	operator++ (int)
FeatureIterator &	operator+ (int)
FeatureIterator &	operator- (int)
bool	operator== (const FeatureIterator &rhs)
bool	operator!= (const FeatureIterator &rhs)
UPFeatureI &	operator* ()
FeatureIterator	end () const
FeatureIterator	end ()

Detailed Description

FeatureIterator The primary access method to the features and indexes is through the featureiterator. The
featureiterator abstracts the movement through the feature-elements by representing the whole
set of feature-elements as one linear set of feature-elements. Within this space a traditional(c++)
random access iterator has been defined with all the methods and operators traditionally associated
with such a concept. Particularly:

• Operators ‘++’and ‘—‘ , moving one step in the data-array.
• Operator ‘*’accessing data
• Operator ‘[]’ random access
  Because this mechanism hides the actual organization of feature-elements and indexes, it allows in a
  large number of cases for the very efficient formulating of algorithms.
  
  There are three modes of movement :
  
  
• Iterate through all feature-elements at the same index level and when done move to the next index level. Or,
• Iterate through all feature-elements of a feature and then move to the next feature.
  The first method is default.

See Also

FeatureCoverage

Constructor & Destructor Documentation

FeatureIterator::FeatureIterator

(

)

Constructor for an empty FeatureIterator

FeatureIterator::FeatureIterator

(

const Ilwis::IFeatureCoverage &

fcoverage

)

Creates a FeatureIterator on a FeatureCoverage, the created iterator will
iterate over all the features in the supplied coverage.
initialisation will fail if the supplied feature coverage is invalid.

Parameters

fcoverage

The FeatureCoverage that should be iterated over

FeatureIterator::FeatureIterator	(	const Ilwis::IFeatureCoverage &	fcoverage,
		const std::vector< quint32 > &	subset
	)

Creates a FeatureIterator on a FeatureCoverage, the created iterator will
iterate over all the features in the supplied subset of this coverage.
initialisation will fail if the supplied feature coverage is invalid or if the subset is invalid(cannot be applied to the coverage).

Parameters

fcoverage	The FeatureCoverage that should be iterated over
subset	The subset that should be iterated

FeatureIterator::FeatureIterator

(

const FeatureIterator &

iter

)

Copy constructor.
Constructs a copy of the given FeatureIterator.
if the supplied FeatureIterator is invalid, the result of this will also be invalid.

Parameters

iter	The FeatureIterator that should be copied

Member Function Documentation

FeatureIterator FeatureIterator::end

(

)

const

Returns a copy of this FeatureIterator which has as current feature the last feature in the coverage

Returns

a FeatureIterator copy at the end of its coverage

FeatureIterator FeatureIterator::end

(

)

Returns a copy of this FeatureIterator which has as current feature the last feature in the coverage

Returns

a FeatureIterator copy at the end of its coverage

bool FeatureIterator::operator!=

(

const FeatureIterator &

rhs

)

Override of the != operator.
Compares the current feature of the 2 FeatureIterators, if they are the same false will be returned.
In all other cases true will be returned.

Parameters

rhs	the FeatureIterator this one should be compared to

Returns

false when they both are at the same feature

UPFeatureI & FeatureIterator::operator*

(

)

Creates and returns a reference to the features this FeatureIterator iterates over

Returns

the features of this iterator

FeatureIterator & FeatureIterator::operator+

(

int

distance

)

Override of the operator +
Moves this FeatureIterator n features.
Returns a reference to this FeatureIterator.

Returns

a reference to this FeatureIterator.

FeatureIterator & FeatureIterator::operator++

(

)

Override of the operator ++
Moves this FeatureIterator to the next feature.
Returns a reference to this FeatureIterator.

Returns

a reference to this FeatureIterator.

FeatureIterator FeatureIterator::operator++

(

int

)

Override of the operator ++
Copies this FeatureIterator and moves the copy to the next feature.
Returns the copy.

Returns

a copy of this moved by 1

FeatureIterator & FeatureIterator::operator-

(

int

distance

)

Override of the operator -
Moves this FeatureIterator -n features.
Returns a reference to this FeatureIterator.

Returns

a reference to this FeatureIterator.

bool FeatureIterator::operator==

(

const FeatureIterator &

rhs

)

Override of the == operator.
Compares the current feature of the 2 FeatureIterators, if they are the same true will be returned.
In all other cases false will be returned.

Parameters

rhs	the FeatureIterator this one should be compared to

Returns

true when they both are at the same feature

---

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

• ilwisobjects/coverage/featureiterator.h
• ilwisobjects/coverage/featureiterator.cpp