rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

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

List of all members.

Public Member Functions

 IlvImageReader (IlvDisplay *display, IlIUrlStream &input, IlvCoordinate &ul, IlvCoordinate &lr)
 Creates an instance of the image reader from an IlIUrlStream.
 IlvImageReader (IlvDisplay *display, istream &input, IlvCoordinate &ul, IlvCoordinate &lr)
 Creates an instance of the image reader from an istream.
 IlvImageReader (IlvDisplay *display, const char *filename, IlvCoordinate &ul, IlvCoordinate &lr)
 Creates an instance of the image reader from a file name.
IlvFeatureRenderergetDefaultFeatureRenderer (IlvDisplay *display)
 Returns an instance of IlvDefaultFeatureRenderer.
virtual IlvMapImagegetGeometry ()
 Returns the IlvMapImage geometry.
virtual IlvMapsError getInitStatus () const
 Checks the initialization status of this feature iterator.
virtual IlBoolean getLowerRightCorner (IlvCoordinate &coordinate) const
 Returns the lower right corner of the rectangle containing all the map features of this iterator.
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.
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.
virtual IlBoolean getUpperLeftCorner (IlvCoordinate &coordinate) const
 Returns the upper left corner of the rectangle containing all the map features of this iterator.
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.

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:
display The display.
filename The name of the image file.
ul The upper left coordinate of the image.
lr The 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:
display The display.
input A stream opened on an image file.
ul The upper left coordinate of the image.
lr The 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:
input A 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:
status Stores 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:
projection The 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.