NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
Cell Permits

Data Structures

class  IS63CellPermit
 Interface describing a single S-63 cell permit instance. More...
 
class  IS63CellPermitsIterator
 S-63 cell permits iterator. More...
 
class  IS63CellPermitsStorage
 S-63 cell permits storage. More...
 
class  IS63CellPermitsReaderWriter
 Interface for reading/writing S63 cell permit files. More...
 
class  IS63CellPermitsReaderWriterUtils
 Utilities interface of S-63 cell permits file reader/writer. More...
 

Enumerations

enum  S63CellPermitsFileFormat { kS63CellPermitsFileFormat_Unknown = 0, kS63CellPermitsFileFormat_Version1 = 1, kS63CellPermitsFileFormat_Version2 = 2 }
 Available S-63 cell permit file formats. More...
 
enum  S63CellPermitsStorageProp {
  kS63CellPermitsStorageProp_CellPermitsCount = 0, kS63CellPermitsStorageProp_PermitsDateTime = 1, kS63CellPermitsStorageProp_PermitsFileVersion = 2, kS63CellPermitsStorageProp_OfficialPermitsStringsIterator = 3,
  kS63CellPermitsStorageProp_NonOfficialPermitsStringsIterator = 4
}
 Set of available properties for the S-63 cell permits storage. More...
 

Functions

static void InitDataServerID (DataServerID &dataserverid)
 Initialize data server id.
 

Variables

static const CellServiceLevelIndicator kUndefinedServiceLevelIndicator = -1
 Undefined service level indicator value.
 
static const DataServerID kUndefinedDataserverID = {'?', '?'}
 Undefined DataserverID value.
 
static const wchar_t kPermitTXTFileName [] = L"PERMIT.TXT"
 Reserved name for a file with permits in S-63.
 
static const wchar_t kCellPermitsReaderWriterProp_DefaultDataserverID []
 Available Cell permits reader writer properties.
 
typedef SDKUInt8 CellKey[5]
 Cell key to decrypt the cell.
 
typedef SDKUInt8 CellName[8]
 Cell name.
 
typedef SDKTime CellPermitExpirationDate
 Cell permit expiration date.
 
typedef SDKInt8 CellServiceLevelIndicator
 Cell service level indicator.
 
typedef SDKUInt32 CellEditionNumber
 Cell service level indicator.
 
typedef SDKUInt8 DataServerID[2]
 Dataserver ID.
 
typedef SDKString CellPermitComment
 Cell permit comment.
 

Detailed Description

Enumeration Type Documentation

◆ S63CellPermitsFileFormat

Available S-63 cell permit file formats.

Enumerator
kS63CellPermitsFileFormat_Unknown 

Unknown version of the permit file format.

kS63CellPermitsFileFormat_Version1 

S-63 permit file format version 1.

kS63CellPermitsFileFormat_Version2 

S-63 permit file format version 2.

◆ S63CellPermitsStorageProp

Set of available properties for the S-63 cell permits storage.

Enumerator
kS63CellPermitsStorageProp_CellPermitsCount 

Total number of cell permits.

kS63CellPermitsStorageProp_PermitsDateTime 

Date/Time of the source PERMIT.TXT file.

kS63CellPermitsStorageProp_PermitsFileVersion 

Source PERMIT.TXT file version.

kS63CellPermitsStorageProp_OfficialPermitsStringsIterator 

Iterator enumerating permit string entries from the original PERMIT.TXT file from the official section. (returned component should implement the IEnumSDKString interface).

kS63CellPermitsStorageProp_NonOfficialPermitsStringsIterator 

Iterator enumerating the permit string entries from the original PERMIT.TXT file from the non-official section. (returned component should implement the IEnumSDKString interface).