NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
radar_sonar_targets_manager_interface.h
Go to the documentation of this file.
1 
11 #ifndef SDK_RADAR_SONAR_TARGETS_MANAGER_INTERFACE_H_
12 #define SDK_RADAR_SONAR_TARGETS_MANAGER_INTERFACE_H_
13 #pragma once
14 
15 #include <base/inc/platform.h>
16 #include <base/inc/sdk_component_base.h>
20 
21 SDK_VESSELS_BEGIN_NAMESPACE
22 
24 
29 {
30  // Current state of target in acquisition state alarm
31  kRadarSonarTargetUpdateDescriptionRecord_AcquisitionAlarmState = 0, // kSDKAnyType_Uint32, one of AlarmState
32 
33  // Current state of target is dangerous alarm
34  kRadarSonarTargetUpdateDescriptionRecord_DangerAlarmState = 1, // kSDKAnyType_Uint32, one of AlarmState
35 
36  // Current state of target is lost alarm
37  kRadarSonarTargetUpdateDescriptionRecord_LostAlarmState = 2, // kSDKAnyType_Uint32, one of AlarmState
38 };
39 
48 {
49 public:
51  virtual SDKResult SDK_CALLTYPE OnTargetSelect(
52  const IRadarSonarTargetsDatasetSP& targets_dataset,
53  const RadarSonarTargetFOID& target_foid) throw() = 0;
54 
56  virtual SDKResult SDK_CALLTYPE OnGetSelectedTarget(
57  const IRadarSonarTargetsDatasetSP& targets_dataset,
58  RadarSonarTargetFOID& target_foid) throw() = 0;
59 
62  virtual SDKResult SDK_CALLTYPE OnTargetUpdating(
63  const RadarSonarTargetFOID& target_foid,
64  const IRadarSonarTargetSP& target) throw() = 0;
65 
67  virtual SDKResult SDK_CALLTYPE OnTargetUpdated(
68  const RadarSonarTargetFOID& target_foid, const IRadarSonarTargetSP& target,
69  ITargetUpdateDescriptionSP& update_description) throw() = 0;
70 
72  virtual SDKResult SDK_CALLTYPE OnAcknowledgeTargetAlarms(
73  const RadarSonarTargetFOID& target_foid, const IRadarSonarTargetSP& target,
74  const TargetAlarmIDs& alarms,
75  ITargetUpdateDescriptionSP& update_description) throw() = 0;
76 
77  SDK_IMPLEMENT_IID(IRadarSonarTargetsManager)
78  SDK_END_INTERFACE(IRadarSonarTargetsManager)
79 };
80 SDK_DECLARE_IID(IRadarSonarTargetsManager)
81 
82 SDK_VESSELS_END_NAMESPACE
83 
84 #endif // SDK_RADAR_SONAR_TARGETS_MANAGER_INTERFACE_H_
radar_sonar_targets_interface.h
Radar/Sonar targets dataset/target interface.
vessels_const.h
Defines Vessels constants.
RadarSonarTargetUpdateDescriptionRecord
RadarSonarTargetUpdateDescriptionRecord
Set of update description record IDs, which can be obtained from default target's manager implementat...
Definition: radar_sonar_targets_manager_interface.h:28
TargetAlarmIDs
SDKUInt32 TargetAlarmIDs
AIS/Radar/Sonar target alarm IDs (see the TargetAlarmType description below)
Definition: vessels_const.h:60
IRadarSonarTargetsManager::OnAcknowledgeTargetAlarms
virtual SDKResult SDK_CALLTYPE OnAcknowledgeTargetAlarms(const RadarSonarTargetFOID &target_foid, const IRadarSonarTargetSP &target, const TargetAlarmIDs &alarms, ITargetUpdateDescriptionSP &update_description)=0
Notification about some of target's alarms should be acknowledged.
IRadarSonarTargetsManager
An interface for high-level managing the targets over the database Allows to controls the target's po...
Definition: radar_sonar_targets_manager_interface.h:47
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
IRadarSonarTargetsManager::OnTargetUpdated
virtual SDKResult SDK_CALLTYPE OnTargetUpdated(const RadarSonarTargetFOID &target_foid, const IRadarSonarTargetSP &target, ITargetUpdateDescriptionSP &update_description)=0
Notification about single target was updated with data from parsed NMEA sentence.
platform.h
Describes the platform constants.
IRadarSonarTargetsManager::OnTargetSelect
virtual SDKResult SDK_CALLTYPE OnTargetSelect(const IRadarSonarTargetsDatasetSP &targets_dataset, const RadarSonarTargetFOID &target_foid)=0
Request to select the requested target, if possible.
ISDKComponent
Base interface for all SDK interfaces.
Definition: sdk_component_interface.h:41
IRadarSonarTargetsManager::OnGetSelectedTarget
virtual SDKResult SDK_CALLTYPE OnGetSelectedTarget(const IRadarSonarTargetsDatasetSP &targets_dataset, RadarSonarTargetFOID &target_foid)=0
Request to obtain currently selected target ID.
radar_sonar_targets_const.h
Set of specific for Radar/Sonar targets constants.
IRadarSonarTargetsManager::OnTargetUpdating
virtual SDKResult SDK_CALLTYPE OnTargetUpdating(const RadarSonarTargetFOID &target_foid, const IRadarSonarTargetSP &target)=0
Notification about single target is going to be updated with data from parsed NMEA sentence.
RadarSonarTargetFOID
TargetFOID RadarSonarTargetFOID
Radar/Sonar target FOID definition.
Definition: radar_sonar_targets_const.h:34
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.