ecdislayer_const.h

Go to the documentation of this file.

 
#ifndef SDK_ECDISLAYER_CONST_H_
#define SDK_ECDISLAYER_CONST_H_
 
#include <base/inc/base_types.h>
 
#ifndef SDK_ECDISLAYER_NAMESPACE
#define SDK_ECDISLAYER_NAMESPACE SDK_NAMESPACE::ecdislayer
#endif // SDK_ECDISLAYER_NAMESPACE
 
#ifndef SDK_NMEA_NAMESPACE
#define SDK_NMEA_NAMESPACE SDK_ECDISLAYER_NAMESPACE::nmea
#endif // SDK_NMEA_NAMESPACE
 
#ifndef SDK_NAVTEX_NAMESPACE
#define SDK_NAVTEX_NAMESPACE SDK_ECDISLAYER_NAMESPACE::navtex
#endif // SDK_NAVTEX_NAMESPACE
 
#ifndef SDK_LWE_NAMESPACE
#define SDK_LWE_NAMESPACE SDK_ECDISLAYER_NAMESPACE::lwe
#endif // SDK_NAVTEX_NAMESPACE
 
#ifndef SDK_ECDISLAYER_CONFIG_NAMESPACE 
#define SDK_ECDISLAYER_CONFIG_NAMESPACE SDK_ECDISLAYER_NAMESPACE::config
#endif
 
#ifndef SDK_ECDISLAYER_BEGIN_NAMESPACE
#define SDK_ECDISLAYER_BEGIN_NAMESPACE SDK_BEGIN_NAMESPACE \
                                       namespace ecdislayer {
#endif // SDK_ECDISLAYER_BEGIN_NAMESPACE
 
#ifndef SDK_ECDISLAYER_END_NAMESPACE
#define SDK_ECDISLAYER_END_NAMESPACE }}
#endif // SDK_ECDISLAYER_END_NAMESPACE
 
#ifndef SDK_NAVTEX_BEGIN_NAMESPACE
#define SDK_NAVTEX_BEGIN_NAMESPACE SDK_ECDISLAYER_BEGIN_NAMESPACE \
                                   namespace navtex {
#endif // SDK_NAVTEX_BEGIN_NAMESPACE
 
#ifndef SDK_NAVTEX_END_NAMESPACE
#define SDK_NAVTEX_END_NAMESPACE SDK_ECDISLAYER_END_NAMESPACE }
#endif // SDK_NAVTEX_END_NAMESPACE
 
#ifndef SDK_LWE_BEGIN_NAMESPACE
#define SDK_LWE_BEGIN_NAMESPACE SDK_ECDISLAYER_BEGIN_NAMESPACE \
                                   namespace lwe {
#endif // SDK_LWE_BEGIN_NAMESPACE
 
#ifndef SDK_LWE_END_NAMESPACE
#define SDK_LWE_END_NAMESPACE SDK_ECDISLAYER_END_NAMESPACE }
#endif // SDK_LWE_END_NAMESPACE
 
 
SDK_ECDISLAYER_BEGIN_NAMESPACE
 
namespace config {
 
static const char* kProgramFiles = "global/app_program_files";
static const char* kProgramFiles_RootPath_Entry = 
  "global/app_program_files/root_path";
static const char* kProgramData = "global/app_program_data";
static const char* kProgramData_RootPath_Entry = 
  "global/app_program_data/root_path";
static const char* kVDR_Path = "global/vdr/path";
static const char* kECDISVersion = "global/app_version/path";
 
static const char* kLogging_On_Entry = "app_logging/on";
static const char* kLogging_Level_Entry = "app_logging/level";
static const char* kLogging_RootPath_Entry = "app_logging/root_path";
static const char* kLogging_MaxLogSize_Entry = "app_logging/max-size";
 
static const char* kMetadata_Vessels_Catalog = "metadata/vessels/catalog";
 
static const char* kMetadata_Sensors_Catalog = "metadata/sensors/catalog";
 
static const char* kMetadata_LWE_Catalog = "metadata/lwe/catalog";
 
static const char kAppConfigPath_Entry[] = "global/app_config/root_path";
static const char kAppUserConfigPath_Entry[] = 
  "global/app_user_config/root_path";
static const char kNavboxPath_Entry[] =
  "global/navbox/root_path";
 
static const char kProgramFilesVar[] = "$(app_program_files)";
static const char kProgramDataVar[] = "$(app_program_data)";
static const char kNavBoxPathVar[] = "$(navbox)";
static const char kNavBoxHostVar[] = "$(navbox_host)";
static const char kNavBoxDatabaseNameVar[] = "$(databasename)";
 
static const char* kLWE_Udp_IncomingBufferSize_Entry = "lwe_parameters/udp/incoming_buffer_size";
static const char* kLWE_Udp_OutgoingBufferSize_Entry = "lwe_parameters/udp/outgoing_buffer_size";
static const char* kLWE_Udp_BandwidthLimit_Entry = "lwe_parameters/udp/bandwidth_limit";
static const char* kLWE_Udp_BandwidthLimitFactor_Entry = "lwe_parameters/udp/bandwidth_limit_factor";
static const char* kLWE_Udp_OutgoingInterface_Entry = "lwe_parameters/udp/outgoing_interface";
static const char* kLWE_Udp_Hops_Entry = "lwe_parameters/udp/hops";
static const char* kLWE_Udp_MTU_Entry = "lwe_parameters/udp/mtu";
static const char* kLWE_Udp_SelectOutgoingInterface_Entry = "lwe_parameters/udp/select_outgoing_interface";
static const char* kLWE_Udp_Binary_AssignAckPort_Entry = "lwe_parameters/udp/binary/assign_ack_port";
static const char* kLWE_Out_QueueSize_Entry = "lwe_parameters/output/queue_size";
static const char* kLWE_Out_AckQueueSize_Entry = "lwe_parameters/output/queue_ack_size";
static const char* kLWE_Parser_TextMsmTimeout_Entry = "lwe_parameters/parsers/text_msm_timeout";
static const char* kLWE_Parser_BinaryTimeout_Entry = "lwe_parameters/parsers/binary_timeout";
static const char* kLWE_Parser_AllowAnySourceEndpoints = "lwe_parameters/parsers/allow_any_source_endpoints";
static const char* kLWE_Message_DefaultBinaryVersion_Entry = "lwe_parameters/message/default_binary_version";
static const char* kLWE_Tcp_MTU_Entry = "lwe_parameters/tcp/mtu";
static const char* kLWE_Tcp_BandwidthLimit_Entry = "lwe_parameters/tcp/bandwidth_limit";
static const char* kLWE_Tcp_IncomingBufferSize_Entry = "lwe_parameters/tcp/incoming_buffer_size";
static const char* kLWE_Tcp_OutgoingBufferSize_Entry = "lwe_parameters/tcp/outgoing_buffer_size";
static const char* kLWE_Transmitter_Instance_Entry = "lwe_parameters/transmitter/instance";
static const char* kLWE_Transmitter_Enabled_Entry = "lwe_parameters/transmitter/enabled";
static const char* kLWE_Transmitter_Timeout_Entry = "lwe_parameters/transmitter/timeout";
static const char* kLWE_Transmitter_AnswerRequests_Entry = "lwe_parameters/transmitter/answer_requests";
static const char* kLWE_Transmitter_TalkerID_Entry = "lwe_parameters/transmitter/talker_id";
static const char* kLWE_Logging_Enabled_Entry = "lwe_parameters/logging/enabled";
static const char* kLWE_Logging_Detailed_Entry = "lwe_parameters/logging/detailed";
static const char* kLWE_Logging_Syslog_Enabled_Entry = "lwe_parameters/logging/syslog/enabled";
static const char* kLWE_Logging_Filelog_Enabled_Entry = "lwe_parameters/logging/filelog/enabled";
static const char* kLWE_Logging_Filelog_Path_Entry = "lwe_parameters/logging/filelog/path";
static const char* kLWE_Logging_Filelog_Size_Entry = "lwe_parameters/logging/filelog/size";
} // namespace config
 
namespace vessel_dct {
 
static const char kVesselDictionary_ReservedForFutureUse[] = "Reserved";
 
} // namespace vessel_dct
 
static const char kSensorsCatalog_Key[] = "sensors";
static const char kSensorsCatalog_Name[] = "name";
static const char kSensorsCatalog_Code[] = "code";
static const char kSensorsCatalog_Acronym[] = "acronym";
static const char kSensorsCatalog_Timeout[] = "timeout";
static const char kSensorsCatalog_Direction[] = "direction";
static const char kSensorsCatalog_Mnemonics[] = "mnemonics";
static const char kSensorsCatalog_Mnemonic[] = "mnemonic";
static const char kSensorsCatalog_MnemonicOn[] = "on";
static const char kSensorsCatalog_LocationRequired[] = "location";
 
static const char kSensorTypeAbbr_DR[] = "dr";
 
enum SensorType {
  kSensorType_POS = 0,      
  kSensorType_HDG,          
  kSensorType_CTW,          
  kSensorType_STW,          
  kSensorType_DPTH,         
  kSensorType_Wind,         
  kSensorType_AIS,          
  kSensorType_ARPA,         
  kSensorType_SeeTrac,      
  kSensorType_RoutePlanner, 
  kSensorType_ALERT,        
  kSensorType_Autopilot,    
  kSensorType_COG,          
  kSensorType_SOG,          
  kSensorType_ROT,          
  kSensorType_DR,           
  kSensorType_ZDA,          
  kSensorType_DTM,          
  kSensorType_Relay,        
  kSensorType_Navtex,       
  kSensorType_BNWAS,        
  kSensorType_INS,          
  kSensorType_DirectionFinder,  
  kSensorType_RouteOutput,  
  kSensorType_MAX,
  kSensorType_UNK = kSensorType_MAX
};
 
typedef struct SensorTypeAbbr {
  SensorType type;
  const char* abbr;
} SensorTypeAbbr;
 
static const SensorTypeAbbr kSensorTypeAbbr[]= {
  { kSensorType_POS, "pos" },               
  { kSensorType_HDG, "hdg" },               
  { kSensorType_CTW, "ctw" },               
  { kSensorType_STW, "stw" },               
  { kSensorType_DPTH, "dpth" },             
  { kSensorType_Wind, "wind" },             
  { kSensorType_AIS, "ais" },               
  { kSensorType_ARPA, "arpa" },             
  { kSensorType_SeeTrac, "seetrac" },       
  { kSensorType_RoutePlanner, "routeplanner" },  
  { kSensorType_ALERT, "alert" },           
  { kSensorType_Autopilot, "autopilot" },   
  { kSensorType_COG, "cog" },               
  { kSensorType_SOG, "sog" },               
  { kSensorType_ROT, "rot" },               
  { kSensorType_DR, kSensorTypeAbbr_DR },   
  { kSensorType_ZDA, "time" },              
  { kSensorType_DTM, "datum" },             
  { kSensorType_Relay, "relay" },           
  { kSensorType_Navtex, "navtex" },         
  { kSensorType_BNWAS, "bnwas" },           
  { kSensorType_INS, "ins" },               
  { kSensorType_DirectionFinder, "dirfinder" },   
  { kSensorType_RouteOutput, "rteout" }    
};
 
enum AlertPriority {
  kAlertPriority_NULL = -1,  
  kAlertPriority_Undefined = 0,
  kAlertPriority_First = kAlertPriority_Undefined + 1,
  kAlertPriority_Alarm = kAlertPriority_First,  
  kAlertPriority_Warning,    
  kAlertPriority_Caution,    
  kAlertPriority_EmergencyAlarm, 
  kAlertPriority_Count,
};
 
enum AlertState {
  kAlertState_Unknown = 0, 
  kAlertState_Raised,      
  kAlertState_Rectified,   
  kAlertState_Removed,     
};
 
enum AlertAckState {
  kAlertAckState_Unknown = 0, 
  kAlertAckState_Ack,         
  kAlertAckState_NotAck,      
  kAlertAckState_Transferred, 
};
 
enum AlertID {
  kAlertID_Undefined                 = 0,
  kAlertID_EarlyCourseChangeIndication  = 150, 
  kAlertID_ActualCourseChangeIndication = 151, 
  kAlertID_WheelOverLineAlarm           = 152, 
  kAlertID_CrossTrackAlarm              = 157, 
  kAlertID_CourseDifference             = 158, 
  kAlertID_PositioningSystemFailure  = 170, 
  kAlertID_CrossingSafetyContour     = 171, 
  kAlertID_DeviationFromPlannedRoute = 172, 
  kAlertID_AreaWithSpecialConditions = 173, 
  kAlertID_ApproachToCriticalPoint   = 174, 
  kAlertID_DifferentGeodeticDatum    = 175, 
  kAlertID_SystemMalfunction         = 176, 
  kAlertID_SystemMalfunctionOfBackupDevice = 177, 
  kAlertID_TargetCapacity     = 190, 
  kAlertID_CPA_TCPA           = 191, 
  kAlertID_AcquisitionActivationZone = 192, 
  kAlertID_LostTargetAlarm    = 193, 
  kAlertID_Internal = 101000,
  kAlertID_GroundingAlert         = kAlertID_Internal + 1, 
  kAlertID_DangerInSafetyZone     = kAlertID_Internal + 2, 
  kAlertID_STW_Lost               = kAlertID_Internal + 3, 
  kAlertID_HDG_Lost               = kAlertID_Internal + 4, 
  kAlertID_EndOfRoute             = kAlertID_Internal + 5, 
  kAlertID_Sensor_Lost            = kAlertID_Internal + 6, 
  kAlertID_Sensor_InvalidCRC      = kAlertID_Internal + 7, 
  kAlertID_Sensor_InvalidSentence = kAlertID_Internal + 8, 
  kAlertID_Sensor_NavigationalStatusUnsafe  = kAlertID_Internal + 9, 
  kAlertID_Sensor_NavigationalStatusCaution = kAlertID_Internal + 10, 
  kAlertID_TCS_Lost = kAlertID_Internal + 11, 
  kAlertID_Sensor_Failure = kAlertID_Internal + 12, 
  kAlertID_RouteFallsWithinARegionBeyondTheMaximumLatitude = kAlertID_Internal+159, 
  kAlertID_RadarTargets_TargetCapacity = kAlertID_Internal + 190, 
  kAlertID_RadarTargets_CPA_TCPA = kAlertID_Internal + 191, 
  kAlertID_RadarTargets_LostTargetAlarm = kAlertID_Internal + 193, 
  kAlertID_RadarTargets_AutoAcquiredTargetAlarm = kAlertID_Internal + 194, 
  kAlertID_AnchorWatch = kAlertID_Internal + 195, 
  kAlertID_BAM_ConnectionLost = kAlertID_Internal + 196, 
  kAlertID_VDR_ConnectionLost = kAlertID_Internal + 197, 
  kAlertID_BAM_AbnormalWork = kAlertID_Internal + 198, 
  kAlertID_Sensor_AbsentCRC = kAlertID_Internal + 199, 
  kAlertID_Sensor_LostRadar = kAlertID_Internal + 200, 
};
 
enum AlertCategory {
  kAlertCategory_Undefined = 0,
  kAlertCategory_A = 1,
  kAlertCategory_B,
  kAlertCategory_C,
};
 
enum AlertClass {
  kAlertClass_NULL = -1,        
  kAlertClass_First = 0,
  kAlertClass_System = kAlertClass_First, 
  kAlertClass_Sensors,          
  kAlertClass_AISTargets,       
  kAlertClass_RadarTargets,     
  kAlertClass_RouteMonitoring,  
  kAlertClass_External,         
  kAlertClass_Count
};
 
typedef struct AlertDescription {
  SDKUInt32     alert_id; // AlertID
  AlertPriority alert_priority;
  AlertCategory alert_category;
  AlertClass    alert_class;
} Alert;
 
static const AlertDescription kAlertDescriptionTable[] = {
  { kAlertID_EarlyCourseChangeIndication,      
    kAlertPriority_Warning, kAlertCategory_A, kAlertClass_RouteMonitoring },
  { kAlertID_ActualCourseChangeIndication,     
    kAlertPriority_Warning, kAlertCategory_A, kAlertClass_RouteMonitoring },
  { kAlertID_WheelOverLineAlarm,               
    kAlertPriority_Alarm,   kAlertCategory_A, kAlertClass_RouteMonitoring },
  { kAlertID_CrossTrackAlarm,                  
    kAlertPriority_Alarm,   kAlertCategory_A, kAlertClass_RouteMonitoring },
  { kAlertID_CourseDifference,                 
    kAlertPriority_Alarm,   kAlertCategory_A, kAlertClass_RouteMonitoring },
  { kAlertID_PositioningSystemFailure,         
    kAlertPriority_Warning, kAlertCategory_B, kAlertClass_Sensors },
  { kAlertID_CrossingSafetyContour,            
    kAlertPriority_Alarm,   kAlertCategory_A, kAlertClass_System },
  { kAlertID_DeviationFromPlannedRoute,        
    kAlertPriority_Alarm,   kAlertCategory_A, kAlertClass_RouteMonitoring },
  { kAlertID_AreaWithSpecialConditions,        
    kAlertPriority_Caution, kAlertCategory_A, kAlertClass_System },
  { kAlertID_ApproachToCriticalPoint,          
    kAlertPriority_Warning, kAlertCategory_A, kAlertClass_RouteMonitoring },
  { kAlertID_DifferentGeodeticDatum,           
    kAlertPriority_Warning, kAlertCategory_B, kAlertClass_Sensors },
  { kAlertID_SystemMalfunction,                
    kAlertPriority_Warning, kAlertCategory_B, kAlertClass_System },
  { kAlertID_SystemMalfunctionOfBackupDevice,  
    kAlertPriority_Warning, kAlertCategory_B, kAlertClass_System },
  { kAlertID_TargetCapacity,                   
    kAlertPriority_Warning, kAlertCategory_A, kAlertClass_AISTargets },
  { kAlertID_CPA_TCPA,                         
    kAlertPriority_Alarm,   kAlertCategory_A, kAlertClass_AISTargets },
  { kAlertID_LostTargetAlarm,                  
    kAlertPriority_Warning, kAlertCategory_A, kAlertClass_AISTargets },
  { kAlertID_RadarTargets_TargetCapacity,      
    kAlertPriority_Warning, kAlertCategory_A, kAlertClass_RadarTargets },
  { kAlertID_RadarTargets_CPA_TCPA,            
    kAlertPriority_Alarm,   kAlertCategory_A, kAlertClass_RadarTargets },
  { kAlertID_RadarTargets_LostTargetAlarm,     
    kAlertPriority_Warning, kAlertCategory_A, kAlertClass_RadarTargets },
  { kAlertID_GroundingAlert,                   
    kAlertPriority_Warning, kAlertCategory_A, kAlertClass_System },
  { kAlertID_DangerInSafetyZone,               
    kAlertPriority_Warning, kAlertCategory_A, kAlertClass_System },
  { kAlertID_STW_Lost,                         
    kAlertPriority_Warning, kAlertCategory_B, kAlertClass_Sensors },
  { kAlertID_HDG_Lost,                         
    kAlertPriority_Warning, kAlertCategory_B, kAlertClass_Sensors },
  { kAlertID_EndOfRoute,                       
    kAlertPriority_Caution, kAlertCategory_B, kAlertClass_RouteMonitoring },
  { kAlertID_Sensor_Lost,                      
    kAlertPriority_Warning, kAlertCategory_B, kAlertClass_Sensors },
  { kAlertID_Sensor_InvalidCRC,                
    kAlertPriority_Caution, kAlertCategory_B, kAlertClass_Sensors },
  { kAlertID_Sensor_InvalidSentence,           
    kAlertPriority_Caution, kAlertCategory_B, kAlertClass_Sensors },
  { kAlertID_Sensor_NavigationalStatusUnsafe,  
    kAlertPriority_Caution, kAlertCategory_B, kAlertClass_Sensors },
  { kAlertID_Sensor_NavigationalStatusCaution, 
    kAlertPriority_Caution, kAlertCategory_B, kAlertClass_Sensors },
  { kAlertID_TCS_Lost,                         
    kAlertPriority_Warning, kAlertCategory_B, kAlertClass_System  },
  { kAlertID_RouteFallsWithinARegionBeyondTheMaximumLatitude,
    kAlertPriority_Caution, kAlertCategory_B, kAlertClass_System },
  { kAlertID_RadarTargets_AutoAcquiredTargetAlarm,
    kAlertPriority_Warning, kAlertCategory_A, kAlertClass_System },
  { kAlertID_AnchorWatch,
    kAlertPriority_Warning, kAlertCategory_A, kAlertClass_System },
  { kAlertID_BAM_ConnectionLost,
    kAlertPriority_Caution, kAlertCategory_B, kAlertClass_System },
  { kAlertID_VDR_ConnectionLost,
    kAlertPriority_Warning, kAlertCategory_B, kAlertClass_System },
  { kAlertID_BAM_AbnormalWork,
    kAlertPriority_Caution, kAlertCategory_B, kAlertClass_System },
  { kAlertID_Sensor_AbsentCRC,
    kAlertPriority_Caution, kAlertCategory_B, kAlertClass_Sensors },
};
 
static const SDKUInt16 kAlertAlarm_EscalationTimeoutSec = 7;
static const SDKUInt16 kAlertWarning_EscalationTimeoutSec = 1 * 60;
static const SDKUInt8  kAlertEscalationCounterInitialValue = 0;
static const SDKUInt8  kAlertEscalationCounterMax = 9;
static const SDKUInt8  kAlertEscalationCounterResetValue = 1;
 
// It shall be possible to temporarily silence warnings and speech output, if provided(see also
// 8.4.2.3.1).If a warning is not acknowledged within 30 s the audible signal and the speech
// output shall start again in case the announcement state is still �active � unacknowledged� or
// as specified in the equipment performance standards.
static const SDKUInt16 kAlert_SilenceTimeoutSec = 30;
 
SDK_ECDISLAYER_END_NAMESPACE
 
#endif // SDK_ECDISLAYER_CONST_H_