NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
updated_targets_interface.h
Go to the documentation of this file.
1 
9 #ifndef SDK_ECDISLAYER_UPDATED_TARGETS_INTERFACE_H_
10 #define SDK_ECDISLAYER_UPDATED_TARGETS_INTERFACE_H_
11 #pragma once
12 
13 #include <base/inc/platform.h>
14 #include <base/inc/base_types.h>
15 #include <base/inc/sdk_results.h>
18 
19 SDK_VESSELS_BEGIN_NAMESPACE
20 
23 
26 typedef SDKUInt32 UpdateDescriptionRecordID;
27 
31 {
32 public:
36  virtual SDKResult SDK_CALLTYPE GetUpdateDescriptionRecord(
37  const UpdateDescriptionRecordID& id, SDKAny& value) const throw() = 0;
38 
39  SDK_IMPLEMENT_IID(ITargetUpdateDescription)
40  SDK_END_INTERFACE(ITargetUpdateDescription)
41 };
42 SDK_DECLARE_IID(ITargetUpdateDescription)
43 
44 class IUpdatedTargets : public ISDKComponent
47 {
48 public:
50  virtual SDKUInt32 SDK_CALLTYPE GetCount() const throw() = 0;
51 
54  virtual SDKResult SDK_CALLTYPE GetEntry(const SDKUInt32& record_idx,
55  TargetFOID* const target_foid, sdk::gdb::ObjectID* const oid,
56  ITargetUpdateDescription** update_description) const throw() = 0;
57 
58  SDK_IMPLEMENT_IID(IUpdatedTargets)
59  SDK_END_INTERFACE(IUpdatedTargets)
60 };
61 SDK_DECLARE_IID(IUpdatedTargets)
62 
63 SDK_VESSELS_END_NAMESPACE
64 
65 #endif // SDK_ECDISLAYER_UPDATED_TARGETS_INTERFACE_H_
ITargetUpdateDescription::GetUpdateDescriptionRecord
virtual SDKResult SDK_CALLTYPE GetUpdateDescriptionRecord(const UpdateDescriptionRecordID &id, SDKAny &value) const =0
Retrieves appropriate update description record value. See description of description record identifi...
sdk_results.h
A list of SDK error/return results.
base_types.h
SDK base types.
vessels_const.h
Defines Vessels constants.
IUpdatedTargets
Set of updated target's.
Definition: updated_targets_interface.h:46
ITargetUpdateDescription
Optional target information about applied update.
Definition: updated_targets_interface.h:30
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
sdk_component_interface.h
Common base SDK interfaces.
platform.h
Describes the platform constants.
ObjectID
Object identifier.
Definition: gdb_const.h:115
IUpdatedTargets::GetCount
virtual SDKUInt32 SDK_CALLTYPE GetCount() const =0
Returns total number of updated targets.
ISDKComponent
Base interface for all SDK interfaces.
Definition: sdk_component_interface.h:41
IUpdatedTargets::GetEntry
virtual SDKResult SDK_CALLTYPE GetEntry(const SDKUInt32 &record_idx, TargetFOID *const target_foid, sdk::gdb::ObjectID *const oid, ITargetUpdateDescription **update_description) const =0
Returns appropriate updated target FOID/OID/Optionally update description by record index.
TargetFOID
SDKUInt64 TargetFOID
Target FOID definition (AIS/Radar/Sonar targets)
Definition: vessels_const.h:52
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
UpdateDescriptionRecordID
SDKUInt32 UpdateDescriptionRecordID
Update description record ID.
Definition: updated_targets_interface.h:26