Views
Maps Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Static Public Member Functions
IlvMapFeatureIterator Class Referenceabstract

This class is the base class for feature iterators. More...

#include <ilviews/maps/mapfeature.h>

Inheritance diagram for IlvMapFeatureIterator:
IlvCADRGFrameReader IlvDTEDReader IlvGeoTIFFReader IlvImageReader IlvLookAheadFeatureIterator IlvObjectSDOFeatureIterator IlvS57Loader IlvSDOFeatureIterator

Public Member Functions

virtual IlvClassInfogetClassInfo () const =0
 Returns the class information for this feature iterator. More...
 
virtual IlvFeatureRenderergetDefaultFeatureRenderer (IlvDisplay *display)=0
 Returns the default renderer for this feature iterator. More...
 
virtual IlvMapsError getInitStatus () const =0
 Checks the initialization status of this feature iterator. More...
 
virtual IlBoolean getLowerRightCorner (IlvCoordinate &result) const =0
 Computes the lower right corner of the rectangle containing all the map features of this iterator. More...
 
virtual const IlvMapFeaturegetNextFeature (IlvMapsError &status)=0
 Returns the next map feature of the iterator. More...
 
virtual const IlvProjectiongetProjection () const =0
 Returns the projection in which the geometric coordinates of the map features are expressed. More...
 
virtual IlBoolean getUpperLeftCorner (IlvCoordinate &result) const =0
 Computes the upper left corner of the rectangle containing all the map features of this iterator. More...
 
virtual void setSourceProjection (IlvProjection *projection)
 Sets the projection of geometries generated by this feature iterator. More...
 

Static Public Member Functions

static IlvClassInfoClassInfo ()
 Returns the class information of the class. More...
 
static IlvClassInfo ** ClassInfoRef ()
 Returns the address of the class information of the class. More...
 

Detailed Description

This class is the base class for feature iterators.

Library: ilvmaps

A feature iterator is a convenient interface to access various map feature sources transparently. Feature iterators can be implemented by:

See also
IlvMapFeature

Member Function Documentation

◆ ClassInfo()

static IlvClassInfo* IlvMapFeatureIterator::ClassInfo ( )
static

Returns the class information of the class.

Returns
The IlvClassInfo of the class.

◆ ClassInfoRef()

static IlvClassInfo** IlvMapFeatureIterator::ClassInfoRef ( )
static

Returns the address of the class information of the class.

This function is used when subclassing IlvMapFeatureIterator.

Returns
The address is the IlvClassInfo of the class.

◆ getClassInfo()

virtual IlvClassInfo* IlvMapFeatureIterator::getClassInfo ( ) const
pure virtual

Returns the class information for this feature iterator.

Returns
The class information for this feature iterator.

◆ getDefaultFeatureRenderer()

virtual IlvFeatureRenderer* IlvMapFeatureIterator::getDefaultFeatureRenderer ( IlvDisplay display)
pure virtual

Returns the default renderer for this feature iterator.

Returns a renderer that can be used to translate the map features returned by this iterator into graphic objects. Feature iterators that store some rendering information in the attributes of the map features, such as color, text font, line thickness and so on, can return a specific renderer which is able to take these attributes into account during the rendering process.

Parameters
displayThe display that is used by the returned renderer.
Returns
The default renderer for this feature iterator.

Implemented in IlvShapeSHPReader, IlvShapeFileReader, IlvImageReader, IlvDTEDReader, IlvCADRGFrameReader, IlvS57Loader, IlvSDOFeatureIterator, IlvObjectSDOFeatureIterator, and IlvGeoTIFFReader.

◆ getInitStatus()

virtual IlvMapsError IlvMapFeatureIterator::getInitStatus ( ) const
pure virtual

Checks the initialization status of this feature iterator.

Returns
The error code that may have happened during the iterator initialization.

Implemented in IlvShapeSHPReader, IlvShapeFileReader, IlvS57Loader, IlvSDOFeatureIterator, IlvObjectSDOFeatureIterator, IlvImageReader, IlvGeoTIFFReader, IlvDTEDReader, and IlvCADRGFrameReader.

◆ getLowerRightCorner()

virtual IlBoolean IlvMapFeatureIterator::getLowerRightCorner ( IlvCoordinate result) const
pure virtual

Computes the lower right corner of the rectangle containing all the map features of this iterator.

Parameters
resultSet on return to the lower right corner of the rectangle containing all the map features of this iterator.
Returns
IlFalse if lower right is unknown.

Implemented in IlvShapeSHPReader, IlvShapeFileReader, IlvCADRGFrameReader, IlvSDOFeatureIterator, IlvObjectSDOFeatureIterator, IlvS57Loader, IlvImageReader, IlvGeoTIFFReader, and IlvDTEDReader.

◆ getNextFeature()

virtual const IlvMapFeature* IlvMapFeatureIterator::getNextFeature ( IlvMapsError &  status)
pure virtual

Returns the next map feature of the iterator.

Parameters
statusSet on return to the status of the operation. This status is IlvMaps::NoError() if no error occurs.
Returns
The next map feature available, or 0 if the iteration is finished. The returned feature is owned by the feature iterator.

Implemented in IlvShapeSHPReader, IlvShapeFileReader, IlvSDOFeatureIterator, IlvObjectSDOFeatureIterator, IlvCADRGFrameReader, IlvS57Loader, IlvImageReader, IlvGeoTIFFReader, and IlvDTEDReader.

◆ getProjection()

virtual const IlvProjection* IlvMapFeatureIterator::getProjection ( ) const
pure virtual

Returns the projection in which the geometric coordinates of the map features are expressed.

Returns
The projection of the geometry, or 0 if the feature iterator returns ungeoreferenced map features.

Implemented in IlvShapeSHPReader, IlvShapeFileReader, IlvS57Loader, IlvSDOFeatureIterator, IlvObjectSDOFeatureIterator, IlvImageReader, IlvGeoTIFFReader, IlvDTEDReader, and IlvCADRGFrameReader.

◆ getUpperLeftCorner()

virtual IlBoolean IlvMapFeatureIterator::getUpperLeftCorner ( IlvCoordinate result) const
pure virtual

Computes the upper left corner of the rectangle containing all the map features of this iterator.

Parameters
resultSet on return to the upper left corner of the rectangle containing all the map features of this iterator.
Returns
IlFalse if upper left is unknown.

Implemented in IlvCADRGFrameReader, IlvShapeSHPReader, IlvShapeFileReader, IlvSDOFeatureIterator, IlvObjectSDOFeatureIterator, IlvS57Loader, IlvImageReader, IlvGeoTIFFReader, and IlvDTEDReader.

◆ setSourceProjection()

virtual void IlvMapFeatureIterator::setSourceProjection ( IlvProjection projection)
virtual

Sets the projection of geometries generated by this feature iterator.

This method is to be used when feature source is not georeferenced. The default implementation of this method does nothing.

Parameters
projectionThe projection to be set. This projection becomes shared and is locked by this feature iterator.

Reimplemented in IlvShapeSHPReader, IlvShapeFileReader, IlvSDOFeatureIterator, IlvObjectSDOFeatureIterator, IlvImageReader, and IlvGeoTIFFReader.