ownship_device_config_interface.h

Go to the documentation of this file.

 
#ifndef SDK_ECDISLAYER_OWNSHIP_DEVICE_CONFIG_INTERFACE_H_
#define SDK_ECDISLAYER_OWNSHIP_DEVICE_CONFIG_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <ecdislayer/inc/vessels/vessels_const.h>
#include <ecdislayer/inc/vessels/ownship_const.h>
 
SDK_VESSELS_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(IOwnShipDeviceConfig)
//
//                           Bow
//                      __ _________  
//                     /     \
//                    /       \
//                   |         |  A
//                   |         |
//              Port |  CS     | Starboard
//                   |  + -------------- 
//                   |  |      |
//                   |  |      |  B
//                   |_ |______| 
//                      |       Stern
//                    C |   D
//
//                     +Y    Bow
//                      |_ __  
//                     /|    \
//                    / |  +  \
//                   |  | Dev  |
//                   |  |      |
//              Port |  | CS   | Starboard
//        -X ---------- + ----------- +X 
//                   |  |      |
//                   |  |      |
//                   |_ |______| 
//                      |       Stern
//                     -Y
 
typedef enum OwnShipDeviceConfig {
  kOwnShipDeviceConfig_FirstValue = 0,
 
  kOwnShipDeviceConfig_CS = kOwnShipDeviceConfig_FirstValue, 
  kOwnShipDeviceConfig_POS_PRIMARY,                          
  kOwnShipDeviceConfig_POS_SECONDARY,                        
  kOwnShipDeviceConfig_FirstPosDevice,                       
  kOwnShipDeviceConfig_POS1 = kOwnShipDeviceConfig_FirstPosDevice, 
  kOwnShipDeviceConfig_POS2,                                 
  kOwnShipDeviceConfig_POS3,                                 
  kOwnShipDeviceConfig_POS4,                                 
  kOwnShipDeviceConfig_LastPosDevice = kOwnShipDeviceConfig_POS4,  
  kOwnShipDeviceConfig_FirstRadar,                           
  kOwnShipDeviceConfig_RADAR1 = kOwnShipDeviceConfig_FirstRadar,   
  kOwnShipDeviceConfig_RADAR2,                               
  kOwnShipDeviceConfig_RADAR3,                               
  kOwnShipDeviceConfig_LastRadar = kOwnShipDeviceConfig_RADAR3,    
  kOwnShipDeviceConfig_FirstSonar,                           
  kOwnShipDeviceConfig_SONAR1  = kOwnShipDeviceConfig_FirstSonar,  
  kOwnShipDeviceConfig_SONAR2,                               
  kOwnShipDeviceConfig_SONAR3,                               
  kOwnShipDeviceConfig_LastSonar = kOwnShipDeviceConfig_SONAR3,    
  kOwnShipDeviceConfig_BEARING_PORT,      
  kOwnShipDeviceConfig_BEARING_STARBOARD, 
  kOwnShipDeviceConfig_ECHO,              
 
  kOwnShipDeviceConfig_FirstAnchor,                                   
  kOwnShipDeviceConfig_ANCHOR1    = kOwnShipDeviceConfig_FirstAnchor, 
  kOwnShipDeviceConfig_LastAnchor = kOwnShipDeviceConfig_ANCHOR1,     
 
  kOwnShipDeviceConfig_LastValue,
} OwnShipDeviceConfig;
 
typedef enum OwnShipDeviceError {
  kOwnShipDeviceError_Angle = 0, 
  kOwnShipDeviceError_Distance,  
} OwnShipDeviceError;
 
class IOwnShipDeviceConfig : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE GetDevicePosition(
    SDKUInt32 device, double& x, double& y) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetDevicePosition(
    SDKUInt32 device, double x, double y) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE GetDeviceGeoPosition(
    SDKUInt32 device, double& x, double& y) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetDeviceZ(
    SDKUInt32 device, double& z) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetDeviceZ(
    SDKUInt32 device, double z) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE GetDeviceError(
    SDKUInt32 device, 
    SDKUInt32 error_type, 
    double& error_val) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE SetDeviceError(
    SDKUInt32 device, 
    SDKUInt32 error_type, 
    double error_val) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetDeviceName(
    SDKUInt32 device, 
    SDKString* name, 
    SDKString* browse_name) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IOwnShipDeviceConfig)
  SDK_END_INTERFACE(IOwnShipDeviceConfig)
};
SDK_DECLARE_IID(IOwnShipDeviceConfig)
 
SDK_VESSELS_END_NAMESPACE
 
#endif // SDK_ECDISLAYER_OWNSHIP_DEVICE_CONFIG_INTERFACE_H_