IlvCADRGFrameReader Class Reference

This class is used to read CADGR frames. More...

#include <ilviews/maps/format/cadrg/cadrgread.h>

Inheritance diagram for IlvCADRGFrameReader:

Public Member Functions
	IlvCADRGFrameReader (const char *fileName)
	Initializes a new instance of a CADRG frame reader for the specified frame file. More...
	IlvCADRGFrameReader (IL_STDPREF istream &input)
	Initializes a new instance of a CADRG frame reader from an input stream opened on a CADRG Frame. More...
virtual IlvFeatureRenderer *	getDefaultFeatureRenderer (IlvDisplay *display)
	Returns the default renderer for this reader. More...
virtual IlvMapsError	getInitStatus () const
	Returns the error code that may have happened during the frame reader initialization. More...
virtual IlBoolean	getLowerRightCorner (IlvCoordinate &lr) const
	Queries the lower-right corner of the frame region in the frame projection. More...
virtual const IlvMapFeature *	getNextFeature (IlvMapsError &status)
	Returns the next feature read. More...
virtual const IlvProjection *	getProjection () const
	Returns the projection of the CADRG frame. More...
virtual IlBoolean	getUpperLeftCorner (IlvCoordinate &ul) const
	Queries the upper-left corner of the frame region in the frame projection. More...
IlBoolean	isGeoreferenced () const
	Specifies whether the frame is georeferenced. More...
Public Member Functions inherited from IlvMapFeatureIterator
virtual IlvClassInfo *	getClassInfo () const =0
	Returns the class information for this feature iterator. More...
virtual void	setSourceProjection (IlvProjection *projection)
	Sets the projection of geometries generated by this feature iterator. More...

Static Public Member Functions
static IlvMapsError	FormatError ()
	Returns the error code if there is a format error. More...
static IlvMapsError	InitError ()
	Returns the error code if there is an initialization error. More...
Static Public Member Functions inherited from IlvMapFeatureIterator
static IlvClassInfo *	ClassInfo ()
	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 used to read CADGR frames.

Library: ilvmaps

A frame is a file that constitutes the basic entity of the CADRG format. Frame files can be found in the coverage directories that are below the root directory of a CADRG product.

The geometries returned by the IlvCADRGFrameReader are instances of the class IlvMapImage. Usually, a CADRG Frame contains 36 subframes. Each subframe is translated into an IlvMapFeature.

Instances of an IlvCADRGFrameReader can be created either using the class constructor that takes a file name or an input stream as argument, or using IlvCADRGFrame::makeReader().

Constructor & Destructor Documentation

IlvCADRGFrameReader() [1/2]

IlvCADRGFrameReader::IlvCADRGFrameReader

(

const char *

fileName

)

Initializes a new instance of a CADRG frame reader for the specified frame file.

Parameters

fileName

The name of the CADRG frame file.

See also

getInitStatus().

IlvCADRGFrameReader() [2/2]

IlvCADRGFrameReader::IlvCADRGFrameReader

(

IL_STDPREF istream &

input

)

Initializes a new instance of a CADRG frame reader from an input stream opened on a CADRG Frame.

Parameters

input

The input stream opened on a CADRG frame file.

See also

getInitStatus().

Member Function Documentation

FormatError()

static IlvMapsError IlvCADRGFrameReader::FormatError ( )

static

Returns the error code if there is a format error.

Returns

The error code in the case of a format error.

getDefaultFeatureRenderer()

virtual IlvFeatureRenderer* IlvCADRGFrameReader::getDefaultFeatureRenderer ( IlvDisplay *  display )

virtual

Returns the default renderer for this reader.

Parameters

display

The display instance that is used by the renderer.

Returns

An IlvFeatureRenderer that must be deleted after use.

Implements IlvMapFeatureIterator.

getInitStatus()

virtual IlvMapsError IlvCADRGFrameReader::getInitStatus ( ) const

virtual

Returns the error code that may have happened during the frame reader initialization.

Returns

IlvMaps::NoError() if no error occurred during the initialization. Otherwise, it can return an error of the IlvMapInput class, or IlvCADRGFrameReader::FormatError if the opened file is not a CADRG frame file.

Implements IlvMapFeatureIterator.

getLowerRightCorner()

virtual IlBoolean IlvCADRGFrameReader::getLowerRightCorner ( IlvCoordinate &  lr ) const

virtual

Queries the lower-right corner of the frame region in the frame projection.

The frame projection is either an IlvGeographicProjection or, for polar regions, an IlvAzimuthalEquidistantProjection.

Parameters

lr	Is set to the coordinates of the lower-right corner of the frame on return.

Returns

IlTrue if the frame is georeferenced. Otherwise, it returns IlFalse, and the value of lr should not be used. This occurs in the case of legend frames or of overview frames.

Implements IlvMapFeatureIterator.

getNextFeature()

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

virtual

Returns the next feature read.

A CADRG frame is usually composed of 36 subframes. This method returns 0 when all the features are read.

Parameters

status

Set to an error code on return. It can either be IlvMaps::NoError() if the feature could be read properly, or an error status such as InitError if the reader had an initialization error and if this function is called, or FormatError, or an error of the IlvMapInput class.

Returns

An IlvMapFeature that must not be modified nor deleted.

Implements IlvMapFeatureIterator.

getProjection()

virtual const IlvProjection* IlvCADRGFrameReader::getProjection ( ) const

virtual

Returns the projection of the CADRG frame.

The projection can be either a geographic projection (for non-polar areas), or an azimuthal equidistant projection (for polar areas).

Returns

0 if the frame is not georeferenced, or an IlvProjection object that should not be modified nor deleted.

Implements IlvMapFeatureIterator.

getUpperLeftCorner()

virtual IlBoolean IlvCADRGFrameReader::getUpperLeftCorner ( IlvCoordinate &  ul ) const

virtual

Queries the upper-left corner of the frame region in the frame projection.

The frame projection is either an IlvGeographicProjection or, for polar regions, an IlvAzimuthalEquidistantProjection.

Parameters

ul	Is set to the coordinates of the upper-left corner of the frame on return.

Returns

IlTrue if the frame is georeferenced. Otherwise, it returns IlFalse, and the value of ul should not be used. This occurs in the case of legend frames or of overview frames.

Implements IlvMapFeatureIterator.

InitError()

static IlvMapsError IlvCADRGFrameReader::InitError ( )

static

Returns the error code if there is an initialization error.

Returns

The error code if there is an initialization error.

isGeoreferenced()

IlBoolean IlvCADRGFrameReader::isGeoreferenced

(

)

const

Specifies whether the frame is georeferenced.

Returns

IlFalse if the frame is an overview or a frame containing legends.