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

Own ship components. More...

Modules

 Class IDs
 Own ship Class IDs.
 

Data Structures

class  IOwnShipDeviceConfig
 Manages the own ship configuration properties. More...
 
class  IOwnShipDataset
 Provides access to members that provide information about a OwnShip dataset. More...
 
class  IOwnShipObject
 Single own ship object. More...
 
class  IPastPositions
 Past positions enumerator. More...
 
class  IDistanceLines
 Distance lines enumerator. More...
 

Enumerations

enum  OwnShipFeatureAttributeCode {
  kOSFAC_dims_a = kFAC_dims_a, kOSFAC_dims_b = kFAC_dims_b, kOSFAC_dims_c = kFAC_dims_c, kOSFAC_dims_d = kFAC_dims_d,
  kOSFAC_maxhgt = kFAC_maxhgt, kOSFAC_drfmax = kFAC_drfmax, kOSFAC_drfcur = kFAC_drfcur, kOSFAC_turstb = kFAC_turstb,
  kOSFAC_turprt = kFAC_turprt, kOSFAC_devstb = kFAC_devstb, kOSFAC_devprt = kFAC_devprt, kOSFAC_ecospd = kFAC_ecospd,
  kOSFAC_usecog = kFAC_usecog, kOSFAC_LPP = kFAC_LPP
}
 Own Ship target feature class coded kSDKAnyType_Empty value means, that given attribute value is absent. More...
 
enum  OwnShipObjectEnum { kOwnShipObject_Primary = 0, kOwnShipObject_Secondary = kOwnShipObject_Primary + 1, kOwnShipObject_Secondary2 = kOwnShipObject_Primary + 2, kOwnShipObject_Secondary3 = kOwnShipObject_Primary + 3 }
 Own ship objects definition. More...
 
enum  PortrayalParameterOwnShipEnum {
  kPP_OwnShip_TrueScaledOutlinePermitted = sdk::vis::kPortrayalParameters_OwnShip, kPP_OwnShip_VelocityVectorOverGroundOn, kPP_OwnShip_VelocityVectorThroughWaterOn, kPP_OwnShip_VelocityVector_LengthSec,
  kPP_OwnShip_VelocityVector_TimeIncrementsStepSec, kPP_OwnShip_PathPredictorOn, kPP_OwnShip_PastTrackOn, kPP_OwnShip_PastTrack_TimeIncrementsOn,
  kPP_OwnShip_PastTrack_TimeIncrementsStepSec, kPP_OwnShip_PastTrack_TimeIncrementsPresentationStyle, kPP_OwnShip_PastTrack_LengthSec, kPP_OwnShip_SecondaryOn,
  kPP_OwnShip_Secondary_PastTrackOn, kPP_OwnShip_Parallel_Index_Line1_On , kPP_OwnShip_Parallel_Index_Line1_Range , kPP_OwnShip_Parallel_Index_Line1_Length ,
  kPP_OwnShip_Parallel_Index_Line1_Bearing , kPP_OwnShip_Parallel_Index_Line1_Relative , kPP_OwnShip_HeadingLineOn, kPP_OwnShip_RangeRingsOn,
  kPP_OwnShip_RangeRingsStep, kPP_OwnShip_RangeRingsNumber, kPP_OwnShip_FirstRangeRingDistance, kPP_OwnShip_RadarAntennaPositionSymbolOn,
  kPP_OwnShip_PrimaryOn, kPP_OwnShip_UseDrawing, kPP_OwnShip_AnchorWatch_Activated, kPP_OwnShip_AnchorWatch_SwingCircleRadius,
  kPP_OwnShip_AnchorWatch_PositionLongitude , kPP_OwnShip_HistPastTrack_TimeIncrementsStepSec, kPP_OwnShip_SimplifiedSymbolType, kPP_OwnShip_FilterPastTrackOn,
  kPP_OwnShip_Secondary_SimplifiedSymbolType, kPP_OwnShip_DistanceLinesEnabled, kPP_OwnShip_SpeedVectorsEnabled, kPP_OwnShip_PositionsPredictorEnabled,
  kPP_OwnShip_PositionsPredictorInterval, kPP_OwnShip_PositionsPredictorPointCount, kPP_OwnShip_ShortDistanceUnits, kPP_OwnShip_OwnshipHighlightEnabled,
  kPP_OwnShip_SpeedVectorsTextEnabled, kPP_OwnShip_PastTrack_TimeIncrements_UseLocalTime, kPP_OwnShip_AnchorWatch_BearingWatch_Activated, kPP_OwnShip_AnchorWatch_BearingWatch_Direction,
  kPP_OwnShip_AnchorWatch_BearingWatch_Range, kPP_OwnShip_AnchorWatch_UseAlternativeSymbol, kPP_OwnShip_PastTrack_TimeIncrements_BigLabelsFont, kPP_OwnShip_AnchorWatch_AllowChangeSettingsAfterActivation ,
  kPP_OwnShip_BeamLineAlwaysOn, kPP_OwnShip_PastTrack_TimeIncrements_SuppressZLetterInLabel, kPP_OwnShip_PastTrack_TimeIncrements_LabelsTimeShift, kPP_OwnShip_AuxHeadingLineOn,
  kPP_OwnShip_PastTrack_TimeIncrements_LabelInterval, kPP_OwnShip_HistPastTrack_TimeIncrements_UseShortFormatForLabels
}
 Own ship portraying environment parameters. More...
 
enum  OwnShipSimplifiedSymbolTypeEnum { kPP_OwnShip_SimplifiedSymbol_Original = 0, kPP_OwnShip_SimplifiedSymbol_YellowTarget, kPP_OwnShip_SimplifiedSymbol_Shape }
 Own ship simplified symbol parameters. More...
 
enum  OwnShipDeviceConfig { ,
  kOwnShipDeviceConfig_CS = kOwnShipDeviceConfig_FirstValue, kOwnShipDeviceConfig_POS_PRIMARY, kOwnShipDeviceConfig_POS_SECONDARY, kOwnShipDeviceConfig_FirstPosDevice,
  kOwnShipDeviceConfig_POS1 = kOwnShipDeviceConfig_FirstPosDevice, kOwnShipDeviceConfig_POS2, kOwnShipDeviceConfig_POS3, kOwnShipDeviceConfig_POS4,
  kOwnShipDeviceConfig_LastPosDevice = kOwnShipDeviceConfig_POS4, kOwnShipDeviceConfig_FirstRadar, kOwnShipDeviceConfig_RADAR1 = kOwnShipDeviceConfig_FirstRadar, kOwnShipDeviceConfig_RADAR2,
  kOwnShipDeviceConfig_RADAR3, kOwnShipDeviceConfig_LastRadar = kOwnShipDeviceConfig_RADAR3, kOwnShipDeviceConfig_FirstSonar, kOwnShipDeviceConfig_SONAR1 = kOwnShipDeviceConfig_FirstSonar,
  kOwnShipDeviceConfig_SONAR2, kOwnShipDeviceConfig_SONAR3, kOwnShipDeviceConfig_LastSonar = kOwnShipDeviceConfig_SONAR3, kOwnShipDeviceConfig_BEARING_PORT,
  kOwnShipDeviceConfig_BEARING_STARBOARD, kOwnShipDeviceConfig_ECHO, kOwnShipDeviceConfig_FirstAnchor, kOwnShipDeviceConfig_ANCHOR1 = kOwnShipDeviceConfig_FirstAnchor,
  kOwnShipDeviceConfig_LastAnchor = kOwnShipDeviceConfig_ANCHOR1
}
 Own ship device configuration. More...
 
enum  OwnShipDeviceError { kOwnShipDeviceError_Angle = 0, kOwnShipDeviceError_Distance }
 Own ship device error. More...
 

Variables

static const SDK_VESSELS_BEGIN_NAMESPACE DatasetID kOwnShipDatasetID
 Own ship dataset ID.
 
static SDKUInt64 kDefaultPastTrackTimeIncrements = 1
 Default time increments along the past track. (float in minutes)
 

Detailed Description

Own ship components.

Enumeration Type Documentation

◆ OwnShipFeatureAttributeCode

Own Ship target feature class coded kSDKAnyType_Empty value means, that given attribute value is absent.

Enumerator
kOSFAC_dims_a 

From CCRP to Bow in meters.(kSDKAnyType_float)

kOSFAC_dims_b 

From CCRP to Stern in meters.(kSDKAnyType_float)

kOSFAC_dims_c 

From CCRP to Port in meters.(kSDKAnyType_float)

kOSFAC_dims_d 

From CCRP to Starboard in meters.(kSDKAnyType_float)

kOSFAC_maxhgt 

Max height in meters.

kOSFAC_drfmax 

Maximum draft in meters.

kOSFAC_drfcur 

Current draft in meters.

kOSFAC_turstb 

Turning radius in starboard direction.

kOSFAC_turprt 

Turning radius in port direction.

kOSFAC_devstb 

Deviation in starboard direction.

kOSFAC_devprt 

Deviation in port direction.

kOSFAC_ecospd 

Economical speed in knots.

kOSFAC_usecog 

Use COG if HDG unavailable.

kOSFAC_LPP 

Length between perpendiculars.

◆ OwnShipObjectEnum

Own ship objects definition.

Enumerator
kOwnShipObject_Primary 

Primary source.

kOwnShipObject_Secondary 

Secondary source.

kOwnShipObject_Secondary2 

Second secondary source.

kOwnShipObject_Secondary3 

Third secondary source

◆ PortrayalParameterOwnShipEnum

Own ship portraying environment parameters.

Enumerator
kPP_OwnShip_TrueScaledOutlinePermitted 

Turns on/off the true scaled outline. Boolean, default is true.

kPP_OwnShip_VelocityVectorOverGroundOn 

On/Off the velocity vector over ground. (Boolean, default is true)

kPP_OwnShip_VelocityVectorThroughWaterOn 

Turns on/off the velocity vector through water. (Boolean, default is true)

kPP_OwnShip_VelocityVector_LengthSec 

Velocity vector length. It represents the distance that own ship will travel in a selected time interval. (SDKUInt32, in seconds)

kPP_OwnShip_VelocityVector_TimeIncrementsStepSec 

Time increments along the velocity vector. (SDKUInt32, in seconds)

kPP_OwnShip_PathPredictorOn 

Turns on/off the path predictor. (Boolean, default is false)

kPP_OwnShip_PastTrackOn 

Turns on/off the own ship primary past track. (Boolean, default is true)

kPP_OwnShip_PastTrack_TimeIncrementsOn 

Turns on/off the time increments along the past track. (Boolean, default is false)

kPP_OwnShip_PastTrack_TimeIncrementsStepSec 

Specifies the time increments along the past track. (SDKUInt32, in seconds)

kPP_OwnShip_PastTrack_TimeIncrementsPresentationStyle 

Specifies the past track time increments presentation style. 0 - dashed line, 1 - dotted line. Default is 0.

kPP_OwnShip_PastTrack_LengthSec 

Specifies the time period for which the past track is stored in the memory. (SDKUInt32, in seconds)

kPP_OwnShip_SecondaryOn 

Turns on/off the visibility of secondary position sources. (Boolean, default is true)

kPP_OwnShip_Secondary_PastTrackOn 

Turns on/off the own ship secondary past track. (Boolean, default is false)

kPP_OwnShip_Parallel_Index_Line1_On 

Turns on/off the parallel index. (Boolean, default is false)

kPP_OwnShip_Parallel_Index_Line1_Range 

Parallel Index distance. It represents the distance of parallel index from the own ship location (float, in NM). If <0 the corresponding Parallel Index is switched off.

kPP_OwnShip_Parallel_Index_Line1_Length 

Parallel Index length. It represents the length of parallel index (float, in NM)

kPP_OwnShip_Parallel_Index_Line1_Bearing 

Parallel Index bearing (float, in degrees)

kPP_OwnShip_Parallel_Index_Line1_Relative 

Turns on/off the relative bearing mode of the parallel index. (Boolean, default is false)

kPP_OwnShip_HeadingLineOn 

Turns on/off the own ship heading line.

kPP_OwnShip_RangeRingsOn 

Turns on/off the range rings.

kPP_OwnShip_RangeRingsStep 

Range rings step (float, in NM)

kPP_OwnShip_RangeRingsNumber 

Number of range rings.

kPP_OwnShip_FirstRangeRingDistance 

Distance of first range ring.

kPP_OwnShip_RadarAntennaPositionSymbolOn 

Show radar antenna position when true scale outlined.

kPP_OwnShip_PrimaryOn 

Turns on/off the visibility of primary position sources. (Boolean, default is true)

kPP_OwnShip_UseDrawing 

Turns on/of using of the ownship drawing.

kPP_OwnShip_AnchorWatch_Activated 

Activates/deactivates the anchor watching mode.

Radius of the anchor watch swing circle

kPP_OwnShip_AnchorWatch_SwingCircleRadius 

Longitude of the anchor watch position.

kPP_OwnShip_AnchorWatch_PositionLongitude 

Latitude of the anchor watch position.

kPP_OwnShip_HistPastTrack_TimeIncrementsStepSec 

Specifies the time increments along the historical past track. (SDKUInt32, in seconds)

kPP_OwnShip_SimplifiedSymbolType 

Ownship simplified symbol type.

kPP_OwnShip_FilterPastTrackOn 

Filters past track at display if it is very long to prevent slow rendering.

kPP_OwnShip_Secondary_SimplifiedSymbolType 

Secondary simplified symbol type.

kPP_OwnShip_DistanceLinesEnabled 

Turns on/off the distance lines. Boolean, default is true.

kPP_OwnShip_SpeedVectorsEnabled 

Turns on/off the speed vectors lines. Boolean, default is true.

kPP_OwnShip_PositionsPredictorEnabled 

Turns on/off the vessel positions predictor. Boolean, default is true.

kPP_OwnShip_PositionsPredictorInterval 

Specifies the time interval for the vessel positions predictor. (SDKUInt32, in seconds)

kPP_OwnShip_PositionsPredictorPointCount 

Specifies the point count for the vessel positions predictor. (SDKUInt32)

kPP_OwnShip_ShortDistanceUnits 

Specifies the units for short distance. (SDKUInt32)

kPP_OwnShip_OwnshipHighlightEnabled 

Turns on/off the ownship vessel positions highlight. Boolean, default is false.

kPP_OwnShip_SpeedVectorsTextEnabled 

Turns on/off the speed vectors text tip. Boolean, default is false.

kPP_OwnShip_PastTrack_TimeIncrements_UseLocalTime 

Switches the time increments along the past track to local time. (Boolean, default is false)

kPP_OwnShip_AnchorWatch_BearingWatch_Activated 

Activates/deactivates the bearing watching mode.

Direction angle of the bearing watch

kPP_OwnShip_AnchorWatch_BearingWatch_Direction 

Range angle of the bearing watch.

kPP_OwnShip_AnchorWatch_BearingWatch_Range 

Use alternative anchor watch symbol/color.

kPP_OwnShip_AnchorWatch_UseAlternativeSymbol 

Use bigger (4mm) font size for past track time increment labels (Boolean, default is false)

kPP_OwnShip_PastTrack_TimeIncrements_BigLabelsFont 

Allow applying settings changes after the Anchor watch has been activated.

kPP_OwnShip_AnchorWatch_AllowChangeSettingsAfterActivation 

Radar antenna position source (radar 1/2/3, etc) (SDKUInt32, one of OwnShipDeviceConfig values, default value is kOwnShipDeviceConfig_RADAR1)

kPP_OwnShip_BeamLineAlwaysOn 

Forces beam line to be always on.

kPP_OwnShip_PastTrack_TimeIncrements_SuppressZLetterInLabel 

Suppress Z letter in past track time mark label. (Boolean, default is false)

kPP_OwnShip_PastTrack_TimeIncrements_LabelsTimeShift 

Past track time labels shift from UTC, in seconds Example: Real past track time labels: 08.00, 09.00, 10.00, 11.00, ... After LabelsTimeShift = +1 * 60 * 60: 09.00, 10.00, 11.00, 12.00, ... (SDKInt32, default is 0)

kPP_OwnShip_AuxHeadingLineOn 

Turns on/off the own ship auxiliary heading line. Thin orange line, starts from CCRP, goes in heading direction till chart border (Boolean, default is false)

kPP_OwnShip_PastTrack_TimeIncrements_LabelInterval 

Specify time label draw interval, in number of past track position points. non-zero SDKUInt32, default is 1 Example: If the value is set to 3, then time label will be drawn for every third past track position.

kPP_OwnShip_HistPastTrack_TimeIncrements_UseShortFormatForLabels 

Uses short (only time) format for historical past track labels. (Boolean, default is false)

◆ OwnShipSimplifiedSymbolTypeEnum

Own ship simplified symbol parameters.

Enumerator
kPP_OwnShip_SimplifiedSymbol_Original 

Simplified symbol original.

kPP_OwnShip_SimplifiedSymbol_YellowTarget 

Simplified symbol yellow target.

kPP_OwnShip_SimplifiedSymbol_Shape 

Simplified symbol shape.

◆ OwnShipDeviceConfig

Own ship device configuration.

Enumerator
kOwnShipDeviceConfig_CS 

Conning station.

kOwnShipDeviceConfig_POS_PRIMARY 

primary position sensor

kOwnShipDeviceConfig_POS_SECONDARY 

secondary position sensor

kOwnShipDeviceConfig_FirstPosDevice 

First position sensor.

kOwnShipDeviceConfig_POS1 

position sensor 1

kOwnShipDeviceConfig_POS2 

position sensor 2

kOwnShipDeviceConfig_POS3 

position sensor 3

kOwnShipDeviceConfig_POS4 

position sensor 4

kOwnShipDeviceConfig_LastPosDevice 

Last position sensor.

kOwnShipDeviceConfig_FirstRadar 

First radar.

kOwnShipDeviceConfig_RADAR1 

radar 1

kOwnShipDeviceConfig_RADAR2 

radar 2

kOwnShipDeviceConfig_RADAR3 

radar 3

kOwnShipDeviceConfig_LastRadar 

Last radar.

kOwnShipDeviceConfig_FirstSonar 

First sonar.

kOwnShipDeviceConfig_SONAR1 

sonar 1

kOwnShipDeviceConfig_SONAR2 

sonar 2

kOwnShipDeviceConfig_SONAR3 

sonar 3

kOwnShipDeviceConfig_LastSonar 

Last sonar.

kOwnShipDeviceConfig_BEARING_PORT 

port bearing device (direction finder)

kOwnShipDeviceConfig_BEARING_STARBOARD 

starboard bearing device

kOwnShipDeviceConfig_ECHO 

echo sounder

kOwnShipDeviceConfig_FirstAnchor 

First anchor.

kOwnShipDeviceConfig_ANCHOR1 

anchor 1

kOwnShipDeviceConfig_LastAnchor 

Last anchor.

◆ OwnShipDeviceError

Own ship device error.

Enumerator
kOwnShipDeviceError_Angle 

Angle error.

kOwnShipDeviceError_Distance 

Distance error.