NavBox Client

Data Structures
class	INavBoxFileInfoList
	NavBox file info list description. More...
class	INavBoxFileInfo
	Provides access to NavtorFileInfo. More...
class	INavBoxRESTClient
	NavBox REST client Provides access to INavBoxRESTClient. More...
class	INavBoxRESTInfo
	Provides access to INavBoxInfo. More...
class	INavBoxRESTRouteInfo
	Provides access to INavBoxRESTRouteInfo. More...
class	INavBoxRESTFileInfo
	Provides access to NavBoxRESTFileInfo. More...
class	INavBoxDataLayersClient
	NavBox REST client Data layers provider. More...
enum	NavBoxFileType {   kNavBoxFileType_NavtorRoute = 0, kNavBoxFileType_NavtorRouteBin, kNavBoxFileType_Weather, kNavBoxFileType_Routing,   kNavBoxFileType_Log, kNavBoxFileType_NavAreaWarning, kNavBoxFileType_NavtorPP, kNavBoxFileType_NavtorPPBin,   kNavBoxFileType_PortsInfo, kNavBoxFileType_NavStationInfo }
	NavBox file type. More...
enum	NavBoxRESTClientProperties {   kNavBoxRESTClientProperty_Host = kNavBoxClientProperty_Host, kNavBoxRESTClientProperty_Port = kNavBoxClientProperty_Port, kNavBoxRESTClientProperty_TimeoutSec = kNavBoxClientProperty_SendTimeoutSec, kNavBoxRESTClientProperty_RootCertificate = kNavBoxClientProperty_RootCertificate,   kNavBoxRESTClientProperty_SoftwareHost = kNavBoxClientProperty_RootCertificate + 1, kNavBoxRESTClientProperty_SoftwareName, kNavBoxRESTClientProperty_SoftwareVersion, kNavBoxRESTClientProperty_ServerToken,   kNavBoxRESTClientProperty_OEMToken }
	NavBox REST client properties. More...
enum	DataObjectsExtractionMode { DataObjectsExtractionMode_Meta = 0, DataObjectsExtractionMode_Full }
	NavBox data layer objects retrieving mode. More...
static const SDKUInt32	kDefaultRESTPort = 8010
	Default constants used in connection to NavBox. More...

Detailed Description

Enumeration Type Documentation

NavBoxFileType

enum NavBoxFileType

NavBox file type.

Enumerator
kNavBoxFileType_NavtorRoute	Route file type.
kNavBoxFileType_NavtorRouteBin	Route file at bin.
kNavBoxFileType_Weather	Weather file type.
kNavBoxFileType_Routing	Routing file type.
kNavBoxFileType_Log	Log file type.
kNavBoxFileType_NavAreaWarning	NavSrea warning file type.
kNavBoxFileType_NavtorPP	Passage plan file type.
kNavBoxFileType_NavtorPPBin	Passage plan file type at bin.
kNavBoxFileType_PortsInfo	Port information file.
kNavBoxFileType_NavStationInfo	NavStation information file type.

NavBoxRESTClientProperties

enum NavBoxRESTClientProperties

NavBox REST client properties.

Enumerator
kNavBoxRESTClientProperty_Host	NavBox Host address. Required.
kNavBoxRESTClientProperty_Port	NavBox Host port number. Required.
kNavBoxRESTClientProperty_TimeoutSec	Connection timeout. Optional.
kNavBoxRESTClientProperty_RootCertificate	Does not need to be specified by the application.
kNavBoxRESTClientProperty_SoftwareHost	Does not need to be specified by the application.
kNavBoxRESTClientProperty_SoftwareName	The application name. Required.
kNavBoxRESTClientProperty_SoftwareVersion	The application version. Required.
kNavBoxRESTClientProperty_ServerToken	NavBox token. Can be found on NavStick. Required.
kNavBoxRESTClientProperty_OEMToken	OEM token. Must be obtained from NAVTOR and provided when connecting to NavBox. Required.

DataObjectsExtractionMode

enum DataObjectsExtractionMode

NavBox data layer objects retrieving mode.

Enumerator
DataObjectsExtractionMode_Meta	Returns only object id and last update timestamp.
DataObjectsExtractionMode_Full	Returns full objects.

Variable Documentation

kDefaultRESTPort

const SDKUInt32 kDefaultRESTPort = 8010

static

Default constants used in connection to NavBox.

REST connection default port number.