NavBox client interfaces. More...

#include <base/inc/sdk_component_interface.h>
#include <base/inc/geometry/geometry_base_types.h>
#include <base/inc/interfaces/enum/enum_interface.h>
#include <base/inc/interfaces/collection/collection_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <base/inc/interfaces/resource/generic_resource_interface.h>
#include <base/inc/interfaces/stream/stream_interface.h>
#include <geometry/inc/geometry/geometry.h>
#include <datalayer/inc/navbox_client/navbox_client_const.h>

Data Structures
class	IECDISServiceServerCallback
	ECDIS server service callback interface. More...

class	INavBoxFileInfoList
	NavBox file info list description. More...

class	INavBoxFileInfo
	Provides access to NavtorFileInfo. More...

class	INavBoxRESTCallbacks
	NavBox REST callbacks interface. 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...

Enumerations
enum	SimulationWaypointProperty { , kSimulationWaypointProperty_SOG, kSimulationWaypointProperty_SOGSimulated, kSimulationWaypointProperty_RPM, kSimulationWaypointProperty_RPMSimulated, kSimulationWaypointProperty_Time, kSimulationWaypointProperty_TimeSimulated, kSimulationWaypointProperty_IsGC, kSimulationWaypointProperty_IsSimulated, kSimulationWaypointProperty_FOC, kSimulationWaypointProperty_WaveDirection, kSimulationWaypointProperty_WaveHeight, kSimulationWaypointProperty_WavePeriod, kSimulationWaypointProperty_SwellDirection, kSimulationWaypointProperty_SwellHeight, kSimulationWaypointProperty_SwellPeriod, kSimulationWaypointProperty_WindSeaWaveDirection, kSimulationWaypointProperty_WindSeaWaveHeight, kSimulationWaypointProperty_WindSeaWavePeriod, kSimulationWaypointProperty_CurrentSpeed, kSimulationWaypointProperty_CurrentDirection, kSimulationWaypointProperty_WindSpeed, kSimulationWaypointProperty_WindDirection }

enum	WNILegPointProperty { kWNILegPointProperty_IsGC = 0, kWNILegPointProperty_Lat, kWNILegPointProperty_Lon, kWNILegPointProperty_WaypointType }

enum	NVIProperty { , kNVIProperty_VesselName = kNVIProperty_BEG, kNVIProperty_VoyageNumber, kNVIProperty_CallSign, kNVIProperty_ETA, kNVIProperty_ETD, kNVIProperty_GMInMeters, kNVIProperty_ArrivalTimeMarginReason, kNVIProperty_CalmSeaSpeedInKnots, kNVIProperty_CanSailInWinterZone, kNVIProperty_DeparturePilotStationName, kNVIProperty_DeparturePilotStationLat, kNVIProperty_DeparturePilotStationLon, kNVIProperty_DeparturePilotStationWaypointType, kNVIProperty_DeparturePortName, kNVIProperty_DestinationPilotStationName, kNVIProperty_DestinationPilotStationLat, kNVIProperty_DestinationPilotStationLon, kNVIProperty_DestinationPilotStationWaypointType, kNVIProperty_DestinationPortName, kNVIProperty_ExpectedDepatureDraftAftInMeters, kNVIProperty_ExpectedDepatureDraftForeInMeters, kNVIProperty_IMONumber, kNVIProperty_MastersIntendedRPMSetting, kNVIProperty_NatureOfCargoUndefined, kNVIProperty_Remark, kNVIProperty_ReportTime, kNVIProperty_RequestArrivalTimeMarginInMinutes, kNVIProperty_ScrubberEquipped, kNVIProperty_ShipMasterName, kNVIProperty_NatureOfCargoPrimary, kNVIProperty_NatureOfCargoSecondary, kNVIProperty_FuelToUseInECA, kNVIProperty_FuelToUseInOpenOcean, kNVIProperty_LoadingCondition, kNVIProperty_PrimaryOnDeckCargo, kNVIProperty_SecondaryOnDeckCargo, kNVIProperty_MCRRangeFrom, kNVIProperty_MCRRangeTo, kNVIProperty_RPMRangeFrom, kNVIProperty_RPMRangeTo, kNVIProperty_UltraSlowRPMRangeFrom, kNVIProperty_UltraSlowRPMRangeTo, kNVIProperty_UnusableMCRRange1From, kNVIProperty_UnusableMCRRange1To, kNVIProperty_UnusableMCRRange2From, kNVIProperty_UnusableMCRRange2To, kNVIProperty_UnusableRPMRange1From, kNVIProperty_UnusableRPMRange1To, kNVIProperty_UnusableRPMRange2From, kNVIProperty_UnusableRPMRange2To }

enum	VesselEventPropertyID { , kVesselEventPropertyID_ActivatePP = 1, kVesselEventPropertyID_ATA = 22, kVesselEventPropertyID_ATD = 25, kVesselEventPropertyID_LoadingCondition = 26, kVesselEventPropertyID_Speed = 50, kVesselEventPropertyID_CompletePP = 100, kVesselEventPropertyID_AbandonPP = 101, kVesselEventPropertyID_CancelPP = 102 }


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...

Detailed Description

NavBox client interfaces.

Author: NAVTOR SDK authors.

Date: 01/2017

Maintenance:: NAVTOR SDK authors.

Enumeration Type Documentation

◆ SimulationWaypointProperty

enum SimulationWaypointProperty

Enumerator
kSimulationWaypointProperty_SOG	Speed over ground.
kSimulationWaypointProperty_SOGSimulated	Speed over ground simulated.
kSimulationWaypointProperty_RPM	Engine rpm.
kSimulationWaypointProperty_RPMSimulated	Engine rpm simulated.
kSimulationWaypointProperty_Time	ETA/Departure time for first point.
kSimulationWaypointProperty_TimeSimulated	ETA/Departure time for first point simulated.
kSimulationWaypointProperty_IsGC	Is Great circle.
kSimulationWaypointProperty_IsSimulated	Is simulated waypoint.
kSimulationWaypointProperty_FOC	Weather at point. Fuel oil consumption per 24 hours
kSimulationWaypointProperty_WaveDirection	Wave direction.
kSimulationWaypointProperty_WaveHeight	Wave height.
kSimulationWaypointProperty_WavePeriod	Wave period.
kSimulationWaypointProperty_SwellDirection	Swell direction.
kSimulationWaypointProperty_SwellHeight	Swell height.
kSimulationWaypointProperty_SwellPeriod	Swell period.
kSimulationWaypointProperty_WindSeaWaveDirection	Wind sea wave direction.
kSimulationWaypointProperty_WindSeaWaveHeight	Wind sea wave height.
kSimulationWaypointProperty_WindSeaWavePeriod	Wind sea wave period.
kSimulationWaypointProperty_CurrentSpeed	Surface current speed.
kSimulationWaypointProperty_CurrentDirection	Surface current direction.
kSimulationWaypointProperty_WindSpeed	Wind speed.
kSimulationWaypointProperty_WindDirection	Wind direction.

◆ WNILegPointProperty

enum WNILegPointProperty

Enumerator
kWNILegPointProperty_IsGC	Navigation type, bool.
kWNILegPointProperty_Lat	Latitude, double.
kWNILegPointProperty_Lon	Longitude, double.
kWNILegPointProperty_WaypointType	Waypoint type, enum WNIWaypointType.

◆ NVIProperty

enum NVIProperty

Enumerator
kNVIProperty_VesselName	Vessel name, string.
kNVIProperty_VoyageNumber	Voyage number, string.
kNVIProperty_CallSign	Call sign, string.
kNVIProperty_ETA	ETA, SDKTime.
kNVIProperty_ETD	ETD, SDKTime.
kNVIProperty_GMInMeters	GM (meters), double.
kNVIProperty_ArrivalTimeMarginReason	Arrival time margin reason, string.
kNVIProperty_CalmSeaSpeedInKnots	Calm sea speed (knots), double.
kNVIProperty_CanSailInWinterZone	Can sail in winter zone, bool.
kNVIProperty_DeparturePilotStationName	Departure pilot station name, string.
kNVIProperty_DeparturePilotStationLat	Departure pilot station latitude, double.
kNVIProperty_DeparturePilotStationLon	Departure pilot station longitude, double.
kNVIProperty_DeparturePilotStationWaypointType	Departure pilot station waypoint type, SDKInt32 (WNIWaypointType)
kNVIProperty_DeparturePortName	Departure port name, string.
kNVIProperty_DestinationPilotStationName	Destination pilot station name, string.
kNVIProperty_DestinationPilotStationLat	Destination pilot station latitude, double.
kNVIProperty_DestinationPilotStationLon	Destination pilot station longitude, double.
kNVIProperty_DestinationPilotStationWaypointType	Destination pilot station waypoint type, SDKInt32 (WNIWaypointType)
kNVIProperty_DestinationPortName	Destination port name, string.
kNVIProperty_ExpectedDepatureDraftAftInMeters	Expected depature draft aft (meters), double.
kNVIProperty_ExpectedDepatureDraftForeInMeters	Expected depature draft fore (meters), double.
kNVIProperty_IMONumber	IMO number, SDKInt32.
kNVIProperty_MastersIntendedRPMSetting	Masters intended RPM setting, SDKInt32.
kNVIProperty_NatureOfCargoUndefined	Nature of cargo undefined, string.
kNVIProperty_Remark	Remark, string.
kNVIProperty_ReportTime	Report time, SDKTime.
kNVIProperty_RequestArrivalTimeMarginInMinutes	Request arrival time margin (min), SDKInt32.
kNVIProperty_ScrubberEquipped	Scrubber equipped, bool.
kNVIProperty_ShipMasterName	Ship master name, string.
kNVIProperty_NatureOfCargoPrimary	Nature of cargo primary, SDKInt32 (BulkerCargo in WniDataContract)
kNVIProperty_NatureOfCargoSecondary	Nature of cargo secondary, SDKInt32 (BulkerCargo in WniDataContract)
kNVIProperty_FuelToUseInECA	Fuel to use in ECA, SDKInt32 (WNIFuelType)
kNVIProperty_FuelToUseInOpenOcean	Fuel to use in open ocean, SDKInt32 (WNIFuelType)
kNVIProperty_LoadingCondition	Loading condition, SDKInt32 (WNILoadingCondition)
kNVIProperty_PrimaryOnDeckCargo	Primary on deck cargo, SDKInt32 (WNIOnDeckCargoType)
kNVIProperty_SecondaryOnDeckCargo	Secondary on deck cargo, SDKInt32 (WNIOnDeckCargoType)
kNVIProperty_MCRRangeFrom	MCR range from, SDKInt32.
kNVIProperty_MCRRangeTo	MCR range to, SDKInt32.
kNVIProperty_RPMRangeFrom	RPM range from, SDKInt32.
kNVIProperty_RPMRangeTo	RPM range to, SDKInt32.
kNVIProperty_UltraSlowRPMRangeFrom	Ultra slow RPM range from, SDKInt32.
kNVIProperty_UltraSlowRPMRangeTo	Ultra slow RPM range to, SDKInt32.
kNVIProperty_UnusableMCRRange1From	Unusable MCR range 1 from, SDKInt32.
kNVIProperty_UnusableMCRRange1To	Unusable MCR range 1 to, SDKInt32.
kNVIProperty_UnusableMCRRange2From	Unusable MCR range 2 from, SDKInt32.
kNVIProperty_UnusableMCRRange2To	Unusable MCR range 2 to, SDKInt32.
kNVIProperty_UnusableRPMRange1From	Unusable RPM range 1 from, SDKInt32.
kNVIProperty_UnusableRPMRange1To	Unusable RPM range 1 to, SDKInt32.
kNVIProperty_UnusableRPMRange2From	Unusable RPM range 2 from, SDKInt32.
kNVIProperty_UnusableRPMRange2To	Unusable RPM range 2 to, SDKInt32.

◆ VesselEventPropertyID

enum VesselEventPropertyID

Enumerator
kVesselEventPropertyID_ActivatePP	Set passage-plan as active.
kVesselEventPropertyID_ATA	Set actual time of arrival.
kVesselEventPropertyID_ATD	Set actual time of departure.
kVesselEventPropertyID_LoadingCondition	Set loading-condition.
kVesselEventPropertyID_Speed	Set speed-command.
kVesselEventPropertyID_CompletePP	Mark current passage as completed.
kVesselEventPropertyID_AbandonPP	Abandon current passage.
kVesselEventPropertyID_CancelPP	Cancel current passage.