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	getLowerLeftCorner (IlvCoordinate &ll) const
	Queries the lower-left corner of the coverage region in the coverage projection. More...

IlBoolean	getLowerRightCorner (IlvCoordinate &lr) const
	Queries the lower-right corner of the coverage region in the coverage projection. More...

IlvProjection *	getProjection () const
	Returns the projection used for the coverage. More...

IlBoolean	getRectCoordinates (IlvCoordinate &c1, IlvCoordinate &c2) const
	Queries the corners of the coverage region in the coverage projection. Coordinates change based on the projection of the coverage. More...

IlInt	getRows () const
	Returns the number of frame rows in the coverage. More...

IlBoolean	getUpperLeftCorner (IlvCoordinate &ul) const
	Queries the upper-left corner of the coverage region in the coverage projection. More...

IlBoolean	getUpperRightCorner (IlvCoordinate &ur) const
	Queries the upper-right 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

◆ getColumns()

IlInt IlvCADRGCoverage::getColumns ( ) const

Returns the number of frame columns in the coverage.

Returns: The number of frame columns in the coverage.

◆ getFrame()

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.

Returns: 0 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.

See also: getRows(), getColumns().

◆ getFrameHeight()

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.

◆ getFrameWidth()

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.

◆ getHorizontalInterval()

IlDouble IlvCADRGCoverage::getHorizontalInterval ( ) const

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

Returns: The longitude interval, in degrees, between two adjacent pixels of the image.

◆ getIndex()

IlInt IlvCADRGCoverage::getIndex ( ) const

Returns the index of the coverage.

Returns: The index of the coverage.

◆ getLowerLeftCorner()

IlBoolean IlvCADRGCoverage::getLowerLeftCorner ( IlvCoordinate & ll ) const

Queries the lower-left corner of the coverage region in the coverage projection.

Parameters

ll	Set on return to the coordinates of the lower-left corner of the coverage region into this argument.

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

◆ getLowerRightCorner()

IlBoolean IlvCADRGCoverage::getLowerRightCorner ( IlvCoordinate & lr ) const

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

Parameters

lr	Set on return to 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 lr should not be used. This occurs in the case of legend coverages or of overview coverages.

◆ getProjection()

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: 0 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).

◆ getRectCoordinates()

IlBoolean IlvCADRGCoverage::getRectCoordinates	(	IlvCoordinate &	c1,
		IlvCoordinate &	c2
	)		const

Queries the corners of the coverage region in the coverage projection. Coordinates change based on the projection of the coverage.

Parameters

c1	Set on return to the coordinates of the upper-left corner of the coverage region into this argument when geographic projection is used. With Azimuthal projection, c1 is set to lower-left corner of the coverage.
c2	Set on return to the coordinates of the lower-right corner of the coverage region into this argument when geographic projection is used. With Azimuthal projection, c2 is set to upper-left corner of the coverage.

Returns: IlTrue if the coverage is geo-referenced. Otherwise, it returns IlFalse, and the value of c1 and c2 should not be used. This occurs in the case of legend coverages or of overview coverages.

◆ getRows()

IlInt IlvCADRGCoverage::getRows ( ) const

Returns the number of frame rows in the coverage.

Returns: The number of frame rows in the coverage.

◆ getUpperLeftCorner()

IlBoolean IlvCADRGCoverage::getUpperLeftCorner ( IlvCoordinate & ul ) const

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

Parameters

ul	Set on return to 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.

◆ getUpperRightCorner()

IlBoolean IlvCADRGCoverage::getUpperRightCorner ( IlvCoordinate & ur ) const

Queries the upper-right corner of the coverage region in the coverage projection.

Parameters

ur	Set on return to the coordinates of the upper-right corner of the coverage region into this argument.

Returns: IlTrue if the coverage is geo-referenced. Otherwise, it returns IlFalse, and the value of ur should not be used. This occurs in the case of legend coverages or of overview coverages.

◆ getVerticalInterval()

IlDouble IlvCADRGCoverage::getVerticalInterval ( ) const

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

Returns: The latitude interval, in degrees, between two adjacent pixels of the image.

Public Member Functions

Detailed Description

Member Function Documentation

◆ getColumns()

◆ getFrame()

◆ getFrameHeight()

◆ getFrameWidth()

◆ getHorizontalInterval()

◆ getIndex()

◆ getLowerLeftCorner()

◆ getLowerRightCorner()

◆ getProjection()

◆ getRectCoordinates()

◆ getRows()

◆ getUpperLeftCorner()

◆ getUpperRightCorner()

◆ getVerticalInterval()