vessels_interface.h

Go to the documentation of this file.

 
#ifndef SDK_ECDISLAYER_VESSELS_INTERFACE_H_
#define SDK_ECDISLAYER_VESSELS_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/forward_declarations.h>
#include <base/inc/sdk_results_enum.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/sdk_any_handler.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <ecdislayer/inc/vessels/ownship_device_config_interface.h>
#include <ecdislayer/inc/vessels/vessels_const.h>
 
SDK_VESSELS_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(IVesselWorkspace);
FWD_DECL_INTERFACE(IVesselDataset);
FWD_DECL_INTERFACE(IVessel);
FWD_DECL_INTERFACE(IPositionFixing);
 
class IVesselWorkspace : public ISDKComponent 
{
public:
  virtual SDKResult SDK_CALLTYPE GetVesselDataset(
    const DatasetID& dsid,
    IVesselDataset** vessel_dataset) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetVessel(
    const SDKAny& id, 
    const DatasetID& dsid,
    IVessel** vessel) throw() = 0;
  
  SDK_IMPLEMENT_IID(IVesselWorkspace)
  SDK_END_INTERFACE(IVesselWorkspace)
};
SDK_DECLARE_IID(IVesselWorkspace)
 
class IVesselDataset : public ISDKComponent 
{
public:
  virtual SDKResult SDK_CALLTYPE SetOwnShipDeviceConfig(
    IOwnShipDeviceConfig* config) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetVessel(
    const SDKAny& id, 
    IVessel** vessel) throw() = 0;
 
  SDK_IMPLEMENT_IID(IVesselDataset)
  SDK_END_INTERFACE(IVesselDataset)
};
SDK_DECLARE_IID(IVesselDataset)
 
class IVessel : public ISDKComponent 
{
public:
  virtual SDKResult SDK_CALLTYPE SetAttributeValue(SDKUInt32 id, 
    const SDKAny& value) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetAttributeValue(SDKUInt32 id, 
    SDKAny& value) throw() = 0;
 
  template< typename T >
  SDKResult GetAttributeValueT(AttributeClassCode class_code, T& out) throw() {
    sdk::ScopedAny value;
    SDKResult res = GetAttributeValue(class_code, value);
    if (SDK_FAILED(res))
      return res;
    return value.GetAs< T >(out) ? sdk::Ok : sdk::Err_InvalidArg;
  }
 
  SDK_IMPLEMENT_IID(IVessel)
  SDK_END_INTERFACE(IVessel)
};
SDK_DECLARE_IID(IVessel)
 
typedef enum PosFixTechnique
{
  kPosFixTechnique_None       = 0, 
  kPosFixTechnique_DR         = 1, 
  kPosFixTechnique_EP         = 2, 
  kPosFixTechnique_RunningFix = 3, 
  kPosFixTechnique_Fix        = 4, 
} PosFixTechnique;
 
typedef enum FixAdvice
{
  kFixAdvice_Unknown,     
  kFixAdvice_DontAccept,  
  kFixAdvice_Repeat,      
  kFixAdvice_Accept,      
} FixAdvice;
 
class IPositionFixing : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE GetAvailableTechnique(
    PosFixTechnique& technique) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CalculateFixedPosition(const SDKTime& time,
    const SDKGeoPoint& dr_pos, SDKGeoPoint& fixed_pos,
    FixAdvice& advice, PosFixTechnique& technique) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AcceptFixedPosition() throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetConfidenceEllipse(
    double& a, double& b, double& alpha) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetConfidenceCircle(double& r) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddBearing(const SDKTime& time,
    const SDKGeoPoint& pos_from, double bearing, const SDKGeoPoint& curr_pos,
    double bearing_error, SDKUInt16& ref_point_id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddRunningBearing(
    SDKUInt16 ref_point_id, const SDKTime& time, double bearing,
    const SDKGeoPoint& curr_pos, double bearing_error) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddDistance(const SDKTime& time,
    const SDKGeoPoint& pos_from, double distance, const SDKGeoPoint& curr_pos,
    double distance_error, SDKUInt16& ref_point_id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddRunningDistance(
    SDKUInt16 ref_point_id, const SDKTime& time, double distance,
    const SDKGeoPoint& curr_pos, double distance_error) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddBearingDistance(
    const SDKTime& time, const SDKGeoPoint& pos_from,
    double bearing, double distance, const SDKGeoPoint& curr_pos,
    double bearing_error, double distance_error, SDKUInt16& ref_point_id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Clear() throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetPositionFixingWks(IWorkspace** wks) throw() = 0;
 
  SDK_IMPLEMENT_IID(IPositionFixing)
  SDK_END_INTERFACE(IPositionFixing)
};
SDK_DECLARE_IID(IPositionFixing)
 
SDK_VESSELS_END_NAMESPACE
 
#endif // SDK_ECDISLAYER_VESSELS_INTERFACE_H_