radar_sonar_targets_interface.h

Go to the documentation of this file.

 
#ifndef SDK_ECDIS_RADAR_SONAR_TARGETS_INTERFACE_H_
#define SDK_ECDIS_RADAR_SONAR_TARGETS_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/sdk_results.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_interface.h>
#include <geometry/inc/geometry/geometry.h>
#include <ecdislayer/inc/ecdislayer_const.h>
#include <ecdislayer/inc/nmea_parser/parsed_nmea_sentence_data_interface.h>
#include <ecdislayer/inc/vessels/ownship_device_config_interface.h>
#include <ecdislayer/inc/vessels/vessels_const.h>
#include <ecdislayer/inc/vessels/ownship_interface.h>
#include <ecdislayer/inc/vessels/radar_sonar_targets_const.h>
#include <ecdislayer/inc/vessels/updated_targets_interface.h>
#include <ecdislayer/inc/vessels/ais_targets_interface.h>
 
SDK_VESSELS_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(IUpdatedRadarSonarTargets);
FWD_DECL_INTERFACE(IRadarSonarTargetsManager);
FWD_DECL_INTERFACE(IRadarSonarTargetsWorkspace);
FWD_DECL_INTERFACE(IRadarSonarTargetsDataset);
FWD_DECL_INTERFACE(IRadarSonarTargetsEnum);
FWD_DECL_INTERFACE(IRadarSonarTargetsCollection);
FWD_DECL_INTERFACE(IRadarSonarTarget);
FWD_DECL_INTERFACE(IRadarSonarTargetPastTrack);
FWD_DECL_INTERFACE(IRadarSonarTargetsDatasetEdit);
FWD_DECL_INTERFACE(IRadarSonarTargetEdit);
 
inline RadarSonarTargetFOID TargetFoid2PastTrackFoid(
  const RadarSonarTargetFOID& target_foid)
{ return target_foid | 0x8000000000000000; }
 
inline RadarSonarTargetFOID PastTrackFoid2TargetFoid(
  const RadarSonarTargetFOID& past_track_foid)
{ return past_track_foid & ~0x8000000000000000; }
 
inline RadarSonarTargetFOID MakeRadarSonarTargetFOID(SDKUInt32 target_number,
  const sdk::gdb::vessels::OwnShipDeviceConfig device_id)
{
  RadarSonarTargetFOID foid = static_cast<RadarSonarTargetFOID>(device_id);
  foid = foid << 32UL;
  foid |= target_number;
  return foid;
}
 
enum RadarSonarTargetsWksPropertiesID
{
  kRadarSonarTargetsWksProperty_IgnoreTargetsInAcquisitionState,
};
 
class IUpdatedRadarSonarTargets : public IUpdatedTargets
{
public:
  // Only methods of IUpdatedTargets interface
  SDK_IMPLEMENT_IID(IUpdatedRadarSonarTargets)
  SDK_END_INTERFACE(IUpdatedRadarSonarTargets)
};
SDK_DECLARE_IID(IUpdatedRadarSonarTargets)
 
class IRadarSonarTargetsWorkspace : public IVesselWorkspace
{
public:
  virtual SDKResult SDK_CALLTYPE GetTargetsDataset(const DatasetID& dsid,
    IRadarSonarTargetsDatasetSP& targets_dataset) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetTarget(const RadarSonarTargetFOID& foid,
    IRadarSonarTargetSP& target) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetTarget(const sdk::gdb::ObjectID& oid,
    IRadarSonarTargetSP& target) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetTargetPastTrack(
    const RadarSonarTargetFOID& target_foid,
    IRadarSonarTargetPastTrackSP& target_past_track) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetTargetPastTrack(
    const sdk::gdb::ObjectID& target_oid,
    IRadarSonarTargetPastTrackSP& target_past_track) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE RemoveTarget(
    const RadarSonarTargetFOID& foid) throw() = 0;
  virtual SDKResult SDK_CALLTYPE RemoveTarget(
    const sdk::gdb::ObjectID& oid) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetOwnShip(
    const SDK_VESSELS_NAMESPACE::IOwnShipDatasetSP& own_ship_ds) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetManager(
    const IRadarSonarTargetsManagerSP& manager) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetManager(
    IRadarSonarTargetsManagerSP& manager) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetAISDatabase(
    const IAISTargetsWorkspaceSP& ais_targets_database) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetAISDatabase(
    IAISTargetsWorkspaceSP& ais_targets_database) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IRadarSonarTargetsWorkspace)
  SDK_END_INTERFACE(IRadarSonarTargetsWorkspace)
};
SDK_DECLARE_IID(IRadarSonarTargetsWorkspace)
 
class IRadarSonarTargetsDataset : public IVesselDataset
{
public:
  virtual SDKResult SDK_CALLTYPE UpdateTargetData(
    const SDK_VESSELS_NAMESPACE::OwnShipDeviceConfig& source_device,
    const SDK_NMEA_NAMESPACE::IParsedNMEASentenceDataSP& parsed_nmea_data,
    IUpdatedRadarSonarTargetsSP& updated_targets) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE OwnShipParametersChanged(
    IUpdatedRadarSonarTargetsSP& updated_targets) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SourceDeviceIsLost(
    const SDK_VESSELS_NAMESPACE::OwnShipDeviceConfig& source_device,
    IUpdatedRadarSonarTargetsSP& updated_targets) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetTarget(const RadarSonarTargetFOID& foid,
    IRadarSonarTargetSP& target) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetTarget(const sdk::gdb::ObjectID& oid,
    IRadarSonarTargetSP& target) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetTargetPastTrack(
    const RadarSonarTargetFOID& target_foid,
    IRadarSonarTargetPastTrackSP& target_past_track) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetTargetPastTrack(
    const sdk::gdb::ObjectID& target_oid,
    IRadarSonarTargetPastTrackSP& target_past_track) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetTargets(
    IRadarSonarTargetsCollectionSP& targets_collection) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE RemoveTarget(
    const RadarSonarTargetFOID& foid) throw() = 0;
  virtual SDKResult SDK_CALLTYPE RemoveTarget(
    const sdk::gdb::ObjectID& oid) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetOwnShip(
    const SDK_VESSELS_NAMESPACE::IOwnShipDatasetSP& own_ship_ds) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetOwnShip(
    SDK_VESSELS_NAMESPACE::IOwnShipDatasetSP& own_ship_ds) const throw() = 0;
 
 
  virtual SDKResult SDK_CALLTYPE SelectTarget(
    const RadarSonarTargetFOID& target_foid) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetSelectedTarget(
    RadarSonarTargetFOID& target_foid) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AcknowledgeTargetAlarms(
    const RadarSonarTargetFOID& target_foid, const TargetAlarmIDs& alarms,
    IUpdatedRadarSonarTargetsSP& updated_targets) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE ResetTargetsPastTrack() throw() = 0;
 
  SDK_IMPLEMENT_IID(IRadarSonarTargetsDataset)
  SDK_END_INTERFACE(IRadarSonarTargetsDataset)
};
SDK_DECLARE_IID(IRadarSonarTargetsDataset)
 
class IRadarSonarTargetsDatasetEdit : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE EditTarget(SDKUInt32 target_number, 
    sdk::gdb::vessels::OwnShipDeviceConfig device_id,
    IRadarSonarTargetEditSP& target_edit) throw() = 0;
 
  SDK_IMPLEMENT_IID(IRadarSonarTargetsDatasetEdit)
  SDK_END_INTERFACE(IRadarSonarTargetsDatasetEdit)
};
SDK_DECLARE_IID(IRadarSonarTargetsDatasetEdit)
 
class IRadarSonarTarget : public IVessel
{
public:
  virtual SDKResult SDK_CALLTYPE GetFOID(
    RadarSonarTargetFOID& foid) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetTargetPosition(
    SDKGeoPoint& position) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE ResetPastTrack() throw() = 0;
 
  SDK_IMPLEMENT_IID(IRadarSonarTarget)
  SDK_END_INTERFACE(IRadarSonarTarget)
};
SDK_DECLARE_IID(IRadarSonarTarget)
 
class IRadarSonarTargetEdit : public ISDKComponent
{
public:
  virtual SDKResult UpdateTargetPosition(const SDKGeoPoint& pos) throw() = 0;
 
  virtual SDKResult SetTargetAttributeValue(
    const AttributeClassCode& class_code, const SDKAny& value) throw() = 0;
 
  SDK_IMPLEMENT_IID(IRadarSonarTargetEdit)
  SDK_END_INTERFACE(IRadarSonarTargetEdit)
};
SDK_DECLARE_IID(IRadarSonarTargetEdit)
 
class IRadarSonarTargetPastTrack : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE GetFOID(
    RadarSonarTargetFOID& foid) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetVisiblePastTrack(
    const SDKUInt32& past_track_interval, const SDKUInt32& past_track_length,
    sdk::geometry::IPointCollectionSP& past_track) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE ResetPastTrack() throw() = 0;
 
  SDK_IMPLEMENT_IID(IRadarSonarTargetPastTrack)
  SDK_END_INTERFACE(IRadarSonarTargetPastTrack)
};
SDK_DECLARE_IID(IRadarSonarTargetPastTrack)
 
class IRadarSonarTargetsEnum : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Next(IRadarSonarTargetSP& target) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
 
  SDK_IMPLEMENT_IID(IRadarSonarTargetsEnum)
  SDK_END_INTERFACE(IRadarSonarTargetsEnum)
};
SDK_DECLARE_IID(IRadarSonarTargetsEnum)
 
class IRadarSonarTargetsCollection : public IRadarSonarTargetsEnum
{
public:
  virtual SDKResult SDK_CALLTYPE GetCount(
    SDKUInt32& targets_count) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetTarget(const SDKUInt32& target_index,
    IRadarSonarTargetSP& target) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IRadarSonarTargetsCollection)
  SDK_END_INTERFACE(IRadarSonarTargetsCollection)
};
SDK_DECLARE_IID(IRadarSonarTargetsCollection)
 
SDK_VESSELS_END_NAMESPACE
 
#endif // SDK_ECDIS_RADAR_SONAR_TARGETS_INTERFACE_H_