rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvImageReader Class Reference

This class is an IlvMapFeatureIterator specialized for reading image files. The supported image formats are those supported by Rogue Wave Views. More...

#include <ilviews/maps/format/image/imgreader.h>

Inheritance diagram for IlvImageReader:
IlvMapFeatureIterator

Public Member Functions

 IlvImageReader (IlvDisplay *display, const char *filename, IlvCoordinate &ul, IlvCoordinate &lr)
 Creates an instance of the image reader from a file name. More...
 
 IlvImageReader (IlvDisplay *display, istream &input, IlvCoordinate &ul, IlvCoordinate &lr)
 Creates an instance of the image reader from an istream. More...
 
 IlvImageReader (IlvDisplay *display, IlIUrlStream &input, IlvCoordinate &ul, IlvCoordinate &lr)
 Creates an instance of the image reader from an IlIUrlStream. More...
 
IlvFeatureRenderergetDefaultFeatureRenderer (IlvDisplay *display)
 Returns an instance of IlvDefaultFeatureRenderer. More...
 
virtual IlvMapImagegetGeometry ()
 Returns the IlvMapImage geometry. More...
 
virtual IlvMapsError getInitStatus () const
 Checks the initialization status of this feature iterator. More...
 
virtual IlBoolean getLowerRightCorner (IlvCoordinate &coordinate) const
 Returns the lower right corner of the rectangle containing all the map features of this iterator. More...
 
virtual const IlvMapFeaturegetNextFeature (IlvMapsError &status)
 Returns the next map feature of the iterator, or 0 if the iteration is finished. The returned feature is owned by the feature iterator. More...
 
const IlvProjectiongetProjection () const
 Returns the projection in which the geometric coordinates of the map features are expressed or 0 if the feature iterator returns ungeoreferenced map features. More...
 
virtual IlBoolean getUpperLeftCorner (IlvCoordinate &coordinate) const
 Returns the upper left corner of the rectangle containing all the map features of this iterator. More...
 
void setSourceProjection (IlvProjection *projection)
 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. More...
 
- Public Member Functions inherited from IlvMapFeatureIterator
virtual IlvClassInfogetClassInfo () const =0
 Returns the class information for this feature iterator. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvMapFeatureIterator
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 an IlvMapFeatureIterator specialized for reading image files. The supported image formats are those supported by Rogue Wave Views.

Library: ilvmaps

Constructor & Destructor Documentation

IlvImageReader::IlvImageReader ( IlvDisplay display,
const char *  filename,
IlvCoordinate ul,
IlvCoordinate lr 
)

Creates an instance of the image reader from a file name.

Constructs an IlvImageReader by specifying the name of the image file to read and the coordinates of the image.

Parameters
displayThe display.
filenameThe name of the image file.
ulThe upper left coordinate of the image.
lrThe lower right coordinate of the image.
IlvImageReader::IlvImageReader ( IlvDisplay display,
istream &  input,
IlvCoordinate ul,
IlvCoordinate lr 
)

Creates an instance of the image reader from an istream.

Constructs an IlvImageReader by specifying a stream opened on the image file to read and the coordinates of the image.

Parameters
displayThe display.
inputA stream opened on an image file.
ulThe upper left coordinate of the image.
lrThe lower right coordinate of the image.
IlvImageReader::IlvImageReader ( IlvDisplay display,
IlIUrlStream input,
IlvCoordinate ul,
IlvCoordinate lr 
)

Creates an instance of the image reader from an IlIUrlStream.

Parameters
inputA stream opened on an image URL.

Member Function Documentation

IlvFeatureRenderer* IlvImageReader::getDefaultFeatureRenderer ( IlvDisplay display)
virtual

Returns an instance of IlvDefaultFeatureRenderer.

Returns
An instance of IlvDefaultImageRenderer.

Implements IlvMapFeatureIterator.

virtual IlvMapImage* IlvImageReader::getGeometry ( )
virtual

Returns the IlvMapImage geometry.

Returns
The IlvMapImage geometry. The geometry is owned by the reader.
virtual IlvMapsError IlvImageReader::getInitStatus ( ) const
virtual

Checks the initialization status of this feature iterator.

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

Implements IlvMapFeatureIterator.

virtual IlBoolean IlvImageReader::getLowerRightCorner ( IlvCoordinate result) const
virtual

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

Returns
IlFalse if lower right is unknown.

Implements IlvMapFeatureIterator.

virtual const IlvMapFeature* IlvImageReader::getNextFeature ( IlvMapsError &  status)
virtual

Returns the next map feature of the iterator, or 0 if the iteration is finished. The returned feature is owned by the feature iterator.

Parameters
statusStores the status of the operation. This status is IlvMaps::NoError() if no error occurs.
Returns
The next map feature available.

Implements IlvMapFeatureIterator.

const IlvProjection* IlvImageReader::getProjection ( ) const
virtual

Returns the projection in which the geometric coordinates of the map features are expressed or 0 if the feature iterator returns ungeoreferenced map features.

Returns
The projection of the geometry.

Implements IlvMapFeatureIterator.

virtual IlBoolean IlvImageReader::getUpperLeftCorner ( IlvCoordinate result) const
virtual

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

Returns
IlFalse if upper left is unknown.

Implements IlvMapFeatureIterator.

void IlvImageReader::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 from IlvMapFeatureIterator.


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.