 |
NAVTOR SDK
v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
|
|
Go to the documentation of this file. 1 #ifndef SDK_S57_CATALOG_INTERFACE_H_
11 #define SDK_S57_CATALOG_INTERFACE_H_
84 typedef sdk::SDKRefPtr<IS57CatalogEntry> S57CatalogEntrySP;
138 typedef sdk::SDKRefPtr<IS57CatalogEntriesIterator> S57CatalogEntriesIteratorSP;
149 S57CatalogEntrySP& catalog_entry)
throw() = 0;
159 typedef sdk::SDKRefPtr<IS57CatalogEntriesStorage> S57CatalogEntriesStorageSP;
168 S57CatalogEntriesIteratorSP& iterator)
const throw() = 0;
179 #endif // SDK_S57_CATALOG_INTERFACE_H_
static const wchar_t kS57DocxFileImpl[]
DOCX document file.
Definition: s57_catalog_interface.h:79
SDKString CatEntryFullFileName
Catalog entry full file name.
Definition: s57_catalog_interface.h:29
static const wchar_t kS57XmlFileImpl[]
XML document file.
Definition: s57_catalog_interface.h:75
virtual SDKResult SDK_CALLTYPE GetSouthLat(CatEntrySLat &slat) const =0
Returns the South latitude value.
SDKUInt32 CatEntryRCID
Catalog entry RCID.
Definition: s57_catalog_interface.h:25
static const wchar_t kS57DatasetFileImpl[]
Dataset file.
Definition: s57_catalog_interface.h:57
virtual SDKResult SDK_CALLTYPE GetWestLon(CatEntryWLon &wlon) const =0
Returns the West longitude value.
virtual SDKResult SDK_CALLTYPE GetLongFilePath(CatEntryLongFilePath &long_file_path) const =0
Returns the long path to the file with entry data.
static const wchar_t kS57PdfFileImpl[]
PDF document file.
Definition: s57_catalog_interface.h:63
virtual SDKResult SDK_CALLTYPE GetIterator(S57CatalogEntriesIteratorSP &iterator) const =0
Returns the catalog entries iterator.
S-57 catalog entries iterator.
Definition: s57_catalog_interface.h:142
virtual SDKResult SDK_CALLTYPE GetRCID(CatEntryRCID &rcid) const =0
Returns the catalog entry RCID.
Interfaces wrapper with reference count control.
virtual SDKResult SDK_CALLTYPE GetCRC(CatEntryCRC &crc) const =0
Returns the data CRC.
virtual SDKResult SDK_CALLTYPE GetVolume(CatEntryVolume &volume) const =0
Returns the volume name.
S-57 catalog entries storage.
Definition: s57_catalog_interface.h:163
double CatEntryNLat
Catalog entry north latitude.
Definition: s57_catalog_interface.h:43
virtual SDKResult SDK_CALLTYPE GetFullFileName(CatEntryFullFileName &full_file_name) const =0
Returns the full file name (file name + extension).
Single S-57 catalog entry.
Definition: s57_catalog_interface.h:88
static const wchar_t kS57TextFileImpl[]
ASCII text file.
Definition: s57_catalog_interface.h:59
virtual SDKResult SDK_CALLTYPE Reset()=0
Resets the iterator state.
static const wchar_t kS57CatalogFileImpl[]
Catalog file.
Definition: s57_catalog_interface.h:55
static const wchar_t kS57MpegFileImpl[]
MPEG video file.
Definition: s57_catalog_interface.h:71
SDKUInt32 SDKCRC32
CRC32 value.
Definition: base_types.h:403
SDKString CatEntryFilePath
Catalog entry file path.
Definition: s57_catalog_interface.h:31
Wrappers and helper functions for SDKString.
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
SDKString CatEntryVolume
Catalog entry volume.
Definition: s57_catalog_interface.h:35
SDKString CatEntryImpl
Catalog entry volume implementation. See predefined values.
Definition: s57_catalog_interface.h:37
virtual SDKResult SDK_CALLTYPE GetImplementation(CatEntryImpl &impl) const =0
Returns the implementation type.
virtual SDKResult SDK_CALLTYPE GetFileName(CatEntryFileName &file_name) const =0
Returns the file name (for datasets the file name equals to the Cell name).
Common base SDK interfaces.
SDKString CatEntryLongFilePath
Catalog entry long file path.
Definition: s57_catalog_interface.h:33
double CatEntryELon
Catalog entry east longitude.
Definition: s57_catalog_interface.h:45
static const wchar_t kS57PictureFileImpl[]
Picture file.
Definition: s57_catalog_interface.h:61
virtual SDKResult SDK_CALLTYPE Next(S57CatalogEntrySP &catalog_entry)=0
Returns the next catalog entry.
virtual SDKResult SDK_CALLTYPE GetFilePath(CatEntryFilePath &file_path) const =0
Returns the path to the file with entry data.
SDKString CatEntryComment
Catalog entry comment.
Definition: s57_catalog_interface.h:49
static const wchar_t kS57DocFileImpl[]
DOC document file.
Definition: s57_catalog_interface.h:73
virtual SDKResult SDK_CALLTYPE GetComment(CatEntryComment &comment) const =0
Returns the catalog entry comment.
static const wchar_t kS57AviFileImpl[]
AVI video file.
Definition: s57_catalog_interface.h:69
static const wchar_t kS57JpegFileImpl[]
JPEG photo file.
Definition: s57_catalog_interface.h:67
static const wchar_t kS57HtmlFileImpl[]
HTML document file.
Definition: s57_catalog_interface.h:65
double CatEntrySLat
Catalog entry south latitude.
Definition: s57_catalog_interface.h:39
double CatEntryWLon
Catalog entry west longitude.
Definition: s57_catalog_interface.h:41
SDKString CatEntryFileName
Catalog entry file name.
Definition: s57_catalog_interface.h:27
virtual SDKResult SDK_CALLTYPE GetNorthLat(CatEntryNLat &nlat) const =0
Returns the North latitude value.
SDKCRC32 CatEntryCRC
Catalog entry data CRC.
Definition: s57_catalog_interface.h:47
static const wchar_t kS57PngFileImpl[]
Picture file PNG.
Definition: s57_catalog_interface.h:77
virtual SDKResult SDK_CALLTYPE GetEastLon(CatEntryELon &elon) const =0
Returns the East longitude value.