 |
Views Maps Package API Reference Guide |
Views Documentation Home |
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 IlvCADRGCoverage * | getCoverage () 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 | getLowerLeftCorner (IlvCoordinate &ll) const |
| Queries the lower-left corner of the frame region. More... | |
| IlBoolean | getLowerRightCorner (IlvCoordinate &lr) const |
| Queries the lower-right corner of the frame region. 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... | |
| IlBoolean | getRectCoordinates (IlvCoordinate &c1, IlvCoordinate &c2) const |
| Queries the corners of the frame region. Coordinates change based on the projection of the coverage. More... | |
| IlShort | getRow () const |
| Returns the row of the frame in its CADRG coverage. More... | |
| IlBoolean | getUpperLeftCorner (IlvCoordinate &ul) const |
| Queries the upper-left corner of the frame region. More... | |
| IlBoolean | getUpperRightCorner (IlvCoordinate &ur) const |
| Queries the upper-right corner of the frame region. More... | |
| IlvCADRGFrameReader * | makeReader () const |
| Initializes a frame reader for the CADRG frame. More... | |
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.
makeReader(). | IlShort IlvCADRGFrame::getColumn | ( | ) | const |
Returns the column of the frame in its CADRG coverage.
| const IlvCADRGCoverage* IlvCADRGFrame::getCoverage | ( | ) | const |
Returns the IlvCADRGCoverage that owns the frame.
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.
getPathName(), IlvCADRGTocReader. | IlBoolean IlvCADRGFrame::getLowerLeftCorner | ( | IlvCoordinate & | ll | ) | const |
Queries the lower-left corner of the frame region.
The frame projection is either an IlvGeographicProjection or, for polar regions, an IlvAzimuthalEquidistantProjection.
| ll | Set on return to the coordinates of the lower-left corner of the frame. |
IlTrue if the frame is georeferenced. Otherwise, it returns IlFalse, and the value of ll should not be used. This occurs in the case of legend frames or of overview frames. | IlBoolean IlvCADRGFrame::getLowerRightCorner | ( | IlvCoordinate & | lr | ) | const |
Queries the lower-right corner of the frame region.
The frame projection is either an IlvGeographicProjection or, for polar regions, an IlvAzimuthalEquidistantProjection.
| lr | Set on return to the coordinates of the lower-right corner of the frame. |
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.
"A.TOC". getPathName(), IlvCADRGTocReader. | IlBoolean IlvCADRGFrame::getRectCoordinates | ( | IlvCoordinate & | c1, |
| IlvCoordinate & | c2 | ||
| ) | const |
Queries the corners of the frame region. Coordinates change based on the projection of the coverage.
| c1 | Set on return to the coordinates of the upper-left corner of the frame region into this argument when geographic projection is used. With Azimuthal projection, c1 is set to lower-left corner of the frame. |
| c2 | Set on return to the coordinates of the lower-right corner of the frame region into this argument when geographic projection is used. With Azimuthal projection, c2 is set to upper-left corner of the frame. |
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. | IlShort IlvCADRGFrame::getRow | ( | ) | const |
Returns the row of the frame in its CADRG coverage.
| IlBoolean IlvCADRGFrame::getUpperLeftCorner | ( | IlvCoordinate & | ul | ) | const |
Queries the upper-left corner of the frame region.
The frame projection is either an IlvGeographicProjection or, for polar regions, an IlvAzimuthalEquidistantProjection.
| ul | Set on return to the coordinates of the upper-left corner of the frame. |
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. | IlBoolean IlvCADRGFrame::getUpperRightCorner | ( | IlvCoordinate & | ur | ) | const |
Queries the upper-right corner of the frame region.
The frame projection is either an IlvGeographicProjection or, for polar regions, an IlvAzimuthalEquidistantProjection.
| ur | Set on return to the coordinates of the upper-right corner of the frame. |
IlTrue if the frame is georeferenced. Otherwise, it returns IlFalse, and the value of ur 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.
0 if the reader initialization failed, or an IlvCADRGFrameReader instance that must be deleted. |
Copyright 2021 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |
|