Rogue Wave Views Maps Package API Reference Guide |
Rogue Wave Views Documentation Home |
This class reads the table of contents of a CADRG file. More...
#include <ilviews/maps/format/cadrg/cadrgtoc.h>
Public Member Functions | |
IlvCADRGTocReader (const char *fileName) | |
Initializes a new instance of IlvCADRGTocReader and reads the table of contents. More... | |
const IlvCADRGCoverage *const * | getCoverages (IlUShort &count) const |
Returns the coverages of the CADRG database. More... | |
IlvMapsError | getInitStatus () const |
Returns the init status of the reader. More... | |
const IlvCADRGFrame *const * | getLegendFrames (IlUShort &count) const |
Returns the frames that are located in the LEGEND directory. More... | |
const IlvCADRGFrame *const * | getOverviewFrames (IlUShort &count) const |
Returns the overview frames that are located in the CADRG main directory. More... | |
Static Public Member Functions | |
static IlvMapsError | FormatError () |
Returns the error code used if there is a format error. More... | |
This class reads the table of contents of a CADRG file.
Library: ilvmaps
The table of contents is usually located in a directory called CADRG/RPF
and is named A.TOC
.
The table of contents of the CADRG product contains information about the CADRG coverages stored in the data base.
IlvCADRGTocReader::IlvCADRGTocReader | ( | const char * | fileName | ) |
Initializes a new instance of IlvCADRGTocReader
and reads the table of contents.
fileName | The file name of the file containing the CADRG table of contents. |
|
static |
Returns the error code used if there is a format error.
getInitStatus()
if there is a format error. const IlvCADRGCoverage* const* IlvCADRGTocReader::getCoverages | ( | IlUShort & | count | ) | const |
Returns the coverages of the CADRG database.
count | Is set on return to the number of coverages declared in the table of contents file opened by the reader. |
IlvMapsError IlvCADRGTocReader::getInitStatus | ( | ) | const |
Returns the init status of the reader.
IlvMaps::NoError()
in the case of a correct initialization. Otherwise, it can return one of the errors of the IlvMapInput
class, or IlvCADRGTocReader::FormatError()
if the opened file is not a CADRG table of contents. const IlvCADRGFrame* const* IlvCADRGTocReader::getLegendFrames | ( | IlUShort & | count | ) | const |
Returns the frames that are located in the LEGEND
directory.
count | Is set on return to the number of legend frames declared in the table of contents file opened by the reader. |
const IlvCADRGFrame* const* IlvCADRGTocReader::getOverviewFrames | ( | IlUShort & | count | ) | const |
Returns the overview frames that are located in the CADRG
main directory.
count | Is set on return to the number of overview frames declared in the table of contents file opened by the reader. |
© Copyright 2016, 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.