IlvCADRGCoverage Class Reference

Stores information about a CADRG coverage as described in a CADRG table of contents. More...

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

Public Member Functions
IlInt	getColumns () const
	Returns the number of frame columns in the coverage. More...
const IlvCADRGFrame *	getFrame (IlShort row, IlShort column) const
	Returns the frame of the specified row and column. More...
IlDouble	getFrameHeight () const
	Returns the height of a frame of the coverage in the file projection system. More...
IlDouble	getFrameWidth () const
	Returns the width of a frame of the coverage in the file projection system. More...
IlDouble	getHorizontalInterval () const
	Returns the longitude interval between two adjacent pixels of the image. More...
IlInt	getIndex () const
	Returns the index of the coverage. More...
IlBoolean	getLowerRightCorner (IlvCoordinate &lr) const
	Returns the lower-right corner of the coverage region in the coverage projection. More...
IlvProjection *	getProjection () const
	Returns the projection used for the coverage. More...
IlInt	getRows () const
	Returns the number of frame rows in the coverage. More...
IlBoolean	getUpperLeftCorner (IlvCoordinate &ul) const
	Returns the upper-left corner of the coverage region in the coverage projection. More...
IlDouble	getVerticalInterval () const
	Returns the latitude interval between two adjacent pixels of the image. More...

Detailed Description

Stores information about a CADRG coverage as described in a CADRG table of contents.

Library: ilvmaps

A coverage corresponds physically to a directory in a CADRG distribution. It is composed of a set of frames that are part of the same map.
Most of the coverages are georeferenced, except for those used to store the overview of a CADRG product or the map legends.

Instances of the class IlvCADRGCoverage are obtained using an IlvCADRGTocReader.

Member Function Documentation

IlInt IlvCADRGCoverage::getColumns

(

)

const

Returns the number of frame columns in the coverage.

Returns

The number of frame columns in the coverage.

const IlvCADRGFrame* IlvCADRGCoverage::getFrame	(	IlShort	row,
		IlShort	column
	)		const

Returns the frame of the specified row and column.

Warning

The row and column parameters should not exceed the coverage size.

Parameters

row	The row of the frame.
column	The column of the frame.

See Also

getRows, getColumns.

Returns

A null pointer if the specified cell is empty. Otherwise, it returns an IlvCADRGFrame that should not be modified nor deleted. The returned object is deleted by the destructor of the IlvCADRGCoverage.

IlDouble IlvCADRGCoverage::getFrameHeight

(

)

const

Returns the height of a frame of the coverage in the file projection system.

Returns

The height of a frame of the coverage in the file projection system.

IlDouble IlvCADRGCoverage::getFrameWidth

(

)

const

Returns the width of a frame of the coverage in the file projection system.

Returns

The width of a frame of the coverage in the file projection system.

IlDouble IlvCADRGCoverage::getHorizontalInterval

(

)

const

Returns the longitude interval between two adjacent pixels of the image.

The interval is expressed in degrees.

Returns

The longitude interval between two adjacent pixels of the image.

IlInt IlvCADRGCoverage::getIndex

(

)

const

Returns the index of the coverage.

Returns

The index of the coverage.

IlBoolean IlvCADRGCoverage::getLowerRightCorner

(

IlvCoordinate &

lr

)

const

Returns the lower-right corner of the coverage region in the coverage projection.

Parameters

lr	The function puts the coordinates of the lower-right corner of the coverage region into this argument.

Returns

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

IlvProjection* IlvCADRGCoverage::getProjection

(

)

const

Returns the projection used for the coverage.

The projection is either a geographic projection for non polar areas, or an azimuthal equidistant projection for polar areas.

Returns

A null pointer if the coverage is not georeferenced, or shared IlvProjection that should not be deleted, but that can be locked (and then unlocked when it is not used anymore).

IlInt IlvCADRGCoverage::getRows

(

)

const

Returns the number of frame rows in the coverage.

Returns

The number of frame rows in the coverage.

IlBoolean IlvCADRGCoverage::getUpperLeftCorner

(

IlvCoordinate &

ul

)

const

Returns the upper-left corner of the coverage region in the coverage projection.

Parameters

ul	The function puts the coordinates of the upper-left corner of the coverage region into this argument.

Returns

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

IlDouble IlvCADRGCoverage::getVerticalInterval

(

)

const

Returns the latitude interval between two adjacent pixels of the image.

The interval is expressed in degrees.

Returns

The latitude interval between two adjacent pixels of the image.