NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
ownship_const.h
Go to the documentation of this file.
1 #ifndef SDK_ECDISLAYER_OWNSHIP_CONST_H_
10 #define SDK_ECDISLAYER_OWNSHIP_CONST_H_
11 #pragma once
12 
13 #include <base/inc/base_types.h>
16 
17 SDK_VESSELS_BEGIN_NAMESPACE
18 
21 static const DatasetID kOwnShipDatasetID = DatasetID_MakeID(
22  kWorkspaceID_InternalUser_OwnShip, 1UL);
23 
24 //const ClassCode kFCC_MOB = 8197;
25 
44 };
45 
48 typedef enum OwnShipObjectEnum {
56 
61  kPP_OwnShip_TrueScaledOutlinePermitted = sdk::vis::kPortrayalParameters_OwnShip,
62 
66 
70 
74 
78 
82 
86 
90 
94 
98 
103 
107 
111 
115  kPP_OwnShip_Parallel_Index_Line2_On,
116  kPP_OwnShip_Parallel_Index_Line3_On,
117  kPP_OwnShip_Parallel_Index_Line4_On,
118 
123  kPP_OwnShip_Parallel_Index_Line2_Range,
124  kPP_OwnShip_Parallel_Index_Line3_Range,
125  kPP_OwnShip_Parallel_Index_Line4_Range,
126 
130  kPP_OwnShip_Parallel_Index_Line2_Length,
131  kPP_OwnShip_Parallel_Index_Line3_Length,
132  kPP_OwnShip_Parallel_Index_Line4_Length,
133 
136  kPP_OwnShip_Parallel_Index_Line2_Bearing,
137  kPP_OwnShip_Parallel_Index_Line3_Bearing,
138  kPP_OwnShip_Parallel_Index_Line4_Bearing,
139 
143  kPP_OwnShip_Parallel_Index_Line2_Relative,
144  kPP_OwnShip_Parallel_Index_Line3_Relative,
145  kPP_OwnShip_Parallel_Index_Line4_Relative,
146 
149 
152 
155 
158 
161 
164 
168 
171 
174 
177 
180 
182  kPP_OwnShip_AnchorWatch_PositionLatitude,
183 
187 
190 
193 
196 
199 
202 
205 
209 
213 
217 
220 
223 
227 
230 
233 
236 
239 
243 
246 
250  kPP_OwnShip_RadarAntennaPositionSource,
251 
254 
258 
267 
273 
281 
285 
286 } OwnShipEnvironmentParams;
287 
293 
296 
299 
301 
304 static SDKUInt64 kDefaultPastTrackTimeIncrements = 1;
305 
306 // Track length (sec) and Minimal track step (sec) at display
307 // (Very long track renders too long, so limiting track step
308 // we keep maximal points number below ~5000.
309 struct TrackDisplayFilterSlot
310 {
311  SDKUInt32 track_length_sec;
312  SDKUInt32 filter_step_sec;
313 };
314 static TrackDisplayFilterSlot kTrackDisplayFilter[] = {
315  { 5 * 60, 1 },
316  { 10 * 60, 1 },
317  { 15 * 60, 1 },
318  { 30 * 60, 1 },
319  { 1 * 60 * 60, 1 },
320  { 2 * 60 * 60, 2 },
321  { 3 * 60 * 60, 2 },
322  { 4 * 60 * 60, 3 },
323  { 5 * 60 * 60, 5 },
324  { 6 * 60 * 60, 5 },
325  { 7 * 60 * 60, 5 },
326  { 8 * 60 * 60, 10 },
327  { 9 * 60 * 60, 10 },
328  { 10 * 60 * 60, 10 },
329  { 11 * 60 * 60, 10 },
330  { 12 * 60 * 60, 10 },
331  { 16 * 60 * 60, 15 },
332  { 20 * 60 * 60, 15 },
333  { 24 * 60 * 60, 15 } };
334 
335 SDK_VESSELS_END_NAMESPACE
336 
337 #endif // SDK_ECDISLAYER_OWNSHIP_CONST_H_
kPP_OwnShip_Secondary_PastTrackOn
@ kPP_OwnShip_Secondary_PastTrackOn
Turns on/off the own ship secondary past track. (Boolean, default is false)
Definition: ownship_const.h:110
kPP_OwnShip_AnchorWatch_SwingCircleRadius
@ kPP_OwnShip_AnchorWatch_SwingCircleRadius
Longitude of the anchor watch position.
Definition: ownship_const.h:176
kFAC_LPP
@ kFAC_LPP
Length between perpendiculars.
Definition: vessels_const.h:474
kOSFAC_usecog
@ kOSFAC_usecog
Use COG if HDG unavailable.
Definition: ownship_const.h:42
kPP_OwnShip_SimplifiedSymbolType
@ kPP_OwnShip_SimplifiedSymbolType
Ownship simplified symbol type.
Definition: ownship_const.h:189
kOSFAC_maxhgt
@ kOSFAC_maxhgt
Max height in meters.
Definition: ownship_const.h:34
kPP_OwnShip_AnchorWatch_BearingWatch_Activated
@ kPP_OwnShip_AnchorWatch_BearingWatch_Activated
Activates/deactivates the bearing watching mode.
Definition: ownship_const.h:229
kOSFAC_dims_a
@ kOSFAC_dims_a
From CCRP to Bow in meters.(kSDKAnyType_float)
Definition: ownship_const.h:30
kPP_OwnShip_Parallel_Index_Line1_Bearing
@ kPP_OwnShip_Parallel_Index_Line1_Bearing
Parallel Index bearing (float, in degrees)
Definition: ownship_const.h:135
kOSFAC_turstb
@ kOSFAC_turstb
Turning radius in starboard direction.
Definition: ownship_const.h:37
kPP_OwnShip_PrimaryOn
@ kPP_OwnShip_PrimaryOn
Turns on/off the visibility of primary position sources. (Boolean, default is true)
Definition: ownship_const.h:167
kPP_OwnShip_RangeRingsStep
@ kPP_OwnShip_RangeRingsStep
Range rings step (float, in NM)
Definition: ownship_const.h:154
kPP_OwnShip_Parallel_Index_Line1_Relative
@ kPP_OwnShip_Parallel_Index_Line1_Relative
Turns on/off the relative bearing mode of the parallel index. (Boolean, default is false)
Definition: ownship_const.h:142
OwnShipSimplifiedSymbolTypeEnum
OwnShipSimplifiedSymbolTypeEnum
Own ship simplified symbol parameters.
Definition: ownship_const.h:290
base_types.h
SDK base types.
kPP_OwnShip_SpeedVectorsEnabled
@ kPP_OwnShip_SpeedVectorsEnabled
Turns on/off the speed vectors lines. Boolean, default is true.
Definition: ownship_const.h:201
kPP_OwnShip_PastTrack_TimeIncrementsPresentationStyle
@ kPP_OwnShip_PastTrack_TimeIncrementsPresentationStyle
Specifies the past track time increments presentation style. 0 - dashed line, 1 - dotted line....
Definition: ownship_const.h:97
kOSFAC_dims_d
@ kOSFAC_dims_d
From CCRP to Starboard in meters.(kSDKAnyType_float)
Definition: ownship_const.h:33
vessels_const.h
Defines Vessels constants.
kPP_OwnShip_PastTrack_TimeIncrementsOn
@ kPP_OwnShip_PastTrack_TimeIncrementsOn
Turns on/off the time increments along the past track. (Boolean, default is false)
Definition: ownship_const.h:89
kPP_OwnShip_AnchorWatch_AllowChangeSettingsAfterActivation
@ kPP_OwnShip_AnchorWatch_AllowChangeSettingsAfterActivation
Radar antenna position source (radar 1/2/3, etc) (SDKUInt32, one of OwnShipDeviceConfig values,...
Definition: ownship_const.h:245
kFAC_dims_c
@ kFAC_dims_c
From CCRP to Port.
Definition: vessels_const.h:436
kPP_OwnShip_PositionsPredictorInterval
@ kPP_OwnShip_PositionsPredictorInterval
Specifies the time interval for the vessel positions predictor. (SDKUInt32, in seconds)
Definition: ownship_const.h:208
kOwnShipObject_Secondary
@ kOwnShipObject_Secondary
Secondary source.
Definition: ownship_const.h:50
kPP_OwnShip_ShortDistanceUnits
@ kPP_OwnShip_ShortDistanceUnits
Specifies the units for short distance. (SDKUInt32)
Definition: ownship_const.h:216
kPP_OwnShip_PathPredictorOn
@ kPP_OwnShip_PathPredictorOn
Turns on/off the path predictor. (Boolean, default is false)
Definition: ownship_const.h:81
kFAC_ecospd
@ kFAC_ecospd
Economical speed in knots.
Definition: vessels_const.h:443
kOSFAC_drfcur
@ kOSFAC_drfcur
Current draft in meters.
Definition: ownship_const.h:36
kOwnShipObject_Secondary3
@ kOwnShipObject_Secondary3
Definition: ownship_const.h:52
kPP_OwnShip_VelocityVector_LengthSec
@ kPP_OwnShip_VelocityVector_LengthSec
Velocity vector length. It represents the distance that own ship will travel in a selected time inter...
Definition: ownship_const.h:73
kOSFAC_dims_c
@ kOSFAC_dims_c
From CCRP to Port in meters.(kSDKAnyType_float)
Definition: ownship_const.h:32
portrayal_parameters_interface.h
Describes the interface that manages portrayal controlling parameters.
kFAC_turprt
@ kFAC_turprt
Turning radius in port direction.
Definition: vessels_const.h:442
kFAC_devstb
@ kFAC_devstb
Deviation in starboard direction.
Definition: vessels_const.h:457
kOwnShipObject_Primary
@ kOwnShipObject_Primary
Primary source.
Definition: ownship_const.h:49
kOSFAC_drfmax
@ kOSFAC_drfmax
Maximum draft in meters.
Definition: ownship_const.h:35
kPP_OwnShip_SimplifiedSymbol_YellowTarget
@ kPP_OwnShip_SimplifiedSymbol_YellowTarget
Simplified symbol yellow target.
Definition: ownship_const.h:295
kPP_OwnShip_Parallel_Index_Line1_Length
@ kPP_OwnShip_Parallel_Index_Line1_Length
Parallel Index length. It represents the length of parallel index (float, in NM)
Definition: ownship_const.h:129
kOwnShipDatasetID
static const SDK_VESSELS_BEGIN_NAMESPACE DatasetID kOwnShipDatasetID
Own ship dataset ID.
Definition: ownship_const.h:21
kPP_OwnShip_PastTrack_TimeIncrements_BigLabelsFont
@ kPP_OwnShip_PastTrack_TimeIncrements_BigLabelsFont
Allow applying settings changes after the Anchor watch has been activated.
Definition: ownship_const.h:242
kPP_OwnShip_AnchorWatch_Activated
@ kPP_OwnShip_AnchorWatch_Activated
Activates/deactivates the anchor watching mode.
Definition: ownship_const.h:173
OwnShipObjectEnum
OwnShipObjectEnum
Own ship objects definition.
Definition: ownship_const.h:48
kPP_OwnShip_BeamLineAlwaysOn
@ kPP_OwnShip_BeamLineAlwaysOn
Forces beam line to be always on.
Definition: ownship_const.h:253
kOSFAC_ecospd
@ kOSFAC_ecospd
Economical speed in knots.
Definition: ownship_const.h:41
kPP_OwnShip_PastTrack_TimeIncrements_LabelInterval
@ kPP_OwnShip_PastTrack_TimeIncrements_LabelInterval
Specify time label draw interval, in number of past track position points. non-zero SDKUInt32,...
Definition: ownship_const.h:280
kFAC_drfcur
@ kFAC_drfcur
Current draft in meters.
Definition: vessels_const.h:440
kPP_OwnShip_FirstRangeRingDistance
@ kPP_OwnShip_FirstRangeRingDistance
Distance of first range ring.
Definition: ownship_const.h:160
kFAC_turstb
@ kFAC_turstb
Turning radius in starboard direction.
Definition: vessels_const.h:441
kFAC_maxhgt
@ kFAC_maxhgt
Maximum height in meters.
Definition: vessels_const.h:438
kPP_OwnShip_PastTrackOn
@ kPP_OwnShip_PastTrackOn
Turns on/off the own ship primary past track. (Boolean, default is true)
Definition: ownship_const.h:85
kPP_OwnShip_AnchorWatch_PositionLongitude
@ kPP_OwnShip_AnchorWatch_PositionLongitude
Latitude of the anchor watch position.
Definition: ownship_const.h:179
kPP_OwnShip_DistanceLinesEnabled
@ kPP_OwnShip_DistanceLinesEnabled
Turns on/off the distance lines. Boolean, default is true.
Definition: ownship_const.h:198
kFAC_dims_a
@ kFAC_dims_a
From CCRP to Bow.
Definition: vessels_const.h:434
kFAC_usecog
@ kFAC_usecog
Use COG if HDG unavailable.
Definition: vessels_const.h:444
kFAC_devprt
@ kFAC_devprt
Deviation in port direction.
Definition: vessels_const.h:458
PortrayalParameterOwnShipEnum
PortrayalParameterOwnShipEnum
Own ship portraying environment parameters.
Definition: ownship_const.h:59
kPP_OwnShip_SimplifiedSymbol_Shape
@ kPP_OwnShip_SimplifiedSymbol_Shape
Simplified symbol shape.
Definition: ownship_const.h:298
kOwnShipObject_Secondary2
@ kOwnShipObject_Secondary2
Second secondary source.
Definition: ownship_const.h:51
kOSFAC_devprt
@ kOSFAC_devprt
Deviation in port direction.
Definition: ownship_const.h:40
kPP_OwnShip_RadarAntennaPositionSymbolOn
@ kPP_OwnShip_RadarAntennaPositionSymbolOn
Show radar antenna position when true scale outlined.
Definition: ownship_const.h:163
kPP_OwnShip_AnchorWatch_UseAlternativeSymbol
@ kPP_OwnShip_AnchorWatch_UseAlternativeSymbol
Use bigger (4mm) font size for past track time increment labels (Boolean, default is false)
Definition: ownship_const.h:238
kPP_OwnShip_Parallel_Index_Line1_On
@ kPP_OwnShip_Parallel_Index_Line1_On
Turns on/off the parallel index. (Boolean, default is false)
Definition: ownship_const.h:114
kPP_OwnShip_SpeedVectorsTextEnabled
@ kPP_OwnShip_SpeedVectorsTextEnabled
Turns on/off the speed vectors text tip. Boolean, default is false.
Definition: ownship_const.h:222
kPP_OwnShip_RangeRingsOn
@ kPP_OwnShip_RangeRingsOn
Turns on/off the range rings.
Definition: ownship_const.h:151
kPP_OwnShip_OwnshipHighlightEnabled
@ kPP_OwnShip_OwnshipHighlightEnabled
Turns on/off the ownship vessel positions highlight. Boolean, default is false.
Definition: ownship_const.h:219
kPP_OwnShip_SecondaryOn
@ kPP_OwnShip_SecondaryOn
Turns on/off the visibility of secondary position sources. (Boolean, default is true)
Definition: ownship_const.h:106
kPP_OwnShip_AuxHeadingLineOn
@ kPP_OwnShip_AuxHeadingLineOn
Turns on/off the own ship auxiliary heading line. Thin orange line, starts from CCRP,...
Definition: ownship_const.h:272
kPP_OwnShip_HistPastTrack_TimeIncrementsStepSec
@ kPP_OwnShip_HistPastTrack_TimeIncrementsStepSec
Specifies the time increments along the historical past track. (SDKUInt32, in seconds)
Definition: ownship_const.h:186
kPP_OwnShip_VelocityVectorOverGroundOn
@ kPP_OwnShip_VelocityVectorOverGroundOn
On/Off the velocity vector over ground. (Boolean, default is true)
Definition: ownship_const.h:65
kPP_OwnShip_PastTrack_LengthSec
@ kPP_OwnShip_PastTrack_LengthSec
Specifies the time period for which the past track is stored in the memory. (SDKUInt32,...
Definition: ownship_const.h:102
kPP_OwnShip_Secondary_SimplifiedSymbolType
@ kPP_OwnShip_Secondary_SimplifiedSymbolType
Secondary simplified symbol type.
Definition: ownship_const.h:195
kPP_OwnShip_PastTrack_TimeIncrements_UseLocalTime
@ kPP_OwnShip_PastTrack_TimeIncrements_UseLocalTime
Switches the time increments along the past track to local time. (Boolean, default is false)
Definition: ownship_const.h:226
kPP_OwnShip_PositionsPredictorEnabled
@ kPP_OwnShip_PositionsPredictorEnabled
Turns on/off the vessel positions predictor. Boolean, default is true.
Definition: ownship_const.h:204
kPP_OwnShip_TrueScaledOutlinePermitted
@ kPP_OwnShip_TrueScaledOutlinePermitted
Turns on/off the true scaled outline. Boolean, default is true.
Definition: ownship_const.h:61
kPP_OwnShip_HistPastTrack_TimeIncrements_UseShortFormatForLabels
@ kPP_OwnShip_HistPastTrack_TimeIncrements_UseShortFormatForLabels
Uses short (only time) format for historical past track labels. (Boolean, default is false)
Definition: ownship_const.h:284
kOSFAC_devstb
@ kOSFAC_devstb
Deviation in starboard direction.
Definition: ownship_const.h:39
kPP_OwnShip_HeadingLineOn
@ kPP_OwnShip_HeadingLineOn
Turns on/off the own ship heading line.
Definition: ownship_const.h:148
kPP_OwnShip_PastTrack_TimeIncrements_SuppressZLetterInLabel
@ kPP_OwnShip_PastTrack_TimeIncrements_SuppressZLetterInLabel
Suppress Z letter in past track time mark label. (Boolean, default is false)
Definition: ownship_const.h:257
kPP_OwnShip_Parallel_Index_Line1_Range
@ kPP_OwnShip_Parallel_Index_Line1_Range
Parallel Index distance. It represents the distance of parallel index from the own ship location (flo...
Definition: ownship_const.h:122
kOSFAC_turprt
@ kOSFAC_turprt
Turning radius in port direction.
Definition: ownship_const.h:38
kFAC_drfmax
@ kFAC_drfmax
Maximum draft in meters.
Definition: vessels_const.h:439
kFAC_dims_d
@ kFAC_dims_d
From CCRP to Starboard.
Definition: vessels_const.h:437
OwnShipFeatureAttributeCode
OwnShipFeatureAttributeCode
Own Ship target feature class coded kSDKAnyType_Empty value means, that given attribute value is abse...
Definition: ownship_const.h:29
kPP_OwnShip_VelocityVector_TimeIncrementsStepSec
@ kPP_OwnShip_VelocityVector_TimeIncrementsStepSec
Time increments along the velocity vector. (SDKUInt32, in seconds)
Definition: ownship_const.h:77
kPP_OwnShip_RangeRingsNumber
@ kPP_OwnShip_RangeRingsNumber
Number of range rings.
Definition: ownship_const.h:157
kFAC_dims_b
@ kFAC_dims_b
From CCRP to Stern.
Definition: vessels_const.h:435
kOSFAC_LPP
@ kOSFAC_LPP
Length between perpendiculars.
Definition: ownship_const.h:43
kPP_OwnShip_UseDrawing
@ kPP_OwnShip_UseDrawing
Turns on/of using of the ownship drawing.
Definition: ownship_const.h:170
kPP_OwnShip_PastTrack_TimeIncrements_LabelsTimeShift
@ kPP_OwnShip_PastTrack_TimeIncrements_LabelsTimeShift
Past track time labels shift from UTC, in seconds Example: Real past track time labels: 08....
Definition: ownship_const.h:266
kDefaultPastTrackTimeIncrements
static SDKUInt64 kDefaultPastTrackTimeIncrements
Default time increments along the past track. (float in minutes)
Definition: ownship_const.h:304
kPP_OwnShip_AnchorWatch_BearingWatch_Direction
@ kPP_OwnShip_AnchorWatch_BearingWatch_Direction
Range angle of the bearing watch.
Definition: ownship_const.h:232
kOSFAC_dims_b
@ kOSFAC_dims_b
From CCRP to Stern in meters.(kSDKAnyType_float)
Definition: ownship_const.h:31
kPP_OwnShip_SimplifiedSymbol_Original
@ kPP_OwnShip_SimplifiedSymbol_Original
Simplified symbol original.
Definition: ownship_const.h:292
kPP_OwnShip_PositionsPredictorPointCount
@ kPP_OwnShip_PositionsPredictorPointCount
Specifies the point count for the vessel positions predictor. (SDKUInt32)
Definition: ownship_const.h:212
kPP_OwnShip_VelocityVectorThroughWaterOn
@ kPP_OwnShip_VelocityVectorThroughWaterOn
Turns on/off the velocity vector through water. (Boolean, default is true)
Definition: ownship_const.h:69
kPP_OwnShip_PastTrack_TimeIncrementsStepSec
@ kPP_OwnShip_PastTrack_TimeIncrementsStepSec
Specifies the time increments along the past track. (SDKUInt32, in seconds)
Definition: ownship_const.h:93
kPP_OwnShip_AnchorWatch_BearingWatch_Range
@ kPP_OwnShip_AnchorWatch_BearingWatch_Range
Use alternative anchor watch symbol/color.
Definition: ownship_const.h:235
kPP_OwnShip_FilterPastTrackOn
@ kPP_OwnShip_FilterPastTrackOn
Filters past track at display if it is very long to prevent slow rendering.
Definition: ownship_const.h:192