NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
IAISTargetsDataset Class Referenceabstract

AIS targets dataset. More...

#include <ais_targets_interface.h>

Inheritance diagram for IAISTargetsDataset:
IVesselDataset ISDKComponent

Public Member Functions

virtual SDKResult SDK_CALLTYPE UpdateTargetData (const SDK_NMEA_NAMESPACE::IParsedNMEASentenceDataSP &parsed_nmea_data, IUpdatedAISTargetsSP &updated_targets)=0 throw ()
 Updates AIS target information or creates new target Valid source data is a result of INMEAParser::ParseNMEASentence method usage with parsed data of VDM NMEA sentence Valid messages: Messages 1, 2, 3: Position reports Message 4: Base station report Message 5: Ship static and voyage related data Message 9: Standard SAR aircraft position report Message 14: Safety related broadcast message Message 18: Standard Class B equipment position report Message 19: Extended Class B equipment position report Message 21: Aids-to-navigation report (AtoN) Message 6/8:
DAC = 1, FI = 17: VTS-generated/synthetic targets DAC = 1, FI = 18: Clearance time to enter port DAC = 1, FI = 19: Marine traffic signal DAC = 1, FI = 20: Berthing data DAC - 1, FI = 22/23: Area notice DAC = 1, FI = 26: Environmental: Site location report Station ID report Wind report Water level report Current flow 2D report Current flow 3D report Horizontal current flow report Sea state report Salinity report Weather report Air gap/Air draft report DAC - 1, FI = 27/28: Route information broadcast/addressed DAC - 1, FI = 31: Meteorological and Hydrographic data In case target with appropriate ID already exists, it's properties will be updated with new data, in case not - new target entry will be created.
 
virtual SDKResult SDK_CALLTYPE OwnShipParametersChanged (IUpdatedAISTargetsSP &updated_targets)=0 throw ()
 Notification about own ship parameters changed (position/COG/SOG etc) This will initiate the status/alarms updating procedures for all of AIS targets, if target manager is set.
 
virtual SDKResult SDK_CALLTYPE GetTarget (const AISTargetFOID &foid, IAISTargetSP &target) const =0 throw ()
 Returns the AIS target record by it's FOID.
 
virtual SDKResult SDK_CALLTYPE GetTarget (const sdk::gdb::ObjectID &oid, IAISTargetSP &target) const =0 throw ()
 Returns the AIS target record by it's Object ID.
 
virtual SDKResult SDK_CALLTYPE GetTargetPastTrack (const AISTargetFOID &target_foid, IAISTargetPastTrackSP &target_past_track) const =0 throw ()
 Returns the AIS target past track record by AIS target FOID.
 
virtual SDKResult SDK_CALLTYPE GetTargetPastTrack (const sdk::gdb::ObjectID &target_oid, IAISTargetPastTrackSP &target_past_track) const =0 throw ()
 Returns the AIS target past track record by AIS target Object ID.
 
virtual SDKResult SDK_CALLTYPE GetTargets (IAISTargetsCollectionSP &targets_collection, const ISDKParametersSP &params) const =0 throw ()
 Returns the AIS targets collection/enumerator.
 
virtual SDKResult SDK_CALLTYPE RemoveTarget (const AISTargetFOID &foid)=0 throw ()
 Removes one AIS target entry from dataset by target's FOID.
 
virtual SDKResult SDK_CALLTYPE RemoveTarget (const sdk::gdb::ObjectID &oid)=0 throw ()
 Removes one AIS target entry from dataset by target's Object ID.
 
virtual SDKResult SDK_CALLTYPE SetOwnShip (const SDK_VESSELS_NAMESPACE::IOwnShipDatasetSP &own_ship_ds)=0 throw ()
 Sets the own ship dataset instance.
 
virtual SDKResult SDK_CALLTYPE GetOwnShip (SDK_VESSELS_NAMESPACE::IOwnShipDatasetSP &own_ship_ds) const =0 throw ()
 Returns current own ship dataset instance.
 
virtual SDKResult SDK_CALLTYPE SelectTarget (const AISTargetFOID &target_foid)=0 throw ()
 Selects AIS target in dataset Implementation depends of currently used AIS targets manager. More...
 
virtual SDKResult SDK_CALLTYPE GetSelectedTarget (AISTargetFOID &target_foid)=0 throw ()
 Returns selected AIS target FOID Implementation depends of currently used targets manager.
 
virtual SDKResult SDK_CALLTYPE AcknowledgeTargetAlarms (const AISTargetFOID &target_foid, const TargetAlarmIDs &alarms, IUpdatedAISTargetsSP &updated_targets)=0 throw ()
 Notification about some of AIS target's alarms were acknowledged.
 
virtual SDKResult SDK_CALLTYPE ResetTargetsPastTrack ()=0 throw ()
 Resets past track for all of AIS targets.
 
- Public Member Functions inherited from IVesselDataset
virtual SDKResult SDK_CALLTYPE SetOwnShipDeviceConfig (IOwnShipDeviceConfig *config)=0 throw ()
 Sets the own ship device configuration parameters. More...
 
virtual SDKResult SDK_CALLTYPE GetVessel (const SDKAny &id, IVessel **vessel)=0 throw ()
 Returns the pointer to the IVessel interface associated with the Vessel object specified by object id. More...
 
- Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE AddRef () const =0 throw ()
 Increments the reference count for an interface on a component.

 
virtual SDKAtomicRefCount SDK_CALLTYPE Release () const =0 throw ()
 Decrements the reference count for an interface on a component.
 
virtual SDKResult SDK_CALLTYPE GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
 Returns pointers to the supported interfaces on a component.
 
template<typename _Itf >
SDKResult GetInterface (_Itf **obj_ptr) throw ()
 Returns pointers to the supported interfaces on a component.
 

Detailed Description

AIS targets dataset.

Member Function Documentation

◆ SelectTarget()

virtual SDKResult SDK_CALLTYPE SelectTarget ( const AISTargetFOID &  target_foid)
throw (
)
pure virtual

Selects AIS target in dataset Implementation depends of currently used AIS targets manager.

Following methods implementation depends of currently used targets manager If no target's manager defined, following methods should not be called, due they always will return error with logging


The documentation for this class was generated from the following file: