logbook_interface.h

Go to the documentation of this file.

 
#ifndef SDK_LOGBOOK_INTERFACE_H_
#define SDK_LOGBOOK_INTERFACE_H_
#pragma once
 
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <base/inc/interfaces/parameters/parameters_interface.h>
#include <base/inc/interfaces/sql/sql_interface.h>
#include <ecdislayer/inc/ecdislayer_const.h>
 
SDK_ECDISLAYER_BEGIN_NAMESPACE
 
FWD_DECL_INTERFACE(ILogbookFactory);
FWD_DECL_INTERFACE(ILogbookTransformation);
FWD_DECL_INTERFACE(ILogbook);
FWD_DECL_INTERFACE(ILogbookRecord);
 
typedef enum LogbookRecordPar {
  kLogbookRecordPar_Table = 0,
  kLogbookRecordPar_Data,
  kLogbookRecordPar_Time,
  kLogbookRecordPar_Commit,
} LogbookRecordPar;
 
typedef enum LogbookTable {
  kLogbookTable_System = 0,
  kLogbookTable_Track,
  kLogbookTable_AISTargets,
  kLogbookTable_RadarTargets,
  kLogbookTable_Alarms,
} LogbookTable;
 
typedef enum LogbookSystemColumns {
  kLB_SYSTEM_TIME = 1, 
  kLB_SYSTEM_X,        
  kLB_SYSTEM_Y,        
  kLB_SYSTEM_ID,       
  kLB_SYSTEM_MESSAGE,     
} LogbookSystemColumns;
 
typedef enum LogbookAlarmsColumns {
  kLB_ALARM_TIME = 1,   
  kLB_ALARM_CATEGORY,   
  kLB_ALARM_CLASS,      
  kLB_ALARM_STATE,      
  kLB_ALARM_MESSAGE,    
} LogbookAlarmsColumns;
 
typedef enum LogbookTrackColumns {
  kLB_TRACK_TIME = 1, 
  kLB_TRACK_X,        
  kLB_TRACK_Y,        
  kLB_TRACK_COG,      
  kLB_TRACK_SOG,      
  kLB_TRACK_HDG,      
  kLB_TRACK_STW,      
  kLB_TRACK_DPT,      
  kLB_TRACK_POSSRC,   
  kLB_TRACK_COGSRC,   
  kLB_TRACK_SOGSRC,   
  kLB_TRACK_HDGSRC,   
  kLB_TRACK_STWSRC,   
  kLB_TRACK_DPTSRC,   
  kLB_TRACK_ENC,      
  kLB_TRACK_ENC_ISDT, 
  kLB_TRACK_ENC_EDNM, 
  kLB_TRACK_ENC_UPDN, 
  kLB_TRACK_ENC_UPDT, 
  kLB_TRACK_ENC_AGEN, 
} LogbookTrackColumns;
 
typedef enum LogbookTrackData {
  kLB_TRACK_DATA_OWNSHIP, 
  kLB_TRACK_DATA_ENC,      
  kLB_TRACK_DATA_ENC_ISDT, 
  kLB_TRACK_DATA_ENC_EDNM, 
  kLB_TRACK_DATA_ENC_UPDN, 
  kLB_TRACK_DATA_ENC_UPDT, 
  kLB_TRACK_DATA_ENC_AGEN, 
} LogbookTrackData;
 
typedef enum LogbookAISColumns {
  kLB_AIS_TIME = 1, 
  kLB_AIS_MMSI, 
  kLB_AIS_X,        
  kLB_AIS_Y,        
  kLB_AIS_COG,      
  kLB_AIS_SOG,      
  kLB_AIS_HDG,      
  kLB_AIS_CPA,      
  kLB_AIS_TCPA,     
} LogbookAISColumns;
 
typedef enum LogbookRadarTargetsColumns {
  kLB_RadarTargets_TIME = 1, 
  kLB_RadarTargets_NUMBER,   
  kLB_RadarTargets_X,        
  kLB_RadarTargets_Y,        
  kLB_RadarTargets_COURSE,   
  kLB_RadarTargets_SPEED,    
  kLB_RadarTargets_STATUS,   
  kLB_RadarTargets_CPA,      
  kLB_RadarTargets_TCPA,     
} LogbookRadarTargetsColumns;
 
typedef enum LogbookTransformationType {
  kLB_Transform_Course = 0,
  kLB_Transform_Speed,
  kLB_Transform_Depth,
} LogbookTransformationType;
 
class ILogbookFactory : public ISDKComponent {
 public:
  virtual SDKResult SDK_CALLTYPE Open(
    const SDKString& storage_path,
    const SDKString& persistent_storage_path,
    SDKTimeDelta retirement_age,
    ILogbook** logbook) throw() = 0;
 
  SDK_IMPLEMENT_IID(ILogbookFactory)
  SDK_END_INTERFACE(ILogbookFactory)
};
SDK_DECLARE_IID(ILogbookFactory)
 
class ILogbookTransformation : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE Forward(SDKUInt32 transformation_type,
    double in, SDKInt32& out_value) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Inverse(SDKUInt32 transformation_type,
    SDKInt32 in, double& out) throw() = 0;
 
  SDK_IMPLEMENT_IID(ILogbookTransformation)
  SDK_END_INTERFACE(ILogbookTransformation)
};
SDK_DECLARE_IID(ILogbookTransformation)
 
class ILogbook : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE AddRecord(
    ILogbookRecord* logbook) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetRowSet(
    ISDKParameters* parameters, sql::IRowSet** row_set) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE CreateRecord(
    ILogbookRecord** logbook_record) throw() = 0;
 
  SDK_IMPLEMENT_IID(ILogbook)
  SDK_END_INTERFACE(ILogbook)
};
SDK_DECLARE_IID(ILogbook)
 
class ILogbookRecord : public ISDKParameters {
public:
  SDK_IMPLEMENT_IID(ILogbookRecord)
  SDK_END_INTERFACE(ILogbookRecord)
};
SDK_DECLARE_IID(ILogbookRecord)
 
SDK_ECDISLAYER_END_NAMESPACE
 
#endif // SDK_LOGBOOK_INTERFACE_H_