rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvCADRGFrame Class Reference

This class defines a CADRG frame as described in the CADRG table of contents. More...

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

Public Member Functions

IlShort getColumn () const
 Returns the column of the frame in its CADRG coverage. More...
 
const IlvCADRGCoveragegetCoverage () const
 Returns the IlvCADRGCoverage that owns the frame. More...
 
const char * getFileName () const
 Returns the file name of the frame as read from the CADRG table of contents. More...
 
IlBoolean getLowerRightCorner (IlvCoordinate &lr) const
 Returns the lower-right corner of the frame region in the frame projection. More...
 
const char * getPathName () const
 Returns the path name of the frame as read from the CADRG table of contents. The path name is relative to the directory that contains the CADRG table of contents. More...
 
IlShort getRow () const
 Returns the row of the frame in its CADRG coverage. More...
 
IlBoolean getUpperLeftCorner (IlvCoordinate &ul) const
 Returns the upper-left corner of the frame region. More...
 
IlvCADRGFrameReadermakeReader () const
 Initializes a frame reader for the CADRG frame. More...
 

Detailed Description

This class defines a CADRG frame as described in the CADRG table of contents.

Library: ilvmaps

A frame corresponds physically to a file in a CADRG product. It can be loaded with an IlvCADRGFrameReader.

Most of the frames are georeferenced, except for those used to display the overview of a CADRG product or the map legends. Instances of IlvCADRGFrame are obtained with an IlvCADRGCoverage.

See Also
makeReader.

Member Function Documentation

IlShort IlvCADRGFrame::getColumn ( ) const

Returns the column of the frame in its CADRG coverage.

Returns
The column of the frame.
const IlvCADRGCoverage* IlvCADRGFrame::getCoverage ( ) const

Returns the IlvCADRGCoverage that owns the frame.

Returns
An IlvCADRGCoverage that should not be modified nor deleted.
const char* IlvCADRGFrame::getFileName ( ) const

Returns the file name of the frame as read from the CADRG table of contents.

Returns
The capitalized file name of the corresponding frame file.
See Also
getPathName, IlvCADRGTocReader.
IlBoolean IlvCADRGFrame::getLowerRightCorner ( IlvCoordinate lr) const

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
lrThe 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.
const char* IlvCADRGFrame::getPathName ( ) const

Returns the path name of the frame as read from the CADRG table of contents. The path name is relative to the directory that contains the CADRG table of contents.

Returns
The capitalized path name relative to the directory containing the CADRG table of content file, which is named "A.TOC".
See Also
getFileName, IlvCADRGTocReader.
IlShort IlvCADRGFrame::getRow ( ) const

Returns the row of the frame in its CADRG coverage.

Returns
The row of the frame.
IlBoolean IlvCADRGFrame::getUpperLeftCorner ( IlvCoordinate ul) const

Returns the upper-left corner of the frame region.

in the frame projection (which is either an IlvGeographicProjection or, for polar regions, an IlvAzimuthalEquidistantProjection).

Parameters
ulThe 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.
IlvCADRGFrameReader* IlvCADRGFrame::makeReader ( ) const

Initializes a frame reader for the CADRG frame.

Returns
A null pointer if the reader initialization failed, or an IlvCADRGFrameReader instance that must be deleted.

© 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.