IlvCADRGFrameReader Class Reference

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

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

Inheritance diagram for IlvCADRGFrameReader:

List of all members.

Public Member Functions
	IlvCADRGFrameReader (IL_STDPREF istream &input)
	Creates an instance of a CADRG frame reader from an input stream opened on a CADRG Frame.
	IlvCADRGFrameReader (const char *fileName)
	Creates an instance of a CADRG frame reader for the specified frame file.
virtual IlvFeatureRenderer *	getDefaultFeatureRenderer (IlvDisplay *display)
	Returns the default renderer for this reader.
virtual IlvMapsError	getInitStatus () const
	Returns the error code that may have happened during the frame reader initialization.
virtual IlBoolean	getLowerRightCorner (IlvCoordinate &lr) const
	Returns the lower-right corner of the frame region in the frame projection.
virtual const IlvMapFeature *	getNextFeature (IlvMapsError &status)
	Returns the next feature read.
virtual const IlvProjection *	getProjection () const
	Returns the projection of the CADRG frame.
virtual IlBoolean	getUpperLeftCorner (IlvCoordinate &ul) const
	Returns the upper-left corner of the frame region in the frame projection.
IlBoolean	isGeoreferenced () const
	Specifies whether the frame is georeferenced.
Static Public Member Functions
static IlvMapsError	FormatError ()
	Returns the error code if there is a format error.
static IlvMapsError	InitError ()
	Returns the error code if there is an initialization error.

---

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 the IlvCADRGFrame::makeReader function.

---

Constructor & Destructor Documentation

IlvCADRGFrameReader::IlvCADRGFrameReader

(

const char *

fileName

)

Creates an instance of a CADRG frame reader for the specified frame file.

Parameters:

fileName

The name of the CADRG frame file.

See also:

getInitStatus.

IlvCADRGFrameReader::IlvCADRGFrameReader

(

IL_STDPREF istream &

input

)

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

Parameters:

istream

The input stream opened on a CADRG frame file.

See also:

getInitStatus.

---

Member Function Documentation

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.

virtual IlvFeatureRenderer* IlvCADRGFrameReader::getDefaultFeatureRenderer

(

IlvDisplay *

display

)

[virtual]

Returns the default renderer for this reader.

Returns:

An IlvFeatureRenderer that must be deleted after use.

Implements IlvMapFeatureIterator.

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.

virtual IlBoolean IlvCADRGFrameReader::getLowerRightCorner

(

IlvCoordinate &

lr

)

const [virtual]

Returns 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

The function puts the coordinates of the lower-right corner of the frame into this argument.

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.

virtual const IlvMapFeature* IlvCADRGFrameReader::getNextFeature

(

IlvMapsError &

status

)

[virtual]

Returns the next feature read.

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

Parameters:

status

The function sets an error code to this parameter. 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.

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:

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

Implements IlvMapFeatureIterator.

virtual IlBoolean IlvCADRGFrameReader::getUpperLeftCorner

(

IlvCoordinate &

ul

)

const [virtual]

Returns 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

The function puts the coordinates of the upper-left corner of the frame into this argument.

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.

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.

IlBoolean IlvCADRGFrameReader::isGeoreferenced

(

)

const

Specifies whether the frame is georeferenced.

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

Returns:

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