Detailed Description

Classes
class	TSLS57DataClient

class	TSLS57MediaIngestManager

class	TSLS63CellInformation

class	TSLS63CellPermit

class	TSLS63CellPermitCollection

class	TSLS63DataClient

class	TSLS63DataLayer

class	TSLS63DataLayerScaleBands

class	TSLS63EncryptedData

class	TSLS63HWID

class	TSLS63MediaFile

class	TSLS63MediaIngestManager

class	TSLS63MediaRecord

class	TSLS63SerialENCFile

class	TSLS63SerialENCRecord

class	TSLS63UserPermitGenerator

enum	TSLS63CDTypeEnum { TSLS63CDTypeUnknown = -1 , TSLS63CDTypeBASE = 0 , TSLS63CDTypeUPDATE = 1 }

enum	TSLS63CellLoadResultEnum { TSLS63CellLoadResultOK , TSLS63CellLoadResultNotFound , TSLS63CellLoadResultDisregardThisCell , TSLS63CellLoadResultDisregardAllCells }

enum	TSLS63DataClientType { TSLS63DataClientTypeS63 , TSLS63DataClientTypeS57 }

enum	TSLS63ErrorCodeEnum { TSLS63ErrorCodeSSE5 = 5 , TSLS63ErrorCodeSSE6 = 6 , TSLS63ErrorCodeSSE7 = 7 , TSLS63ErrorCodeSSE8 = 8 , TSLS63ErrorCodeSSE9 = 9 , TSLS63ErrorCodeSSE10 = 10 , TSLS63ErrorCodeSSE11 = 11 , TSLS63ErrorCodeSSE12 = 12 , TSLS63ErrorCodeSSE13 = 13 , TSLS63ErrorCodeSSE15 = 15 , TSLS63ErrorCodeSSE16 = 16 , TSLS63ErrorCodeSSE18 = 18 , TSLS63ErrorCodeSSE19 = 19 , TSLS63ErrorCodeSSE20 = 20 , TSLS63ErrorCodeSSE21 = 21 , TSLS63ErrorCodeSSE22 = 22 , TSLS63ErrorCodeSSE23 = 23 , TSLS63ErrorCodeSSE24 = 24 , TSLS63ErrorCodeSSE25 = 25 , TSLS63ErrorCodeSSE26 = 26 , TSLS63ErrorCodeSSE27 = 27 , TSLS63ErrorCodeSSE1 = 1 , TSLS63ErrorCodeSSE2 = 2 , TSLS63ErrorCodeSSE3 = 3 , TSLS63ErrorCodeSSE4 = 4 , TSLS63ErrorCodeSSE14 = 14 , TSLS63ErrorCodeSSE17 = 17 }

enum	TSLS63ScaleBandEnum { TSLS63ScaleBandOverview = 1 , TSLS63ScaleBandGeneral = 2 , TSLS63ScaleBandCoastal = 3 , TSLS63ScaleBandApproach = 4 , TSLS63ScaleBandHarbour = 5 , TSLS63ScaleBandBerthing = 6 , TSLS63ScaleBandOverscale = 7 }

enum	TSLS63UserPermitGeneratorResult { TSLS63UserPermitGeneratorResultInvalidParams = -3 , TSLS63UserPermitGeneratorResultOutOfMemory = -2 , TSLS63UserPermitGeneratorResultError = -1 , TSLS63UserPermitGeneratorResultSuccess = 0 }

Enumeration Type Documentation

◆ TSLS63CDTypeEnum

enum TSLS63CDTypeEnum

This enumeration represents the possible types for an S63 dataset.

Enumerator
TSLS63CDTypeUnknown	The type of the dataset is not known. If this type is returned the TSLErrorStack should be checked to ensure there are no fatal errors logged.
TSLS63CDTypeBASE	The dataset is a new base set.
TSLS63CDTypeUPDATE	The dataset is an update to an existing base set.

◆ TSLS63CellLoadResultEnum

enum TSLS63CellLoadResultEnum

Enumeration describing the possible returns values for the user-implemented TSLS63DataClient::currentCellInformation() method.

Enumerator
TSLS63CellLoadResultOK	The cell was loaded correctly.
TSLS63CellLoadResultNotFound	The cell could not be found.
TSLS63CellLoadResultDisregardThisCell	This cell should be ignored during ingest or display.
TSLS63CellLoadResultDisregardAllCells	This cell and all future cells should be ignored during ingest or display.

◆ TSLS63DataClientType

enum TSLS63DataClientType

Enumerator
TSLS63DataClientTypeS63
TSLS63DataClientTypeS57

◆ TSLS63ErrorCodeEnum

enum TSLS63ErrorCodeEnum

This enumeration defines the S63 error codes that MapLink can raise as part of an ingest or display of S63 data. Each error has specific text associated with it that should be displayed by the OEM when an error is raised.

Enumerator
TSLS63ErrorCodeSSE5	SA Digital Certificate (X509) file is not available. A valid certificate can be obtained from the IHO website or your data supplier. This error is raised during an ingest when either of the two provided certificate files are invalid. No ingest can be performed until a valid certificate is provided.
TSLS63ErrorCodeSSE6	The SA Signed Data Server Certificate is invalid. The SA may have issued a new public key or the ENC may originate from another service. A new SA public key can be obtained from the IHO website or from your data supplier. This error is raised during an ingest when the public key from the data server certificate provided to the TSLS63MediaIngest Manager does not authenticate against an ENC cell signature from the exchange set. Cells for which this error occurs will not be ingested.
TSLS63ErrorCodeSSE7	SA signed DS Certificate file is not available. A valid certificate can be obtained from the IHO website or your data supplier. This error is raised during an ingest when an ENC cell signature file is missing or does not contain the SA signed data server certificate. Cells for which this error occurs will not being ingested.
TSLS63ErrorCodeSSE8	SA Digital Certificate (X509) file incorrect format. A valid certificate can be obtained from the IHO website or your data supplier. This error is raised during an ingest when either of the certificate files provided to the TSLS63MediaIngestManager are invalid. No ingest can be performed until valid certificates are provided.
TSLS63ErrorCodeSSE9	ENC Signature is invalid. This error is raised during an ingest when an ENC cell signature does not authenticate against the data server public key contained within the signature. Cells for which this error occurs will not be ingested.
TSLS63ErrorCodeSSE10	Permits not available for this Data Server. Contact your data supplier to obtain the correct permits. This error is raised during an ingest when no cell permits have been added to the TSLS63Media IngestManager from the data server that issued the exchange set being loaded. Cells in the exchange set that have no available cell permit will not be ingested.
TSLS63ErrorCodeSSE11	Cell Permit file not found. Load the permit file provided by the data supplier. This error is raised when cell permits are loaded via the TSLS63CellPermitCollection::create() method but the specified file could not be found.
TSLS63ErrorCodeSSE12	Cell Permit format is incorrect. Contact your data supplier and obtain a new permit file. This error is raised when cell permits are loaded via the TSLS63CellPermitCollection::create() method but the contents of the permit file is invalid.
TSLS63ErrorCodeSSE13	Cell Permit is invalid (checksum is incorrect). Contact your data supplier and obtain a new permit file. This error is raised when cell permits are added to either the TSLS63MediaIngestManager or TSLS63DataLayer but the CRC of the permit being added is incorrect. When adding a collection of permits this error will occur once for each permit within the collection that fails this check. Permits for which this error occurs will not be added to the TSLS63MediaIngestManager or TSLS63DataLayer.
TSLS63ErrorCodeSSE15	Subscription service has expired. Please contact your data supplier to renew the subscription licence. This error is raised as part of an ingest or display when the cell permit governing the cell being ingested or displayed has expired, and the cell permit was purchased as part of a subscription service. This error does not cause processing of the cell to abort. Additionally this error is also raised during ingest when a cell has been purchased as part of a subscription service but updates in the exchange set for the cell cannot be ingested due to being issued after the cell permit expired. In this case any updates that were issued before the cell permit expired will still be ingested.
TSLS63ErrorCodeSSE16	ENC CRC value is incorrect. Contact your data supplier as ENC(s) may be corrupted or missing data. This error is raised as part of an ingest when an ENC cell or attachment fails a CRC check. Cells for which this check fails are not ingested.
TSLS63ErrorCodeSSE18	HW_ID is incorrect format. This error is raised when the TSLS63WHID class passed to the TSLS63MediaIngestManager or TSLS63Data Layer does not contain a valid hardware ID. Attempting to ingest or display data will fail until a valid hardware ID is provided.
TSLS63ErrorCodeSSE19	Permits are not valid for this system. Contact your data supplier to obtain the correct permits. This error is raised during ingest or display when the hardware ID provided cannot decrypt the cell keys contained within the cell permit for the cell currently being ingested or displayed. Cells for which this error occurs will not be ingested or displayed.
TSLS63ErrorCodeSSE20	Subscription service will expire in less than 30 days. Please contact your data supplier to renew the subscription licence. This error is raised during ingest or display when the cell permit for the cell being loaded expires in less than 30 days. This error does not prevent the cell being loaded.
TSLS63ErrorCodeSSE21	Decryption failed no valid cell permit found. Permits may be for another system or new permits may be required, please contact your supplier to obtain a new licence. This error is raised during ingest when an ENC cell cannot be decrypted using the keys from the cell permit. Cells for which this error occurs will not be ingested.
TSLS63ErrorCodeSSE22	SA Digital Certificate (X509) has expired. A new SA public key can be obtained from the IHO website or from your data supplier. This error is raised during ingest when the certificate provided to TSLS63MediaIngestManager::loadExchangeSet() has expired. No ingest can be performed until a non-expired certificate is provided.
TSLS63ErrorCodeSSE23	Non sequential update, previous update(s) missing try reloading from the base media. If the problem persists contact your data supplier. Cell updates in S63 data must be applied sequentially (in numerical order). This error occurs during ingest when the expected cell update is missing from the exchange set. Any further updates to the cell will not be applied, but the ingest of the cell will continue.
TSLS63ErrorCodeSSE24	ENC Signature format incorrect, contact your data supplier. This error is raised during ingest when the ENC cell signature associated with the current cell is invalid and cannot be parsed. Cells for which this error occurs will not be ingested.
TSLS63ErrorCodeSSE25	The permit for ENC<cell name> has expired. This cell may be out of date and MUST NOT be used for Primary NAVIGATION. This error is raised during display when the cell permit governing the cell bieng displayed has expired. This error is always raised in this situation regardless of whether the cell was purchased as part of a subscription service, unlike TSLS63ErrorCodeSSE15. This error does not prevent display of the cell.
TSLS63ErrorCodeSSE26	This ENC is not authenticated by the IHO acting as the Scheme Administrator. This error is raised during ingest when the certificate passed to TSLS63MediaIngestManager::loadExchangeSet() does not match the scheme administrator's certificate. This error does not affect ingest of cells in the exchange set.
TSLS63ErrorCodeSSE27	ENC<cell name> is not up to date. A New Edition, Re-issue or Update for this cell is missing and therefore MUST NOT be used for Primary NAVIGATION. This error is raised during display when an update from an exchange set update has not been applied to the cell during the last ingest due to an expired cell permit or other problems. This error does not stop the display of the cell.
TSLS63ErrorCodeSSE1	These error codes are not raised by MapLink. They are included here for completeness.
TSLS63ErrorCodeSSE2
TSLS63ErrorCodeSSE3
TSLS63ErrorCodeSSE4
TSLS63ErrorCodeSSE14
TSLS63ErrorCodeSSE17

◆ TSLS63ScaleBandEnum

enum TSLS63ScaleBandEnum

Enumeration that defines the S57 scale bands

Enumerator
TSLS63ScaleBandOverview
TSLS63ScaleBandGeneral
TSLS63ScaleBandCoastal
TSLS63ScaleBandApproach
TSLS63ScaleBandHarbour
TSLS63ScaleBandBerthing
TSLS63ScaleBandOverscale

◆ TSLS63UserPermitGeneratorResult

enum TSLS63UserPermitGeneratorResult

Enumeration that describes the result of a User Permit generation via the TSLS63UserPermitGenerator.

Enumerator
TSLS63UserPermitGeneratorResultInvalidParams
TSLS63UserPermitGeneratorResultOutOfMemory
TSLS63UserPermitGeneratorResultError
TSLS63UserPermitGeneratorResultSuccess