NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
ais_targets_manager_interface.h
Go to the documentation of this file.
1 #ifndef SDK_AIS_TARGETS_MANAGER_INTERFACE_H_
13 #define SDK_AIS_TARGETS_MANAGER_INTERFACE_H_
14 #pragma once
15 
16 #include <base/inc/platform.h>
17 #include <base/inc/sdk_component_base.h>
22 
23 SDK_VESSELS_BEGIN_NAMESPACE
24 
26 
31 {
33  kAISTargetUpdateDescriptionRecord_DangerAlarmState = 0, // kSDKAnyType_Uint32, one of AlarmState
34 
36  kAISTargetUpdateDescriptionRecord_LostAlarmState = 1, // kSDKAnyType_Uint32, one of AlarmState
37 };
38 
42 {
48 };
49 
57 class IAISTargetsManager : public ISDKProperties
58 {
59 public:
61  virtual SDKResult SDK_CALLTYPE OnTargetSelect(
62  const IAISTargetsDatasetSP& targets_dataset,
63  const AISTargetFOID& target_foid) throw() = 0;
64 
66  virtual SDKResult SDK_CALLTYPE OnGetSelectedTarget(
67  const IAISTargetsDatasetSP& targets_dataset,
68  AISTargetFOID& target_foid) throw() = 0;
69 
72  virtual SDKResult SDK_CALLTYPE OnTargetUpdating(
73  const AISTargetFOID& target_foid,
74  const IAISTargetSP& target) throw() = 0;
75 
77  virtual SDKResult SDK_CALLTYPE OnTargetUpdated(
78  const AISTargetFOID& target_foid, const IAISTargetSP& target,
79  ITargetUpdateDescriptionSP& update_description) throw() = 0;
80 
82  virtual SDKResult SDK_CALLTYPE OnAcknowledgeTargetAlarms(
83  const AISTargetFOID& target_foid, const IAISTargetSP& target,
84  const TargetAlarmIDs& alarms,
85  ITargetUpdateDescriptionSP& update_description) throw() = 0;
86 
88 // virtual SDKResult SDK_CALLTYPE SetProperty(
89 // const SDKPropertyID& id, const SDKAny& value) throw() = 0;
90 // virtual SDKResult SDK_CALLTYPE GetProperty(
91 // const SDKPropertyID& id, SDKAny& value) const throw() = 0;
92 
93  SDK_IMPLEMENT_IID(IAISTargetsManager)
94  SDK_END_INTERFACE(IAISTargetsManager)
95 };
96 SDK_DECLARE_IID(IAISTargetsManager)
97 
98 SDK_VESSELS_END_NAMESPACE
99 
100 #endif // SDK_AIS_TARGETS_MANAGER_INTERFACE_H_
kAISTargetUpdateDescriptionRecord_DangerAlarmState
@ kAISTargetUpdateDescriptionRecord_DangerAlarmState
Current state of target is dangerous alarm.
Definition: ais_targets_manager_interface.h:33
TargetAlarmIDs
SDKUInt32 TargetAlarmIDs
AIS/Radar/Sonar target alarm IDs (see the TargetAlarmType description below)
Definition: vessels_const.h:60
updated_targets_interface.h
Updated targets interface.
ais_targets_const.h
Set of specific for AIS targets constants.
properties_interface.h
Object generic properties interface.
IAISTargetsManager::OnTargetUpdated
virtual SDKResult SDK_CALLTYPE OnTargetUpdated(const AISTargetFOID &target_foid, const IAISTargetSP &target, ITargetUpdateDescriptionSP &update_description)=0
Notification about single target was updated with data from parsed NMEA sentence.
kAISTargetUpdateDescriptionRecord_LostAlarmState
@ kAISTargetUpdateDescriptionRecord_LostAlarmState
Current state of target is lost alarm.
Definition: ais_targets_manager_interface.h:36
IAISTargetsManager
An interface for high-level managing of AIS targets over the database Allows to controls the target's...
Definition: ais_targets_manager_interface.h:57
kAISTargetsManagerProp_OwnVesselIDs
@ kAISTargetsManagerProp_OwnVesselIDs
Own vessel IDs Array of own vessel MMSI numbers (SDKUInt32) packed into kSDKAnyType_SDKArrayPtr....
Definition: ais_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
IAISTargetsManager::OnAcknowledgeTargetAlarms
virtual SDKResult SDK_CALLTYPE OnAcknowledgeTargetAlarms(const AISTargetFOID &target_foid, const IAISTargetSP &target, const TargetAlarmIDs &alarms, ITargetUpdateDescriptionSP &update_description)=0
Notification about some of target's alarms should be acknowledged.
IAISTargetsManager::OnTargetUpdating
virtual SDKResult SDK_CALLTYPE OnTargetUpdating(const AISTargetFOID &target_foid, const IAISTargetSP &target)=0
Notification about single target is going to be updated with data from parsed NMEA sentence.
AISTargetsManagerProps
AISTargetsManagerProps
List of available properties for AIS targets manager.
Definition: ais_targets_manager_interface.h:41
platform.h
Describes the platform constants.
IAISTargetsManager::OnTargetSelect
virtual SDKResult SDK_CALLTYPE OnTargetSelect(const IAISTargetsDatasetSP &targets_dataset, const AISTargetFOID &target_foid)=0
Request to select the requested target, if possible.
ais_targets_interface.h
AIS targets workspace/dataset/target interface.
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
AISTargetFOID
TargetFOID AISTargetFOID
AIS target FOID definition.
Definition: ais_targets_const.h:31
AISTargetUpdateDescriptionRecord
AISTargetUpdateDescriptionRecord
Set of update description record IDs, which can be obtained from default target's manager implementat...
Definition: ais_targets_manager_interface.h:30
IAISTargetsManager::OnGetSelectedTarget
virtual SDKResult SDK_CALLTYPE OnGetSelectedTarget(const IAISTargetsDatasetSP &targets_dataset, AISTargetFOID &target_foid)=0
Request to obtain currently selected target ID.