Products File

Data Structures
class	IS63ProductsFileRecord
	Container to store a single PRODUCTS.TXT file record. More...
class	IS63ProductsFileRecordsEnum
	PRODUCTS.TXT file records iterator. More...
class	IS63ProductsFile
	PRODUCTS.TXT file container. More...
class	IS63ProductsReaderWriter
	S-63 PRODUCTS.TXT files reader/writer. More...

Enumerations
enum	ProductsFileRecordFields {   kProductsFileRecordField_IsOfficial = 0, kProductsFileRecordField_CellName, kProductsFileRecordField_RecordString, kProductsFileRecordField_ProductName,   kProductsFileRecordField_BaseCellIssueDate, kProductsFileRecordField_BaseCellEdition, kProductsFileRecordField_IssueDateLatestUpdate, kProductsFileRecordField_LatestUpdateNumber,   kProductsFileRecordField_FileSize, kProductsFileRecordField_CellLimitSouthernmostLatitude, kProductsFileRecordField_CellLimitWesternmostLongitude, kProductsFileRecordField_CellLimitNothernmostLatitude,   kProductsFileRecordField_CellLimitEasternmostLongitude, kProductsFileRecordField_Compression, kProductsFileRecordField_Encryption, kProductsFileRecordField_BaseCellUpdateNumber,   kProductsFileRecordField_LastUpdateNumberForPreviousEdition, kProductsFileRecordField_BaseCellLocation, kProductsFileRecordField_CancelledCellReplacement }
	List of available fields for a single PRODUCTS.TXT file record. See 6.2.3 of IHO S-63 Data Protection Scheme for detailed description. More...
enum	ProductsFileVersion { kProductsFileVersion_Unknown = 0, kProductsFileVersion_Version1 = 1, kProductsFileVersion_Version2 = 2 }
	Known versions of the PRODUCTS.TXT file. More...
enum	ProductsFileContentType { kProductsFileContentType_Unknown = 0, kProductsFileContentType_Partial = 1, kProductsFileContentType_Full = 2 }
	Known content types of the PRODUCTS.TXT file. More...
enum	S63ProductsFileProps { kS63ProductsFileProp_RecordsCount = 0, kS63ProductsFileProp_DateTime = 1, kS63ProductsFileProp_FileVersion = 2, kS63ProductsFileProp_ContentType = 3 }
	Set of available properties for the S-63 Products File container. More...
enum	ProductsReaderWriterProps { kProductsReaderWriterProp_DontUseRecordStringFieldValueWhileSaving = 0 }
static const wchar_t	kS63ProductsFileName [] = L"PRODUCTS.TXT"
	Reserved name for the Products file.
static const wchar_t	kPathToProductsFromENCDatabaseRoot []
	Path to the PRODUCTS.TXT file from the ENC database root (from ENC_ROOT folder).
static const wchar_t	kPathToProductsFromENCDatabaseRoot2 []
	Path to the PRODUCTS.TXT file from the ENC database root (from ENC_ROOT folder). Large media.
static const wchar_t	kPathToProductsFromMediaENCDatabaseRoot []
	Path to the PRODUCTS.TXT file from the ENC Media root (from M01X01 folder).
static const wchar_t	kPathToENCProductsFromNavStickRoot []
	Path to the ENC database PRODUCTS.TXT file from the NavStick root.
static const wchar_t	kPathToAIOProductsFromNavStickRoot []
	Path to the AIO database PRODUCTS.TXT file from the NavStick root.

Detailed Description

Enumeration Type Documentation

ProductsFileRecordFields

enum ProductsFileRecordFields

List of available fields for a single PRODUCTS.TXT file record. See 6.2.3 of IHO S-63 Data Protection Scheme for detailed description.

Enumerator
kProductsFileRecordField_IsOfficial	kSDKAnyType_Bool (true if record locates in :ENC section, false otherwise)
kProductsFileRecordField_CellName	kSDKAnyType_SDKStringPtr
kProductsFileRecordField_RecordString	kSDKAnyType_SDKStringPtr (source string from PRODUCTS.TXT file)
kProductsFileRecordField_ProductName	kSDKAnyType_SDKStringPtr
kProductsFileRecordField_BaseCellIssueDate	kSDKAnyType_SDKTime
kProductsFileRecordField_BaseCellEdition	kSDKAnyType_Uint32
kProductsFileRecordField_IssueDateLatestUpdate	kSDKAnyType_SDKTime
kProductsFileRecordField_LatestUpdateNumber	kSDKAnyType_Uint32
kProductsFileRecordField_FileSize	kSDKAnyType_Uint32
kProductsFileRecordField_CellLimitSouthernmostLatitude	kSDKAnyType_Double
kProductsFileRecordField_CellLimitWesternmostLongitude	kSDKAnyType_Double
kProductsFileRecordField_CellLimitNothernmostLatitude	kSDKAnyType_Double
kProductsFileRecordField_CellLimitEasternmostLongitude	kSDKAnyType_Double
kProductsFileRecordField_Compression	kSDKAnyType_Uint32
kProductsFileRecordField_Encryption	kSDKAnyType_Uint32
kProductsFileRecordField_BaseCellUpdateNumber	kSDKAnyType_Uint32
kProductsFileRecordField_LastUpdateNumberForPreviousEdition	kSDKAnyType_Uint32
kProductsFileRecordField_BaseCellLocation	kSDKAnyType_SDKStringPtr
kProductsFileRecordField_CancelledCellReplacement	kSDKAnyType_SDKStringPtr

ProductsFileVersion

enum ProductsFileVersion

Known versions of the PRODUCTS.TXT file.

Enumerator
kProductsFileVersion_Unknown	Unknown version of the products file format.
kProductsFileVersion_Version1	S-63 products file format version 1.
kProductsFileVersion_Version2	S-63 products file format version 2.

ProductsFileContentType

enum ProductsFileContentType

Known content types of the PRODUCTS.TXT file.

Enumerator
kProductsFileContentType_Unknown	Unknown content type of the products file.
kProductsFileContentType_Partial	The products file contains PARTIAL content.
kProductsFileContentType_Full	The products file contains FULL content.

S63ProductsFileProps

enum S63ProductsFileProps

Set of available properties for the S-63 Products File container.

Enumerator
kS63ProductsFileProp_RecordsCount	Total number of records (kSDKAnyType_Uint32).
kS63ProductsFileProp_DateTime	Date/Time of the source PRODUCTS.TXT file (kSDKAnyType_SDKTime).
kS63ProductsFileProp_FileVersion	Version of the source PRODUCTS.TXT file (kSDKAnyType_Uint32, one of ProductsFileVersion).
kS63ProductsFileProp_ContentType	Content type of the Source PRODUCTS.TXT file (kSDKAnyType_Uint32, one of ProductsFileContentType).

ProductsReaderWriterProps

enum ProductsReaderWriterProps

Enumerator
kProductsReaderWriterProp_DontUseRecordStringFieldValueWhileSaving	Don't use the kProductsFileRecordField_RecordString field value, while saving a single PRODUCTS.TXT record, instead form the required record string using real field values.