Radar targets

Radar/Sonar target components. More...

Modules
	Radar/Sonar targets GB Class ID
	Radar/Sonar target Class IDs.

Data Structures
class	IUpdatedRadarSonarTargets
	Set of updated radar/sonar target's. More...
class	IRadarSonarTargetsWorkspace
	Radar/Sonar targets workspace. More...
class	IRadarSonarTargetsDataset
	Radar/Sonar targets dataset. More...
class	IRadarSonarTarget
	Single Radar/Sonar target. More...
class	IRadarSonarTargetPastTrack
	Single Radar/Sonar target past track. More...
class	IRadarSonarTargetsEnum
	Radar/Sonar targets enumerator. More...
class	IRadarSonarTargetsCollection
	Radar/Sonar targets collection. More...
class	IRadarSonarTargetsManager
	An interface for high-level managing the targets over the database Allows to controls the target's portraying attributes, by checking if target dangerous or lost and setting the proper attributes values The workspace will do nothing, expect calling appropriate method of target's manager. Only target manager should set appropriate target attributes in case of event. More...

Typedefs
typedef TargetFOID	RadarSonarTargetFOID
	Radar/Sonar target FOID definition.

Enumerations
enum	RadarSonarTargetAlarmType {   kRadarSonarTargetAlarm_None = kTargetAlarm_None, kRadarSonarTargetAlarm_Dangerous = kTargetAlarm_Dangerous, kRadarSonarTargetAlarm_Acquisition = kTargetAlarm_Acquisition, kRadarSonarTargetAlarm_Lost = kTargetAlarm_Lost,   kRadarSonarTargetAlarm_All = kTargetAlarm_All }
	All of available Radar/Sonar target's alarms. More...
enum	RadarSonarTargetsDatasetProperty {   kRSDSP_PastTrackSizeToStoreSec = kDSP_PastTrackSizeToStoreSec, kRSDSP_DangerDCPA_NM = kDSP_DangerDCPA_NM, kRSDSP_DangerTCPA_Sec = kDSP_DangerTCPA_Sec, kRSDSP_DangerDistance_NM = kDSP_DangerDistance_NM,   kRSDSP_LostTargetAlertDistance_NM = kDSP_LostTargetAlertDistance_NM, kRSDSP_RemoveVesselTimeout_Sec = kDSP_RemoveVesselTimeout_Sec, kRSDSP_LostTimeout_Radar_Sonar_Targets_Sec = kDSP_LostTimeout_Radar_Sonar_Targets_Sec, kRSDSP_DontCalculateTCPA_DCPA = kDSP_DontCalculateTCPA_DCPA,   kRSDSP_RadarSupportsTargetsAssociation = kDSP_RadarSupportsTargetsAssociation, kRSDSP_TargetsAssociationEnabled = kDSP_TargetsAssociationEnabled, kRSDSP_StrictUseOfIEC62288 = kDSP_StrictUseOfIEC62288, kRSDSP_LostTargetAlert_On = kDSP_LostTargetAlert_On,   kRSDSP_CPA_TCPA_Alert_On = kDSP_CPA_TCPA_Alert_On }
	Radar/Sonar targets dataset properties (Extension of DatasetProperty enum) More...
enum	RadarSonarFeatureClassCode { kRSFCC_target = kFCC_vessel, kRSFCC_rpstrk = kFCC_rpstrk }
	Radar/Sonar target feature class codes. More...
enum	RadarSonarFeatureAttributeCode {   kRSFAC_number = kFAC_number, kRSFAC_source = kFAC_source, kRSFAC_srcnam = kFAC_srcnam, kRSFAC_name = kFAC_name,   kRSFAC_reftgt = kFAC_reftgt, kRSFAC_hdgtru = kFAC_headng, kRSFAC_crsori = kFAC_crsori, kRSFAC_crsort = kFAC_crsort,   kRSFAC_spdori = kFAC_spdori, kRSFAC_spdort = kFAC_spdort, kRSFAC_stwmod = kFAC_stwmod, kRSFAC_ordcpa = kFAC_orcpa ,   kRSFAC_ortcpa = kFAC_ortcpa, kRSFAC_acquis = kFAC_acquis, kRSFAC_tsttgt = kFAC_tsttgt, kRSFAC_assoc = kFAC_assoc,   kRSFAC_asmmsi = kFAC_asmmsi, kRSFAC_asfoid = kFAC_asfoid, kRSFAC_arfoid = kFAC_arfoid, kRSFAC_mrfoid = kFAC_mrfoid,   kRSFAC_time = kFAC_time, kRSFAC_ticks = kFAC_ticks, kRSFAC_danger = kFAC_danger, kRSFAC_lost = kFAC_lost,   kRSFAC_shptyp = kFAC_shptyp, kRSFAC_brgtru = kFAC_brgtru, kRSFAC_brgrel = kFAC_brgrel, kRSFAC_dist = kFAC_dist,   kRSFAC_dcpa = kFAC_cpa , kRSFAC_tcpa = kFAC_tcpa, kRSFAC_rtgtnm = kFAC_rtgtnm, kRSFAC_cogtru = kFAC_cogcrs,   kRSFAC_sogtru = kFAC_sogspd, kRSFAC_crsrel = kFAC_crsrel, kRSFAC_spdrel = kFAC_spdrel, kRSFAC_ctwtru = kFAC_ctwcrs,   kRSFAC_stwtru = kFAC_stwspd, kRSFAC_ctwrel = kFAC_ctwrel, kRSFAC_stwrel = kFAC_stwrel, kRSFAC_cursta = kFAC_cursta,   kRSFAC_prvsta = kFAC_prvsta, kRSFAC_tiksta = kFAC_tiksta, kRSFAC_visibl = kFAC_visibl, kRSFAC_dshshp = kFAC_dshshp,   kRSFAC_redclr = kFAC_redclr, kRSFAC_tblink = kFAC_tblink, kRSFAC_cross = kFAC_cross, kRSFAC_cblink = kFAC_cblink,   kRSFAC_select = kFAC_select, kRSFAC_bgsymb = kFAC_bgsymb, kRSFAC_privat = kFAC_privat, kRSFAC_ttdsta = kFAC_ttdsta,   kRSFAC_user = kFAC_user }
	Radar/Sonar target feature attribute class codes. kSDKAnyType_Empty value means, that given attribute value is absent. More...
enum	RadarSonarPastTrackFeatureAttributeCode {   kPTFAC_visibl = kRSFAC_visibl, kPTFAC_redclr = kRSFAC_redclr, kPTFAC_asmmsi = kRSFAC_asmmsi, kPTFAC_asfoid = kRSFAC_asfoid,   kPTFAC_dist = kRSFAC_dist, kPTFAC_sogtru = kRSFAC_sogtru, kPTFAC_user = kFAC_user }
	Radar/Sonar target past track feature attribute class codes kSDKAnyType_Empty value means, that given attribute value is absent. More...
enum	RSFAV_status { kRSFAV_status_lost = 1, kRSFAV_status_query = 2, kRSFAV_status_tracking = 3 }
	Available radar/sonar target statuses. More...
enum	RSFAV_ttdsta { ,   kRSFAV_ttdsta_acquiring_target = 1, kRSFAV_ttdsta_lost_target = 2, kRSFAV_ttdsta_established_tracking_no_alarm = 4, kRSFAV_ttdsta_established_tracking_with_alarm = 6,   kRSFAV_ttdsta_established_tracking_acknowledged_alarm = 7 }
	Available TTD statuses. More...
enum	RSFAV_acquis { kRSFAV_acquis_automatic = 1, kRSFAV_acquis_manual = 2, kRSFAV_acquis_reported = 3 }
	Available radar/sonar target types of acquisition More...
enum	PortrayalParameterRadarSonarTargetsEnum {   kPP_RadarSonarTarget_VelocityVectorOn = sdk::vis::kPortrayalParameters_ARPA, kPP_RadarSonarTarget_VelocityVectorLengthSec, kPP_RadarSonarTarget_VelocityVectorTimeIncrementsOn, kPP_RadarSonarTarget_VelocityVectorTimeIncrementsStepSec,   kPP_RadarSonarTarget_PastTrackOn, kPP_RadarSonarTarget_PastTrackIntervalSec, kPP_RadarSonarTarget_PastTrackLengthSec, kPP_RadarSonarTarget_ShowAssociatedTargetsAsAIS,   kPP_RadarSonarTarget_VisibilityByRange_Enabled, kPP_RadarSonarTarget_VisibilityByRange_NM, kPP_RadarSonarTarget_VisibilityBySpeed_Enabled, kPP_RadarSonarTarget_VisibilityBySpeed_Kn,   kPP_RadarSonarTarget_ShowRelativeVelocityVector, kPP_RadarSonarTarget_ShowSeaStabilizedVectors, kPP_RadarSonarTarget_VisibilityBySource_Enabled, kPP_RadarSonarTarget_VisibilityBySource_RADAR1,   kPP_RadarSonarTarget_VisibilityBySource_RADAR2, kPP_RadarSonarTarget_VisibilityBySource_RADAR3 }
	Radar/Sonar targets portraying environment parameters. More...
enum	RadarSonarTargetsWksPropertiesID
	Set of Radar/Sonar targets workspace properties.
enum	RadarSonarTargetUpdateDescriptionRecord
	Set of update description record IDs, which can be obtained from default target's manager implementation.

Functions
RadarSonarTargetFOID	TargetFoid2PastTrackFoid (const RadarSonarTargetFOID &target_foid)
	Converts Radar/Sonar target FOID to appropriate Radar/Sonar target past track FOID.
RadarSonarTargetFOID	PastTrackFoid2TargetFoid (const RadarSonarTargetFOID &past_track_foid)
	Converts Radar/Sonar target past track FOID to appropriate Radar/Sonar target FOID.

Variables
static const SDK_VESSELS_BEGIN_NAMESPACE DatasetID	kRadarTargetsDatasetID
	Radar targets dataset ID.
static const DatasetID	kSonarTargetsDatasetID
	Sonar targets dataset ID.
static const RadarSonarTargetFOID	kUnknownRadarSonarTargetFOID
	Unknown Radar/Sonar target FOID definition.

Detailed Description

Radar/Sonar target components.

Enumeration Type Documentation

RadarSonarTargetAlarmType

enum RadarSonarTargetAlarmType

All of available Radar/Sonar target's alarms.

Enumerator
kRadarSonarTargetAlarm_None	No target alarms.
kRadarSonarTargetAlarm_Dangerous	Target is dangerous alarm.
kRadarSonarTargetAlarm_Acquisition	Target is in acquisition state alarm.
kRadarSonarTargetAlarm_Lost	Target is lost alarm.
kRadarSonarTargetAlarm_All	All of available alarms.

RadarSonarTargetsDatasetProperty

enum RadarSonarTargetsDatasetProperty

Radar/Sonar targets dataset properties (Extension of DatasetProperty enum)

Enumerator
kRSDSP_PastTrackSizeToStoreSec	Time period for which the past track is stored (SDKUInt32, in seconds)
kRSDSP_DangerDCPA_NM	Danger CPA value for vessels (double, in NM)
kRSDSP_DangerTCPA_Sec	Danger TCPA value for vessels (SDKUInt32, in seconds)
kRSDSP_DangerDistance_NM	Danger distance value for vessels (double, in NM)
kRSDSP_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
kRSDSP_RemoveVesselTimeout_Sec	Remove timeout for targets (SDKUInt32, in seconds)
kRSDSP_LostTimeout_Radar_Sonar_Targets_Sec	Lost timeout for Radar/Sonar targets (SDKUInt32, in seconds)
kRSDSP_DontCalculateTCPA_DCPA	Don't calculate CPA/TCPA for radar/sonar targets (bool)
kRSDSP_RadarSupportsTargetsAssociation	Radar supports targets association (bool)
kRSDSP_TargetsAssociationEnabled	Targets association enabled (bool)
kRSDSP_StrictUseOfIEC62288	Strict use of IEC 62288 (bool)
kRSDSP_LostTargetAlert_On	Lost target alert on (bool)
kRSDSP_CPA_TCPA_Alert_On	CPA/TCPA alert on (bool)

RadarSonarFeatureClassCode

enum RadarSonarFeatureClassCode

Radar/Sonar target feature class codes.

Enumerator
kRSFCC_target	Radar/Sonar target (implements IRadarSonarTarget)
kRSFCC_rpstrk	Radar/Sonar target past track.

RadarSonarFeatureAttributeCode

enum RadarSonarFeatureAttributeCode

Radar/Sonar target feature attribute class codes. kSDKAnyType_Empty value means, that given attribute value is absent.

Enumerator
kRSFAC_number	Target number (kSDKAnyType_Uint32)
kRSFAC_source	Target source device, one of OwnShipDeviceConfig (kSDKAnyType_Uint32)
kRSFAC_srcnam	Target source device name (kSDKAnyType_SDKStringPtr)
kRSFAC_name	Target name (kSDKAnyType_SDKStringPtr)
kRSFAC_reftgt	Reference radar/sonar target (kSDKAnyType_Bool)
kRSFAC_hdgtru	Target HDG True (kSDKAnyType_Double)
kRSFAC_crsori	Target original course (kSDKAnyType_Double)
kRSFAC_crsort	Target original course is True flag (kSDKAnyType_Bool)
kRSFAC_spdori	Target original speed (kSDKAnyType_Double)
kRSFAC_spdort	Target original speed is True flag (kSDKAnyType_Bool)
kRSFAC_stwmod	Original Course/Speed is through the water flag (kSDKAnyType_Bool)
kRSFAC_ordcpa	Original target CPA (kSDKAnyType_Double)
kRSFAC_ortcpa	Original target TCPA (kSDKAnyType_Double)
kRSFAC_acquis	Target type of acquisition, one of RSFAV_acquis (kSDKAnyType_Uint32)
kRSFAC_tsttgt	Test target flag (kSDKAnyType_Bool)
kRSFAC_assoc	Association number (kSDKAnyType_Uint32)
kRSFAC_asmmsi	MMSI number of associated AIS target (kSDKAnyType_Uint32)
kRSFAC_asfoid	Target FOID of associated AIS target (kSDKAnyType_Uint64)
kRSFAC_arfoid	Target FOID of associated AIS-ARPA target (kSDKAnyType_Uint64)
kRSFAC_mrfoid	Master AIS target FOID (kSDKAnyType_Uint64)
kRSFAC_time	NMEA sentence time stamp (kSDKAnyType_SDKTime)
kRSFAC_ticks	Milliseconds from OS startup, when last NMEA sentence was processed (kSDKAnyType_Int64)
kRSFAC_danger	Target is danger (kSDKAnyType_Bool)
kRSFAC_lost	Target is lost (kSDKAnyType_Bool)
kRSFAC_shptyp	Target shape type, one of AISFAV_shptyp (kSDKAnyType_Uint32)
kRSFAC_brgtru	True bearing to target from CCRP (kSDKAnyType_Double)
kRSFAC_brgrel	Relative bearing to target from CCRP (kSDKAnyType_Double)
kRSFAC_dist	Distance to target from CCRP (kSDKAnyType_Double)
kRSFAC_dcpa	Calculated target CPA (kSDKAnyType_Double)
kRSFAC_tcpa	Calculated target TCPA, minutes (kSDKAnyType_Double)
kRSFAC_rtgtnm	Reference target number (kSDKAnyType_Uint32)
kRSFAC_cogtru	Calculated (or original) COG True (kSDKAnyType_Double)
kRSFAC_sogtru	Calculated (or original) SOG True (kSDKAnyType_Double)
kRSFAC_crsrel	Calculated (or original) COG Relative (kSDKAnyType_Double)
kRSFAC_spdrel	Calculated (or original) SOG Relative (kSDKAnyType_Double)
kRSFAC_ctwtru	Calculated (or original) CTW True (kSDKAnyType_Double)
kRSFAC_stwtru	Calculated (or original) STW True (kSDKAnyType_Double)
kRSFAC_ctwrel	Calculated (or original) CTW Relative (kSDKAnyType_Double)
kRSFAC_stwrel	Calculated (or original) STW Relative (kSDKAnyType_Double)
kRSFAC_cursta	Current target status, one of RSFAV_status (kSDKAnyType_Uint32)
kRSFAC_prvsta	Previous target status, one of RSFAV_status (kSDKAnyType_Uint32)
kRSFAC_tiksta	Milliseconds from OS startup, when kRSFAC_cursta attribute was changed (kSDKAnyType_Int64)
kRSFAC_visibl	Target shape is visible flag (kSDKAnyType_Bool)
kRSFAC_dshshp	Target shape is dashed flag (kSDKAnyType_Bool)
kRSFAC_redclr	Target is red colored flag (kSDKAnyType_Bool)
kRSFAC_tblink	Target shape is blinking flag (kSDKAnyType_Bool)
kRSFAC_cross	Cross should be displayed flag (kSDKAnyType_Bool)
kRSFAC_cblink	Target's cross is blinking flag (kSDKAnyType_Bool)
kRSFAC_select	Target is selected flag (kSDKAnyType_Bool)
kRSFAC_bgsymb	Big target symbol flag (kSDKAnyType_Bool)
kRSFAC_privat	Private attributes, which should not be changed externally.
kRSFAC_ttdsta	Previous target status from TTD, one of RSFAV_ttdsta (kSDKAnyType_Uint32)
kRSFAC_user	User-defined attributes.

RadarSonarPastTrackFeatureAttributeCode

enum RadarSonarPastTrackFeatureAttributeCode

Radar/Sonar target past track feature attribute class codes kSDKAnyType_Empty value means, that given attribute value is absent.

Enumerator
kPTFAC_visibl	Target shape is visible flag (kSDKAnyType_Bool)
kPTFAC_redclr	Target is red colored flag (kSDKAnyType_Bool)
kPTFAC_asmmsi	MMSI number of associated AIS target (kSDKAnyType_Uint32)
kPTFAC_asfoid	Target FOID of associated AIS target (kSDKAnyType_Uint64)
kPTFAC_dist	Distance to target from CCRP (kSDKAnyType_Double)
kPTFAC_sogtru	Target SOG True (kSDKAnyType_Double)
kPTFAC_user	User-defined attributes.

RSFAV_status

enum RSFAV_status

Available radar/sonar target statuses.

Enumerator
kRSFAV_status_lost	Lost, tracked target has been lost.
kRSFAV_status_query	Query, target in the process of acquisition.
kRSFAV_status_tracking	Tracking target.

RSFAV_ttdsta

enum RSFAV_ttdsta

Available TTD statuses.

Enumerator
kRSFAV_ttdsta_acquiring_target	Acquiring target (not established) / Sleeping target.
kRSFAV_ttdsta_lost_target	Lost target / Lost target.
kRSFAV_ttdsta_established_tracking_no_alarm	Established tracking, no alarm / Activated target, no alarm.
kRSFAV_ttdsta_established_tracking_with_alarm	Established tracking, CPA/TCPA alarm / Activated target, CPA/TCPA alarm.
kRSFAV_ttdsta_established_tracking_acknowledged_alarm	Established tracking, acknowledged CPA/TCPA alarm / Activated target, acknowledged CPA/TCPA alarm.

RSFAV_acquis

enum RSFAV_acquis

Available radar/sonar target types of acquisition

Enumerator
kRSFAV_acquis_automatic	Automatic.
kRSFAV_acquis_manual	Manual.
kRSFAV_acquis_reported	Reported.

PortrayalParameterRadarSonarTargetsEnum

enum PortrayalParameterRadarSonarTargetsEnum

Radar/Sonar targets portraying environment parameters.

Enumerator
kPP_RadarSonarTarget_VelocityVectorOn	Switches on/off target's velocity vector (bool)
kPP_RadarSonarTarget_VelocityVectorLengthSec	Velocity vector length representing the distance target will travel in a user-selected time interval (SDKUInt32, in seconds)
kPP_RadarSonarTarget_VelocityVectorTimeIncrementsOn	Switches on/off time increment marks along target's velocity vector (bool)
kPP_RadarSonarTarget_VelocityVectorTimeIncrementsStepSec	Time increment marks step along target's velocity vector (SDKUInt32, in seconds)
kPP_RadarSonarTarget_PastTrackOn	Switches on/off target's past track (bool)
kPP_RadarSonarTarget_PastTrackIntervalSec	Past track interval (SDKUInt32, in seconds)
kPP_RadarSonarTarget_PastTrackLengthSec	Time period for which the past track should be displayed (SDKUInt32, in seconds)
kPP_RadarSonarTarget_ShowAssociatedTargetsAsAIS	Show associated Radar/AIS targets as AIS target.
kPP_RadarSonarTarget_VisibilityByRange_Enabled	Radar targets visibility by range enabled (bool)
kPP_RadarSonarTarget_VisibilityByRange_NM	Radar targets visibility by range (double) Target range should be <= kPP_RadarSonarTarget_VisibilityByRange_NM to be displayed
kPP_RadarSonarTarget_VisibilityBySpeed_Enabled	Radar targets visibility by speed enabled (bool)
kPP_RadarSonarTarget_VisibilityBySpeed_Kn	Radar targets targets visibility by speed (double) Target speed should be >= kPP_RadarSonarTarget_VisibilityBySpeed_Kn to be displayed
kPP_RadarSonarTarget_ShowRelativeVelocityVector	Show relative velocity vector instead of true (bool)
kPP_RadarSonarTarget_ShowSeaStabilizedVectors	Draw sea stabilized vectors for targets instead of ground stabilized (bool)
kPP_RadarSonarTarget_VisibilityBySource_Enabled	Radar targets visibility by source radar enabled If enabled, targets visibility will be filtered by kPP_RadarSonarTarget_VisibilityBySource_RADAR (bool, default is false)
kPP_RadarSonarTarget_VisibilityBySource_RADAR1	Radar targets visibility by source: If target source is radar 1, targe will be visible (bool, default is true) see: kRSFAC_source, OwnShipDeviceConfig
kPP_RadarSonarTarget_VisibilityBySource_RADAR2	Radar targets visibility by source: If target source is radar 2, targe will be visible (bool, default is true) see: kRSFAC_source, OwnShipDeviceConfig
kPP_RadarSonarTarget_VisibilityBySource_RADAR3	Radar targets visibility by source: If target source is radar 3, targe will be visible (bool, default is true) see: kRSFAC_source, OwnShipDeviceConfig