Vessels

Vessels library. More...

Modules
	Own ship
	Own ship components.
	Radar targets
	Radar/Sonar target components.
	AIS
	AIS target components.

Data Structures
class	ITargetUpdateDescription
	Optional target information about applied update. More...
class	IUpdatedTargets
	Set of updated target's. More...
class	IVesselWorkspace
	Provides access to members that manage the vessels workspace. More...
class	IVesselDataset
	Provides access to members that provide information about a VesselDataset. More...
class	IVessel
	Common interface for all of vessel objects. More...
class	IPositionFixing
	Position fixing. More...

Typedefs
typedef SDKUInt32	UpdateDescriptionRecordID
	Update description record ID.
typedef SDKUInt64	TargetFOID
	Target FOID definition (AIS/Radar/Sonar targets)
typedef SDKUInt32	TargetAlarmIDs
	AIS/Radar/Sonar target alarm IDs (see the TargetAlarmType description below)

Enumerations
enum	TargetAlarmType
	All of available AIS/Radar/Sonar target's alarms.
enum	AlarmState
	All of available alarm states of targets.
enum	VesselDatasetProperty {   kDSP_VesselDatasetPropery_First = kDSP_User + 1000, kDSP_PastTrackSizeToStoreSec = kDSP_VesselDatasetPropery_First, kDSP_dims_a, kDSP_dims_b,   kDSP_dims_c, kDSP_dims_d, kDSP_maxhgt, kDSP_drfmax,   kDSP_drfcur, kDSP_turstb, kDSP_turprt, kDSP_devstb,   kDSP_devprt, kDSP_ecospd, kDSP_usecog, kDSP_DangerDCPA_NM,   kDSP_DangerTCPA_Sec, kDSP_VisibilityDistance_NM, kDSP_ActivationDistance_NM, kDSP_DangerDistance_NM,   kDSP_LostTargetAlertDistance_NM, kDSP_RemoveVesselTimeout_Sec, kDSP_LostTimeout_SARAircraft_Sec, kDSP_LostTimeout_AtoN_Sec,   kDSP_LostTimeout_BaseStation_Sec, kDSP_LostTimeout_AIS_SART_Sec, kDSP_LostTimeout_ClassA_AtAnchor_LessThan_3_Knots_Sec, kDSP_LostTimeout_ClassA_AtAnchor_MoreThan_3_Knots_Sec,   kDSP_LostTimeout_ClassA_0_14_Knots_Sec, kDSP_LostTimeout_ClassA_0_14_Knots_ChangingCourse_Sec, kDSP_LostTimeout_ClassA_14_23_Knots_Sec, kDSP_LostTimeout_ClassA_14_23_Knots_ChangingCourse_Sec,   kDSP_LostTimeout_ClassA_MoreThan_23_Knots_Sec, kDSP_LostTimeout_ClassA_MoreThan_23_Knots_ChangingCourse_Sec, kDSP_LostTimeout_ClassB_SO_LessThan_2_Knots_Sec, kDSP_LostTimeout_ClassB_SO_2_14_Knots_Sec,   kDSP_LostTimeout_ClassB_SO_14_23_Knots_Sec, kDSP_LostTimeout_ClassB_SO_MoreThan_23_Knots_Sec, kDSP_LostTimeout_ClassB_CS_LessThan_2_Knots_Sec, kDSP_LostTimeout_ClassB_CS_MoreThan_2_Knots_Sec,   kDSP_LostTimeout_Radar_Sonar_Targets_Sec, kDSP_TargetNamesDatabasePath, kDSP_DontCalculateTCPA_DCPA, kDSP_AlwaysShowRealAtoNPurpose,   kDSP_OwnShipMMSI, kDSP_OwnShip_Name, kDSP_OwnShip_IMONumber, kDSP_OwnShip_CallSign,   kDSP_Radar1_Offset_X, kDSP_Radar1_Offset_Y, kDSP_Radar2_Offset_X, kDSP_Radar2_Offset_Y,   kDSP_Radar3_Offset_X, kDSP_Radar3_Offset_Y, kDSP_maxspd, kDSP_RadarSupportsTargetsAssociation,   kDSP_AtoNsFromEdition1, kDSP_AISMessaging_ECDIS_Talker_ID , kDSP_TargetsAssociationEnabled, kDSP_VisibilityRange_Enabled,   kDSP_StrictUseOfIEC62288, kDSP_DisplayAssociatedAISOnARPAPosition, kDSP_Vessel_Drawing, kDSP_VoyageDraught,   kDSP_Anchor1_Offset_X, kDSP_Anchor1_Offset_Y, kDSP_LostTargetAlert_On, kDSP_CPA_TCPA_Alert_On,   kDSP_AutoActivation_On, kDSP_PastTrack_MemoryLimit_MB, kDSP_DangerDistance_Alert_On, kDSP_LostTimeout_LongRangeVessel_Sec,   kDSP_LostTimeout_SyntheticTarget_Sec, kDSP_MaxCapacity_RegularTarget, kDSP_MaxCapacity_SyntheticTarget, kDSP_MaxCapacity_AsmTarget,   kDSP_Trim_Positive_Aft = 2200, kDSP_Displacement, kDSP_LCG_Forward_HalfLpp, kDSP_TPC,   kDSP_Block_Coefficient, kDSP_UKC_Limit_Ocean, kDSP_UKC_Limit_Relative_Ocean, kDSP_UKC_Limit_Use_Relative_Ocean,   kDSP_UKC_Calculation_Limit_Ocean, kDSP_UKC_Calculation_Limit_Relative_Ocean, kDSP_UKC_Calculation_Limit_Use_Relative_Ocean, kDSP_UKC_Limit_Coastal,   kDSP_UKC_Limit_Relative_Coastal, kDSP_UKC_Limit_Use_Relative_Coastal, kDSP_UKC_Calculation_Limit_Coastal, kDSP_UKC_Calculation_Limit_Relative_Coastal,   kDSP_UKC_Calculation_Limit_Use_Relative_Coastal, kDSP_UKC_Limit_Pilotage, kDSP_UKC_Limit_Relative_Pilotage, kDSP_UKC_Limit_Use_Relative_Pilotage,   kDSP_UKC_Calculation_Limit_Pilotage, kDSP_UKC_Calculation_Limit_Relative_Pilotage, kDSP_UKC_Calculation_Limit_Use_Relative_Pilotage, kDSP_UKC_Limit_Moored,   kDSP_UKC_Limit_Relative_Moored, kDSP_UKC_Limit_Use_Relative_Moored, kDSP_UKC_Calculation_Limit_Moored, kDSP_UKC_Calculation_Limit_Relative_Moored,   kDSP_UKC_Calculation_Limit_Use_Relative_Moored, kDSP_meandraught, kDSP_minspd, kDSP_OwnShip_Owner,   kDSP_LPP , kDSP_UKC_Limit_PassageType5, kDSP_UKC_Limit_Relative_PassageType5, kDSP_UKC_Limit_Use_Relative_PassageType5,   kDSP_UKC_Calculation_Limit_PassageType5, kDSP_UKC_Calculation_Limit_Relative_PassageType5, kDSP_UKC_Calculation_Limit_Use_Relative_PassageType5 }
	Vessel's dataset properties (Extension of DatasetProperty enum) More...
enum	VesselProperty { kVesselProperty_FilterPositionThresholdSec }
	Vessel's properties. More...
enum	FeatureAttributeCode { ,   kFAC_catpst = 52001, kFAC_cogcrs = 52002, kFAC_ctwcrs = 52003, kFAC_headng = 52004,   kFAC_inptid = 52005, kFAC_sogspd = 52006, kFAC_stwspd = 52007, kFAC_sounding = 52008,   kFAC_true_or_relative = 52009, kFAC_roturn = 52010, kFAC_possrc = 52011, kFAC_cogsrc = 52012,   kFAC_sogsrc = 52013, kFAC_hdgsrc = 52014, kFAC_stwsrc = 52015, kFAC_soundingsrc = 52016,   kFAC_possrc_type = 52017, kFAC_cogsrc_type = 52018, kFAC_sogsrc_type = 52019, kFAC_hdgsrc_type = 52020,   kFAC_stwsrc_type = 52021, kFAC_soundingsrc_type = 52022, kFAC_cogcrs_is_valid = 52023, kFAC_ctwcrs_is_valid = 52024,   kFAC_headng_is_valid = 52025, kFAC_sogspd_is_valid = 52026, kFAC_stwspd_is_valid = 52027, kFAC_sounding_is_valid = 52028,   kFAC_roturn_is_valid = 52029, kFAC_dims_a = 52030, kFAC_dims_b = 52031, kFAC_dims_c = 52032,   kFAC_dims_d = 52033, kFAC_maxhgt = 52034, kFAC_drfmax = 52035, kFAC_drfcur = 52036,   kFAC_turstb = 52037, kFAC_turprt = 52038, kFAC_ecospd = 52039, kFAC_usecog = 52040,   kFAC_time = 52041, kFAC_ticks = 52042, kFAC_name = 52043, kFAC_brgtru = 52044,   kFAC_brgrel = 52045, kFAC_dist = 52046, kFAC_ordcpa = 52047 , kFAC_ortcpa = 52048,   kFAC_dcpa = 52049 , kFAC_tcpa = 52050, kFAC_devstb = 52051, kFAC_devprt = 52052,   kFAC_year = 52053, kFAC_month = 52054, kFAC_day = 52055, kFAC_hours = 52056,   kFAC_minute = 52057, kFAC_second = 52058, kFAC_danger = 52059, kFAC_lost = 52060,   kFAC_cogcrs_lost = 52061, kFAC_ctwcrs_lost = 52062, kFAC_headng_lost = 52063, kFAC_sogspd_lost = 52064,   kFAC_stwspd_lost = 52065, kFAC_sounding_lost = 52066, kFAC_roturn_lost = 52067, kFAC_LPP = 52068,   kFAC_number = 52070, kFAC_reftgt = 52071, kFAC_rtgtnm = 52072, kFAC_prvsta = 52073,   kFAC_tiksta = 52074, kFAC_crsori = 52075, kFAC_crsort = 52076, kFAC_spdori = 52077,   kFAC_spdort = 52078, kFAC_stwmod = 52079, kFAC_acquis = 52080, kFAC_tsttgt = 52081,   kFAC_assoc = 52082, kFAC_cursta = 52083, kFAC_asmmsi = 52084, kFAC_asfoid = 52085,   kFAC_source = 52086, kFAC_srcnam = 52087, kFAC_ttdsta = 52088, kFAC_arfoid = 52089,   kFAC_mrfoid = 52090, kFAC_mmsi = 52100, kFAC_aistyp = 52101, kFAC_navsts = 52102,   kFAC_posach = 52103, kFAC_tstamp = 52104, kFAC_epfs = 52105, kFAC_spmani = 52106,   kFAC_usraim = 52107, kFAC_aisver = 52108, kFAC_imonum = 52109, kFAC_calsig = 52110,   kFAC_shiptp = 52111, kFAC_epfdtp = 52112, kFAC_etamon = 52113, kFAC_etaday = 52114,   kFAC_etahrs = 52115, kFAC_etamin = 52116, kFAC_dest = 52117, kFAC_usedte = 52118,   kFAC_altitu = 52119, kFAC_altsen = 52120, kFAC_assmod = 52121, kFAC_bunitf = 52122,   kFAC_bdispf = 52123, kFAC_bdscfl = 52124, kFAC_bbandf = 52125, kFAC_bmsgfl = 52126,   kFAC_atontp = 52127, kFAC_offpos = 52128, kFAC_atonst = 52129, kFAC_viratn = 52130,   kFAC_atonex = 52131, kFAC_rcnsts = 52132, kFAC_ligsts = 52133, kFAC_hthsts = 52134,   kFAC_repcnt = 52135, kFAC_vtstgt = 52136, kFAC_artlat = 52137, kFAC_artlon = 52138,   kFAC_plathi = 52139, kFAC_crsrel = 52140, kFAC_spdrel = 52141, kFAC_ctwrel = 52142,   kFAC_stwrel = 52143, kFAC_pageid = 52144, kFAC_mobmon = 52145, kFAC_mobdir = 52146,   kFAC_msgtxt = 52147, kFAC_msgtim = 52148, kFAC_mrktyp = 52150, kFAC_mrkdst = 52151,   kFAC_msglid = 52160, kFAC_clrtim = 52200, kFAC_prtnam = 52201, kFAC_sstnam = 52210,   kFAC_sigsta = 52211, kFAC_sigser = 52212, kFAC_nxtsgh = 52213, kFAC_nxtsgm = 52214,   kFAC_nxtsig = 52215, kFAC_berthl = 52220, kFAC_watdep = 52221, kFAC_moopos = 52222,   kFAC_berdat = 52223, kFAC_servav = 52224, kFAC_agenav = 52225, kFAC_bunkav = 52226,   kFAC_chanav = 52227, kFAC_stevav = 52228, kFAC_elecav = 52229, kFAC_potwav = 52230,   kFAC_custav = 52231, kFAC_cartav = 52232, kFAC_cranav = 52233, kFAC_liftav = 52234,   kFAC_medcav = 52235, kFAC_navrav = 52236, kFAC_provav = 52237, kFAC_shprav = 52238,   kFAC_survav = 52239, kFAC_stemav = 52240, kFAC_tugsav = 52241, kFAC_wassav = 52242,   kFAC_waslav = 52243, kFAC_washav = 52244, kFAC_blexav = 52245, kFAC_addsav = 52246,   kFAC_brthnm = 52247, kFAC_reptyp = 52250, kFAC_reptsp = 52251, kFAC_siteid = 52252,   kFAC_senalt = 52253, kFAC_senown = 52254, kFAC_dtmout = 52255, kFAC_sennam = 52256,   kFAC_airdrg = 52260, kFAC_airgap = 52261, kFAC_airgpt = 52262, kFAC_fairgp = 52263,   kFAC_fargpt = 52264, kFAC_airtmp = 52270, kFAC_tddesc = 52271, kFAC_precip = 52272,   kFAC_horvis = 52273, kFAC_dewpnt = 52274, kFAC_dddesc = 52275, kFAC_airprs = 52276,   kFAC_airprt = 52277, kFAC_addesc = 52278, kFAC_salint = 52279, kFAC_wattmp = 52280,   kFAC_conduc = 52281, kFAC_watprs = 52282, kFAC_saltyp = 52283, kFAC_datdes = 52284,   kFAC_swlhgt = 52290, kFAC_swlper = 52291, kFAC_swldir = 52292, kFAC_seastt = 52293,   kFAC_swsdes = 52294, kFAC_wattmd = 52295, kFAC_wtsdes = 52296, kFAC_wavhgt = 52297,   kFAC_wavper = 52298, kFAC_wavdir = 52299, kFAC_wvsdes = 52300, kFAC_cur1br = 52310,   kFAC_cur1ds = 52311, kFAC_cur1sp = 52312, kFAC_cur1dr = 52313, kFAC_cur1ml = 52314,   kFAC_cur2br = 52315, kFAC_cur2ds = 52316, kFAC_cur2sp = 52317, kFAC_cur2dr = 52318,   kFAC_cur2ml = 52319, kFAC_cur1no = 52320, kFAC_cur1ea = 52321, kFAC_cur1up = 52322,   kFAC_cur2no = 52323, kFAC_cur2ea = 52324, kFAC_cur2up = 52325, kFAC_cur3sp = 52330,   kFAC_cur3dr = 52331, kFAC_cur3ml = 52332, kFAC_bg1dtm = 52334, kFAC_ed1dtm = 52335,   kFAC_bg2dtm = 52336, kFAC_ed2dtm = 52337, kFAC_bg3dtm = 52338, kFAC_ed3dtm = 52339,   kFAC_watlvt = 52340, kFAC_watlvl = 52341, kFAC_watltr = 52342, kFAC_vertrd = 52343,   kFAC_fwtlvt = 52344, kFAC_fwtlvl = 52345, kFAC_fwtltm = 52346, kFAC_fwtlvd = 52347,   kFAC_wndspd = 52350, kFAC_wndgst = 52351, kFAC_wnddir = 52352, kFAC_gstdir = 52353,   kFAC_fwndsp = 52354, kFAC_fwndgt = 52355, kFAC_fwnddr = 52356, kFAC_fwndtm = 52357,   kFAC_fwnddu = 52358, kFAC_metdtm = 52360, kFAC_relhum = 52361, kFAC_horvsm = 52362,   kFAC_srfspd = 52363, kFAC_srfdir = 52364, kFAC_icestt = 52365, kFAC_sndcls = 52370,   kFAC_rttype = 52371, kFAC_rtstrt = 52372, kFAC_rtdrtn = 52373, kFAC_ntdscr = 52380,   kFAC_ntstrt = 52381, kFAC_ntdrtn = 52382, kFAC_nttext = 52383, kFAC_geoloc = 52390,   kFAC_prwthr = 52391, kFAC_txtdsc = 52395, kFAC_visibl = 52400, kFAC_shptyp = 52401,   kFAC_dshshp = 52402, kFAC_redclr = 52403, kFAC_tblink = 52404, kFAC_cross = 52405,   kFAC_cblink = 52406, kFAC_select = 52407, kFAC_assctd = 52408, kFAC_ashptp = 52409,   kFAC_bgsymb = 52410, kFAC_manact = 52411, kFAC_dngalm_activated_by = 52412, kFAC_hasmsg = 52413,   kFAC_asmlyr = 52414, kFAC_ashptp2 = 52415, kFAC_seltyp = 52416, kFAC_privat = 52420,   kFAC_user = 52450, kFAC_nogolcdat = 52451, kFAC_sog_active = 52452, kFAC_cog_active = 52453,   kFAC_hdg_active = 52454, kFAC_stw_active = 52455, kFAC_sounding_active = 52456, kFAC_bcr = 52457,   kFAC_bct = 52458, kFAC_ownship_outside_anchor_circle = 52459, kFAC_heading_out_of_range = 52460 }
	Reserved attribute class codes for any of vessel feature attributes. More...
enum	FAV_catpst { kFAV_catpst_primary = 1, kFAV_catpst_secondary = 2 }
	Available values for kFAC_catpst attribute. More...
enum	PosFixTechnique {   kPosFixTechnique_None = 0, kPosFixTechnique_DR = 1, kPosFixTechnique_EP = 2, kPosFixTechnique_RunningFix = 3,   kPosFixTechnique_Fix = 4 }
	Position fixing technique (sorting for reliability, from worst to best). More...
enum	FixAdvice { kFixAdvice_Unknown, kFixAdvice_DontAccept, kFixAdvice_Repeat, kFixAdvice_Accept }
	Position fix advice. More...

Variables
static const TargetFOID	kUnknownTargetFOID = 0ULL
	Unknown target FOID (AIS/Radar/Sonar targets)
static const SDK_VESSELS_BEGIN_NAMESPACE char	kVesselsCatalog_DatasetPropertiesKey [] = "dataset_properties"
	Dataset properties key.
static const char	kVesselsCatalog_PortrayalParametersKey []
	Portrayal parameters key.
static const char	kVesselsCatalog_Name [] = "name"
	Name.
static const char	kVesselsCatalog_Code [] = "code"
	Code.
static const char	kVesselsCatalog_DefaultValue [] = "default_value"
	Default value.
static const char	kVesselsCatalog_ListedValues [] = "listed_values"
	Listed values.

Detailed Description

Vessels library.

Enumeration Type Documentation

VesselDatasetProperty

enum VesselDatasetProperty

Vessel's dataset properties (Extension of DatasetProperty enum)

Enumerator
kDSP_VesselDatasetPropery_First	Vessel dataset property.
kDSP_PastTrackSizeToStoreSec	Time period for which the past track is stored (SDKUInt32, in seconds)
kDSP_dims_a	From CCRP to Bow.
kDSP_dims_b	From CCRP to Stern.
kDSP_dims_c	From CCRP to Port.
kDSP_dims_d	From CCRP to Starboard.
kDSP_maxhgt	Max height in meters.
kDSP_drfmax	Maximum draft in meters.
kDSP_drfcur	Current draft in meters.
kDSP_turstb	Turning radius in starboard direction.
kDSP_turprt	Turning radius in port direction.
kDSP_devstb	Deviation in starboard direction.
kDSP_devprt	Deviation in port direction.
kDSP_ecospd	Economical speed in knots.
kDSP_usecog	Use COG if HDG unavailable.
kDSP_DangerDCPA_NM	Danger CPA value for vessels (double, in NM)
kDSP_DangerTCPA_Sec	Danger TCPA value for vessels (SDKUInt32, in seconds)
kDSP_VisibilityDistance_NM	Visibility distance value for vessels (double, in NM)
kDSP_ActivationDistance_NM	Activation distance value for vessels (double, in NM)
kDSP_DangerDistance_NM	Danger distance value for vessels (double, in NM)
kDSP_LostTargetAlertDistance_NM	Lost target alert distance value for vessels (double, in NM) If distance to target > lost alert distance - New Lost alert will be auto acknowledged If distance to target <= lost alert distance - New Lost alert will be not acknowledged If lost alert distance is not defined - all of lost alarms will be auto-acknowledged
kDSP_RemoveVesselTimeout_Sec	Remove timeout for vessels (SDKUInt32, in seconds)
kDSP_LostTimeout_SARAircraft_Sec	Lost timeout for AIS SAR-Aircraft (SDKUInt32, in seconds)
kDSP_LostTimeout_AtoN_Sec	Lost timeout for AtoN (SDKUInt32, in seconds)
kDSP_LostTimeout_BaseStation_Sec	Lost timeout for AIS Base Station (SDKUInt32, in seconds)
kDSP_LostTimeout_AIS_SART_Sec	Lost timeout for AIS-SART (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassA_AtAnchor_LessThan_3_Knots_Sec	Lost timeout for Class A ship at anchor or moored and not moving faster than 3 knots (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassA_AtAnchor_MoreThan_3_Knots_Sec	Lost timeout for Class A ship at anchor or moored and moving faster than 3 knots (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassA_0_14_Knots_Sec	Lost timeout for Class A ship 0-14 knots (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassA_0_14_Knots_ChangingCourse_Sec	Lost timeout for Class A ship 0-14 knots and changing course (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassA_14_23_Knots_Sec	Lost timeout for Class A ship 14-23 knots (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassA_14_23_Knots_ChangingCourse_Sec	Lost timeout for Class A ship 14-23 knots and changing course (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassA_MoreThan_23_Knots_Sec	Lost timeout for Class A ship more than 23 knots (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassA_MoreThan_23_Knots_ChangingCourse_Sec	Lost timeout for Class A ship more than 23 knots and changing course (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassB_SO_LessThan_2_Knots_Sec	Lost timeout for Class B "SO" shipborne mobile equipment not moving faster than 2 knots (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassB_SO_2_14_Knots_Sec	Lost timeout for Class B "SO" shipborne mobile equipment moving 2-14 knots (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassB_SO_14_23_Knots_Sec	Lost timeout for Class B "SO" shipborne mobile equipment moving 14-23 knots (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassB_SO_MoreThan_23_Knots_Sec	Lost timeout for Class B "SO" shipborne mobile equipment moving faster than 23 knots (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassB_CS_LessThan_2_Knots_Sec	Lost timeout for Class B "CS" shipborne mobile equipment not moving faster than 2 knots (SDKUInt32, in seconds)
kDSP_LostTimeout_ClassB_CS_MoreThan_2_Knots_Sec	Lost timeout for Class B "CS" shipborne mobile equipment moving faster than 2 knots (SDKUInt32, in seconds)
kDSP_LostTimeout_Radar_Sonar_Targets_Sec	Lost timeout for Radar/Sonar targets (SDKUInt32, in seconds)
kDSP_TargetNamesDatabasePath	Path to database with target names.
kDSP_DontCalculateTCPA_DCPA	Don't calculate CPA/TCPA for targets (bool)
kDSP_AlwaysShowRealAtoNPurpose	Always show real AtoN purpose mark (topmark) (bool)
kDSP_OwnShipMMSI	Own ship MMSI number (SDKUInt32)
kDSP_OwnShip_Name	Own ship name.
kDSP_OwnShip_IMONumber	Own ship IMO number.
kDSP_OwnShip_CallSign	Own ship call sign.
kDSP_Radar1_Offset_X	Radar 1 offset by X axis.
kDSP_Radar1_Offset_Y	Radar 1 offset by Y axis.
kDSP_Radar2_Offset_X	Radar 2 offset by X axis.
kDSP_Radar2_Offset_Y	Radar 2 offset by Y axis.
kDSP_Radar3_Offset_X	Radar 3 offset by X axis.
kDSP_Radar3_Offset_Y	Radar 3 offset by Y axis.
kDSP_maxspd	Own ship max speed.
kDSP_RadarSupportsTargetsAssociation	Radar supports targets association (bool)
kDSP_AtoNsFromEdition1	AtoNs should be in accordance with IEC 62288 Ed.1 (bool)
kDSP_AISMessaging_ECDIS_Talker_ID	AIS MKD.
kDSP_TargetsAssociationEnabled	Targets association enabled (bool)
kDSP_VisibilityRange_Enabled	Target visibility range is enabled (bool)
kDSP_StrictUseOfIEC62288	Strict use of IEC 62288 (bool)
kDSP_DisplayAssociatedAISOnARPAPosition	Display associated AIS targets on ARPA position.
kDSP_Vessel_Drawing	Vessel drawing.
kDSP_VoyageDraught	Voyage planned maximum draught.
kDSP_Anchor1_Offset_X	Anchor 1 offset by X axis.
kDSP_Anchor1_Offset_Y	Anchor 1 offset by Y axis.
kDSP_LostTargetAlert_On	Lost target alert on.
kDSP_CPA_TCPA_Alert_On	CPA/TCPA alert on.
kDSP_AutoActivation_On	Target auto-activation on.
kDSP_PastTrack_MemoryLimit_MB	Past track memory limit, MB 0 - Disable limit
kDSP_DangerDistance_Alert_On	Dangerous distance alert on.
kDSP_LostTimeout_LongRangeVessel_Sec	Lost timeout for Long Range Vessel (SDKUInt32, in seconds)
kDSP_LostTimeout_SyntheticTarget_Sec	Lost timeout for Synthetic Target (SDKUInt32, in seconds)
kDSP_MaxCapacity_RegularTarget	Max Capacity for Regular Target (SDKUInt32)
kDSP_MaxCapacity_SyntheticTarget	Max Capacity for Synthetic Target (SDKUInt32)
kDSP_MaxCapacity_AsmTarget	Max Capacity for ASM Target (SDKUInt32) Vessel particulars
kDSP_Trim_Positive_Aft	Trim, positive means to aft.
kDSP_Displacement	Displacement m3.
kDSP_LCG_Forward_HalfLpp	LCG - Longitudinal Center of Gravity forward offset from half of Length between Perpendiculars
kDSP_TPC	TPC - Tonnes per centimeter.
kDSP_Block_Coefficient	Block coefficient.
kDSP_UKC_Limit_Ocean	Minimal UKC in meters (ocean)
kDSP_UKC_Limit_Relative_Ocean	Minimal UKC relative (ocean)
kDSP_UKC_Limit_Use_Relative_Ocean	Use minimal UKC relative (ocean)
kDSP_UKC_Calculation_Limit_Ocean	UKC Calculation Limit (ocean)
kDSP_UKC_Calculation_Limit_Relative_Ocean	UKC Calculation Limit Relative to draught (ocean)
kDSP_UKC_Calculation_Limit_Use_Relative_Ocean	Use Relative UKC Calculation Limit (ocean)
kDSP_UKC_Limit_Coastal	Minimal UKC in meters (coastal)
kDSP_UKC_Limit_Relative_Coastal	Minimal UKC relative (coastal)
kDSP_UKC_Limit_Use_Relative_Coastal	Use minimal UKC relative (coastal)
kDSP_UKC_Calculation_Limit_Coastal	UKC Calculation Limit (coastal)
kDSP_UKC_Calculation_Limit_Relative_Coastal	UKC Calculation Limit Relative to draught (coastal)
kDSP_UKC_Calculation_Limit_Use_Relative_Coastal	Use Relative UKC Calculation Limit (coastal)
kDSP_UKC_Limit_Pilotage	Minimal UKC in meters (pilotage)
kDSP_UKC_Limit_Relative_Pilotage	Minimal UKC relative (pilotage)
kDSP_UKC_Limit_Use_Relative_Pilotage	Use minimal UKC relative (pilotage)
kDSP_UKC_Calculation_Limit_Pilotage	UKC Calculation Limit (pilotage)
kDSP_UKC_Calculation_Limit_Relative_Pilotage	UKC Calculation Limit Relative to draught (pilotage)
kDSP_UKC_Calculation_Limit_Use_Relative_Pilotage	Use Relative UKC Calculation Limit (pilotage)
kDSP_UKC_Limit_Moored	Minimal UKC in meters (moored)
kDSP_UKC_Limit_Relative_Moored	Minimal UKC relative (moored)
kDSP_UKC_Limit_Use_Relative_Moored	Use minimal UKC relative (moored)
kDSP_UKC_Calculation_Limit_Moored	UKC Calculation Limit (moored)
kDSP_UKC_Calculation_Limit_Relative_Moored	UKC Calculation Limit Relative to draught (moored)
kDSP_UKC_Calculation_Limit_Use_Relative_Moored	Use Relative UKC Calculation Limit (moored)
kDSP_meandraught	Mean draught.
kDSP_minspd	Own ship min speed.
kDSP_OwnShip_Owner	Own ship Owner.
kDSP_LPP	Length of a ship between perpendiculars.
kDSP_UKC_Limit_PassageType5	Minimal UKC in meters (Passage type 5)
kDSP_UKC_Limit_Relative_PassageType5	Minimal UKC relative (Passage type 5)
kDSP_UKC_Limit_Use_Relative_PassageType5	Use minimal UKC relative (Passage type 5)
kDSP_UKC_Calculation_Limit_PassageType5	UKC Calculation Limit (Passage type 5)
kDSP_UKC_Calculation_Limit_Relative_PassageType5	UKC Calculation Limit Relative to draught (Passage type 5)
kDSP_UKC_Calculation_Limit_Use_Relative_PassageType5	Use Relative UKC Calculation Limit (Passage type 5)

VesselProperty

enum VesselProperty

Vessel's properties.

Enumerator
kVesselProperty_FilterPositionThresholdSec	Turns on/off filtering of the vessel position, 1 sec by default.

FeatureAttributeCode

enum FeatureAttributeCode

Reserved attribute class codes for any of vessel feature attributes.

Enumerator
kFAC_catpst	Category of past track.
kFAC_cogcrs	Course over ground.
kFAC_ctwcrs	Course through water.
kFAC_headng	Heading.
kFAC_inptid	Input identifier.
kFAC_sogspd	Speed over ground.
kFAC_stwspd	Speed through water.
kFAC_sounding	Sounding value.
kFAC_true_or_relative	True or relative value.
kFAC_roturn	Rate of turn.
kFAC_possrc	Position source.
kFAC_cogsrc	Course over ground source.
kFAC_sogsrc	Speed over ground source.
kFAC_hdgsrc	Heading source.
kFAC_stwsrc	Speed through water source.
kFAC_soundingsrc	Sounding source.
kFAC_possrc_type	Position source type.
kFAC_cogsrc_type	Course over ground source type.
kFAC_sogsrc_type	Speed over ground source type.
kFAC_hdgsrc_type	Heading source type.
kFAC_stwsrc_type	Speed through water source type.
kFAC_soundingsrc_type	Sounding source type.
kFAC_cogcrs_is_valid	Course over ground is valid.
kFAC_ctwcrs_is_valid	Course through water is valid.
kFAC_headng_is_valid	Heading is valid.
kFAC_sogspd_is_valid	Speed over ground is valid.
kFAC_stwspd_is_valid	Speed through water is valid.
kFAC_sounding_is_valid	Sounding value is valid.
kFAC_roturn_is_valid	Rate of turn is valid.
kFAC_dims_a	From CCRP to Bow.
kFAC_dims_b	From CCRP to Stern.
kFAC_dims_c	From CCRP to Port.
kFAC_dims_d	From CCRP to Starboard.
kFAC_maxhgt	Maximum height in meters.
kFAC_drfmax	Maximum draft in meters.
kFAC_drfcur	Current draft in meters.
kFAC_turstb	Turning radius in starboard direction.
kFAC_turprt	Turning radius in port direction.
kFAC_ecospd	Economical speed in knots.
kFAC_usecog	Use COG if HDG unavailable.
kFAC_time	NMEA sentence time stamp.
kFAC_ticks	Milliseconds from OS startup, when last NMEA sentence was processed.
kFAC_name	Name.
kFAC_brgtru	True bearing to target from CCRP.
kFAC_brgrel	Relative bearing to target from CCRP.
kFAC_dist	Distance to target from CCRP.
kFAC_ordcpa	Original target CPA, NM, double.
kFAC_ortcpa	Original target TCPA, minutes, double.
kFAC_dcpa	Calculated target CPA, NM, double.
kFAC_tcpa	Calculated target TCPA, minutes, double.
kFAC_devstb	Deviation in starboard direction.
kFAC_devprt	Deviation in port direction.
kFAC_year	Year.
kFAC_month	Month.
kFAC_day	Day.
kFAC_hours	Hours.
kFAC_minute	Minutes.
kFAC_second	Seconds.
kFAC_danger	Danger/Not danger.
kFAC_lost	Lost/Not lost (pos lost)
kFAC_cogcrs_lost	Course over ground lost.
kFAC_ctwcrs_lost	Course through water lost.
kFAC_headng_lost	Heading lost.
kFAC_sogspd_lost	Speed over ground lost.
kFAC_stwspd_lost	Speed through water lost.
kFAC_sounding_lost	Sounding value lost.
kFAC_roturn_lost	Rate of turn lost.
kFAC_LPP	Length between perpendiculars.
kFAC_number	Number.
kFAC_reftgt	Reference target.
kFAC_rtgtnm	Reference target number.
kFAC_prvsta	Previous status.
kFAC_tiksta	Milliseconds from OS startup, when kFAC_cursta attribute was changed.
kFAC_crsori	Original course.
kFAC_crsort	Original course is True flag.
kFAC_spdori	Original speed.
kFAC_spdort	Original speed is True flag.
kFAC_stwmod	Original Course/Speed is through the water flag.
kFAC_acquis	Type of acquisition.
kFAC_tsttgt	Test target flag.
kFAC_assoc	Association number.
kFAC_cursta	Current status.
kFAC_asmmsi	MMSI number of associated AIS target.
kFAC_asfoid	Target FOID of associated AIS target.
kFAC_source	Target source device, one of OwnShipDeviceConfig.
kFAC_srcnam	Target source device name.
kFAC_ttdsta	Current status from TTD.
kFAC_arfoid	Target FOID of associated AIS-ARPA target.
kFAC_mrfoid	FOID of master AIS target.
kFAC_mmsi	MMSI number.
kFAC_aistyp	AIS target type.
kFAC_navsts	Navigational status.
kFAC_posach	Position accuracy is High flag.
kFAC_tstamp	Time stamp.
kFAC_epfs	EPFS state.
kFAC_spmani	Special manoeuvre indicator.
kFAC_usraim	RAIM in use flag.
kFAC_aisver	AIS version indicator.
kFAC_imonum	IMO number.
kFAC_calsig	Call sign.
kFAC_shiptp	Type of Ship and Cargo Type.
kFAC_epfdtp	EPFD type.
kFAC_etamon	ETA Month.
kFAC_etaday	ETA Day.
kFAC_etahrs	ETA Hours.
kFAC_etamin	ETA Minutes.
kFAC_dest	Destination.
kFAC_usedte	DTE in use flag.
kFAC_altitu	Altitude.
kFAC_altsen	Altitude sensor.
kFAC_assmod	Assigned mode flag.
kFAC_bunitf	Vessel class B unit flag.
kFAC_bdispf	Vessel class B display flag.
kFAC_bdscfl	Vessel class B DSC flag.
kFAC_bbandf	Vessel class B band flag.
kFAC_bmsgfl	Vessel class B message 22 flag.
kFAC_atontp	Type of AtoN.
kFAC_offpos	Off-Position indicator.
kFAC_atonst	AtoN status.
kFAC_viratn	Virtual AtoN flag.
kFAC_atonex	Name of AtoN Extension.
kFAC_rcnsts	AToN RACON status.
kFAC_ligsts	AToN Light status.
kFAC_hthsts	AToN Health status.
kFAC_repcnt	Target data repeat count.
kFAC_vtstgt	VTS-generated target.
kFAC_artlat	Associated radar target latitude.
kFAC_artlon	Associated radar target longitude.
kFAC_plathi	Position latency is high flag.
kFAC_crsrel	Calculated relative course (over ground) of target from own ship.
kFAC_spdrel	Calculated relative speed (over ground) of target from own ship.
kFAC_ctwrel	Calculated relative course (through water) of target from own ship.
kFAC_stwrel	Calculated relative speed (through water) of target from own ship.
kFAC_pageid	AToN page id.
kFAC_mobmon	Mobile AToN monitored status.
kFAC_mobdir	Mobile AToN direction status.
kFAC_msgtxt	Last received message text.
kFAC_msgtim	Last received message time.
kFAC_mrktyp	Range mark type.
kFAC_mrkdst	Range mark distance.
kFAC_msglid	Message linkage ID.
kFAC_clrtim	Clearance date/time to enter port.
kFAC_prtnam	Name of port and berth.
kFAC_sstnam	Signal station name.
kFAC_sigsta	Status of signal.
kFAC_sigser	Signal in service.
kFAC_nxtsgh	Time of next signal shift, hours.
kFAC_nxtsgm	Time of next signal shift, minutes.
kFAC_nxtsig	Expected next signal.
kFAC_berthl	Berth length.
kFAC_watdep	Water depth at berth.
kFAC_moopos	Mooring position.
kFAC_berdat	Berth date and time.
kFAC_servav	Services availability.
kFAC_agenav	Agent service availability.
kFAC_bunkav	Bunker/Fuel service availability.
kFAC_chanav	Chandler service availability.
kFAC_stevav	Stevedore service availability.
kFAC_elecav	Electrical service availability.
kFAC_potwav	Potable Water service availability.
kFAC_custav	Customs House service availability.
kFAC_cartav	Cartage service availability.
kFAC_cranav	Crane(s) service availability.
kFAC_liftav	Lift(s) service availability.
kFAC_medcav	Medical Facilities service availability.
kFAC_navrav	Navigation Repair service availability.
kFAC_provav	Provisions service availability.
kFAC_shprav	Ship Repair service availability.
kFAC_survav	Surveyor service availability.
kFAC_stemav	Steam service availability.
kFAC_tugsav	Tugs service availability.
kFAC_wassav	Waste Disposal (Solid) service availability.
kFAC_waslav	Waste Disposal (Liquid) service availability.
kFAC_washav	Waste Disposal (Hazardous) service availability.
kFAC_blexav	Reserved Ballast Exchange service availability.
kFAC_addsav	Additional Services Are Also Available.
kFAC_brthnm	Name of Berth.
kFAC_reptyp	Report type.
kFAC_reptsp	Report time stamp.
kFAC_siteid	Sensor site ID.
kFAC_senalt	Sensor altitude.
kFAC_senown	Sensor owner.
kFAC_dtmout	Sensor data timeout.
kFAC_sennam	Sensor station name.
kFAC_airdrg	Air draught.
kFAC_airgap	Air gap.
kFAC_airgpt	Air gap trend.
kFAC_fairgp	Forecast air gap.
kFAC_fargpt	Forecast air gap time.
kFAC_airtmp	Air temperature.
kFAC_tddesc	Air temperature sensor data description.
kFAC_precip	Precipitation.
kFAC_horvis	Horizontal visibility.
kFAC_dewpnt	Dew point.
kFAC_dddesc	Dew point sensor data description.
kFAC_airprs	Air pressure.
kFAC_airprt	Air pressure trend.
kFAC_addesc	Air pressure sensor data description.
kFAC_salint	Salinity.
kFAC_wattmp	Water temperature.
kFAC_conduc	Water conductivity.
kFAC_watprs	Water pressure.
kFAC_saltyp	Salinity type.
kFAC_datdes	Sensor data description.
kFAC_swlhgt	Swell height.
kFAC_swlper	Swell period.
kFAC_swldir	Swell direction.
kFAC_seastt	Sea state.
kFAC_swsdes	Swell sensor data description.
kFAC_wattmd	Water temperature depth.
kFAC_wtsdes	Water temperature sensor data description.
kFAC_wavhgt	Significant wave height.
kFAC_wavper	Wave period.
kFAC_wavdir	Wave direction.
kFAC_wvsdes	Wave sensor data description.
kFAC_cur1br	Current reading 1 bearing.
kFAC_cur1ds	Current reading 1 distance.
kFAC_cur1sp	Current 1 speed.
kFAC_cur1dr	Current 1 direction.
kFAC_cur1ml	Current 1 measuring level.
kFAC_cur2br	Current reading 2 bearing.
kFAC_cur2ds	Current reading 2 distance.
kFAC_cur2sp	Current 2 speed.
kFAC_cur2dr	Current 2 direction.
kFAC_cur2ml	Current 2 measuring level.
kFAC_cur1no	Current vector component north (u) 1.
kFAC_cur1ea	Current vector component east (v) 1.
kFAC_cur1up	Current vector component up (z) 1.
kFAC_cur2no	Current vector component north (u) 2.
kFAC_cur2ea	Current vector component east (v) 2.
kFAC_cur2up	Current vector component up (z) 2.
kFAC_cur3sp	Current 3 speed.
kFAC_cur3dr	Current 3 direction.
kFAC_cur3ml	Current 3 measuring level.
kFAC_bg1dtm	Predicted 1 from time stamp.
kFAC_ed1dtm	Predicted 1 to time stamp.
kFAC_bg2dtm	Predicted 2 from time stamp.
kFAC_ed2dtm	Predicted 2 to time stamp.
kFAC_bg3dtm	Predicted 3 from time stamp.
kFAC_ed3dtm	Predicted 3 to time stamp.
kFAC_watlvt	Water level type.
kFAC_watlvl	Water level.
kFAC_watltr	Water level trend.
kFAC_vertrd	Vertical reference datum.
kFAC_fwtlvt	Forecast water level type.
kFAC_fwtlvl	Forecast water level.
kFAC_fwtltm	Forecast water level time.
kFAC_fwtlvd	Forecast water level duration.
kFAC_wndspd	Average wind speed.
kFAC_wndgst	Wind gust.
kFAC_wnddir	Wind direction.
kFAC_gstdir	Wind gust direction.
kFAC_fwndsp	Forecast wind speed.
kFAC_fwndgt	Forecast wind gust.
kFAC_fwnddr	Forecast wind direction.
kFAC_fwndtm	Forecast wind time.
kFAC_fwnddu	Forecast wind duration.
kFAC_metdtm	Meteorological report time stamp.
kFAC_relhum	Relative humidity.
kFAC_horvsm	Horizontal visibility more than flag.
kFAC_srfspd	Surface current speed.
kFAC_srfdir	Surface current direction.
kFAC_icestt	Ice state.
kFAC_sndcls	Sender classification.
kFAC_rttype	Route type.
kFAC_rtstrt	Route start date.
kFAC_rtdrtn	Route information duration.
kFAC_ntdscr	Notice description.
kFAC_ntstrt	Notice start date.
kFAC_ntdrtn	Notice duration.
kFAC_nttext	Notice text.
kFAC_geoloc	Geographic Location.
kFAC_prwthr	Present Weather.
kFAC_txtdsc	Text description.
kFAC_visibl	Vessel shape is visible flag.
kFAC_shptyp	Vessel shape type.
kFAC_dshshp	Vessel shape is dashed flag.
kFAC_redclr	Vessel is red colored flag.
kFAC_tblink	Vessel shape is blinking flag.
kFAC_cross	Cross should be displayed flag.
kFAC_cblink	Vessel's cross is blinking flag.
kFAC_select	Vessel is selected flag.
kFAC_assctd	Vessel is associated flag.
kFAC_ashptp	AtoN shape type.
kFAC_bgsymb	Big symbol.
kFAC_manact	Target is manually activated.
kFAC_dngalm_activated_by	Danger alarm is activated by, see FAV_dngalm_activated_by.
kFAC_hasmsg	Has unread message or call.
kFAC_asmlyr	ASM layer.
kFAC_ashptp2	AtoN 2nd shape type.
kFAC_seltyp	Vessel Select type.
kFAC_privat	Private attributes, which should not be changed externally.
kFAC_user	User-defined attributes.
kFAC_nogolcdat	No-Go line's creation date and time.
kFAC_sog_active	Is sog sensor active.
kFAC_cog_active	Is cog sensor active.
kFAC_hdg_active	Is heading sensor active.
kFAC_stw_active	Is stw sensor active.
kFAC_sounding_active	Is sounding sensor active.
kFAC_bcr	Calculated target BCR, NM, double.
kFAC_bct	Calculated target BCT, minutes, double.
kFAC_ownship_outside_anchor_circle	Ownship is outside the swing circle of the anchor watch, bool.
kFAC_heading_out_of_range	Ownship heading is out of range of the bearing watch, bool.

FAV_catpst

enum FAV_catpst

Available values for kFAC_catpst attribute.

Enumerator
kFAV_catpst_primary	Primary.
kFAV_catpst_secondary	Secondary.

PosFixTechnique

enum PosFixTechnique

Position fixing technique (sorting for reliability, from worst to best).

Enumerator
kPosFixTechnique_None	Position fixing impossible.
kPosFixTechnique_DR	DR position available.
kPosFixTechnique_EP	Estimated position available.
kPosFixTechnique_RunningFix	Running fix available.
kPosFixTechnique_Fix	Fix available.

FixAdvice

enum FixAdvice

Position fix advice.

Enumerator
kFixAdvice_Unknown	not known what to do
kFixAdvice_DontAccept	Do not accept observed position.
kFixAdvice_Repeat	Repeat observation with other measurements.
kFixAdvice_Accept	Accept observed position.