The ecdislayer constants. More...

#include <base/inc/base_types.h>

Enumerations
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 }
	Sensor types. More...

enum	AlertPriority { , kAlertPriority_Alarm = kAlertPriority_First, kAlertPriority_Warning, kAlertPriority_Caution, kAlertPriority_EmergencyAlarm }

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_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 }
	iec-61924-2 NOTE 8 The alert identifier is unique within a single alert source. The alert identifier is a variable length integer field of maximum a 7-digit integer. It identifies the type of the alert, e.g. a �lost target� alert. For standardized alerts, see the list of Alert identifiers in Annex J. Number range 10000-9999999 is reserved for proprietary alerts. More...

enum	AlertCategory
	NOTE 4 The alert category is in compliance with the category definition as described in INS Performance Standard (MSC.252(83)) and Bridge Alert Management Performance Standard (MSC.302(87)): A, Category A: Alerts, where information at the operator unit is directly assigned to the function generating the alert is necessary, as decision support for the evaluation of the alert-related condition, e.g. graphical information of danger of collision or graphical information of danger of grounding. B, Category B: Alerts where no additional information for decision support is necessary besides the information which can be presented using the alert source and the text description of the alert. C, Category C: Alerts that cannot be acknowledged on the bridge but for which information is required about the status and treatment of the alerts, e.g. certain alerts from the engine.

enum	AlertClass { kAlertClass_NULL = -1 , kAlertClass_System = kAlertClass_First, kAlertClass_Sensors, kAlertClass_AISTargets, kAlertClass_RadarTargets, kAlertClass_RouteMonitoring, kAlertClass_External }
	Alert class. More...

Variables
static const char *	kProgramFiles = "global/app_program_files"
	Program files section.

static const char *	kProgramFiles_RootPath_Entry
	Program files root path.

static const char *	kProgramData = "global/app_program_data"
	Program data files section.

static const char *	kProgramData_RootPath_Entry
	Program data files root path.

static const char *	kVDR_Path = "global/vdr/path"
	Ecdis screen grabber executable path

static const char *	kECDISVersion = "global/app_version/path"
	ECDIS application version.

static const char *	kLogging_On_Entry = "app_logging/on"
	Logging configuration paths. More...

static const char *	kLogging_Level_Entry = "app_logging/level"
	Logging level entry configuration path.

static const char *	kLogging_RootPath_Entry = "app_logging/root_path"
	Logging root path entry configuration path.

static const char *	kLogging_MaxLogSize_Entry = "app_logging/max-size"
	Logging file max size entry configuration path.

static const char *	kMetadata_Vessels_Catalog = "metadata/vessels/catalog"
	Metadata vessels catalog path name.

static const char *	kMetadata_Sensors_Catalog = "metadata/sensors/catalog"
	Metadata sensors catalog path name.

static const char *	kMetadata_LWE_Catalog = "metadata/lwe/catalog"
	Metadata sensors catalog path name.

static const char	kAppConfigPath_Entry [] = "global/app_config/root_path"
	App default config and user config path name entry.

static const char	kProgramFilesVar [] = "$(app_program_files)"
	Program files config variable

static const char	kProgramDataVar [] = "$(app_program_data)"
	Program data config variable

static const char	kNavBoxPathVar [] = "$(navbox)"
	Navbox path config variable

static const char	kNavBoxHostVar [] = "$(navbox_host)"
	Navbox host config variable

static const char	kNavBoxDatabaseNameVar [] = "$(databasename)"
	Navbox database name config variable

static const char *	kLWE_Udp_IncomingBufferSize_Entry = "lwe_parameters/udp/incoming_buffer_size"
	LWE common parameters.

static const char	kSensorsCatalog_Key [] = "sensors"
	Sensors catalog.

static const SensorTypeAbbr	kSensorTypeAbbr []

static const SDKUInt16	kAlertAlarm_EscalationTimeoutSec = 7
	Escalation counter The escalation counter is presenting the number of alert escalations after time expiration during the state active-unacknowledged. The escalation counter starts with 0 and the step for increment is 1. The count resets to 1 after 9 is used. The alert escalation can be the escalation from warning into warning (activation of audible signal only), the escalation from warning to alarm, or the escalation from alarm to alarm with the activation of backup navigator alarm.

static const SDKUInt16	kAlert_SilenceTimeoutSec = 30
	Silence timeout.

Detailed Description

The ecdislayer constants.

Author: The NAVTOR SDK authors

Date: 10/2011

Maintenance:: The NAVTOR SDK authors

Enumeration Type Documentation

◆ SensorType

enum SensorType

Sensor types.

Enumerator
kSensorType_POS	Position.
kSensorType_HDG	Heading.
kSensorType_CTW	Course through the water.
kSensorType_STW	Speed through the water.
kSensorType_DPTH	Depth.
kSensorType_Wind	Wind.
kSensorType_AIS	AIS.
kSensorType_ARPA	ARPA.
kSensorType_SeeTrac	See track.
kSensorType_RoutePlanner	Route planner.
kSensorType_ALERT	Alert.
kSensorType_Autopilot	Autopilot.
kSensorType_COG	Course over ground.
kSensorType_SOG	Speed over ground.
kSensorType_ROT	Rate of turn.
kSensorType_DR	Dead reckoning.
kSensorType_ZDA	Date and time.
kSensorType_DTM	Datum.
kSensorType_Relay	Relay.
kSensorType_Navtex	Navtex.
kSensorType_BNWAS	BNWAS.
kSensorType_INS	INS.
kSensorType_DirectionFinder	Direction Finder.
kSensorType_RouteOutput	RTE/WPL route output.

◆ AlertPriority

enum AlertPriority

Enumerator
kAlertPriority_Alarm	Alarm - the highest priority of an alert as defined in MSC.252(83). Announcing a situation or condition requiring immediate attention, decision and if necessary action by the bridge team, to maintain the safe navigation of the ship
kAlertPriority_Warning	Warning - announcing a situation or condition requiring attention but no-immediate attention or action by the bridge team. Warnings are presented for precautionary reasons to make the bridge team aware of changed conditions which are not immediately hazardous, but may become so, if no forward-looking decision is made or action is taken
kAlertPriority_Caution	Caution - lowest priority of an alert. Raising bridge team�s awareness of a condition which does not warrant an alarm or warning condition, but still requires attention out of the ordinary consideration of the situation or of given information
kAlertPriority_EmergencyAlarm	Emergency alarm - the highest priority of an alert.

◆ AlertState

enum AlertState

Enumerator
kAlertState_Unknown	< Alert state is unknown
kAlertState_Raised	< Alert is raised and active
kAlertState_Rectified	< Alert is rectified and not active
kAlertState_Removed	< Alert is removed - no alert exist more

◆ AlertAckState

enum AlertAckState

Enumerator
kAlertAckState_Unknown	< Alert acknowledge state is unknown
kAlertAckState_Ack	< Alert is acknowledged
kAlertAckState_NotAck	< Alert is not acknowledged
kAlertAckState_Transferred	< Alert responsibility transferred

◆ AlertID

enum AlertID

iec-61924-2 NOTE 8 The alert identifier is unique within a single alert source. The alert identifier is a variable length integer field of maximum a 7-digit integer. It identifies the type of the alert, e.g. a �lost target� alert. For standardized alerts, see the list of Alert identifiers in Annex J. Number range 10000-9999999 is reserved for proprietary alerts.

Enumerator
kAlertID_Undefined	TCS.
kAlertID_EarlyCourseChangeIndication	Warning category A.
kAlertID_ActualCourseChangeIndication	Warning category A.
kAlertID_WheelOverLineAlarm	Alarm category A.
kAlertID_CrossTrackAlarm	Alarm category A cross-track alarm.
kAlertID_CourseDifference	ECDIS. Warning category A, (heading deviates from track course)
kAlertID_PositioningSystemFailure	Warning category B.
kAlertID_CrossingSafetyContour	Alarm category A.
kAlertID_DeviationFromPlannedRoute	Alarm category A.
kAlertID_AreaWithSpecialConditions	Warning/Caution category A.
kAlertID_ApproachToCriticalPoint	Warning category A.
kAlertID_DifferentGeodeticDatum	Warning category B.
kAlertID_SystemMalfunction	Warning category B.
kAlertID_SystemMalfunctionOfBackupDevice	AIS/ARPA. Warning category B
kAlertID_TargetCapacity	Warning category A.
kAlertID_CPA_TCPA	Alarm category A.
kAlertID_AcquisitionActivationZone	Warning category A.
kAlertID_LostTargetAlarm	Internal. Warning category A
kAlertID_GroundingAlert	Warning category A.
kAlertID_DangerInSafetyZone	Warning category A.
kAlertID_STW_Lost	Warning category B.
kAlertID_HDG_Lost	Warning category B.
kAlertID_EndOfRoute	Caution category B.
kAlertID_Sensor_Lost	Warning category B.
kAlertID_Sensor_InvalidCRC	Caution category B.
kAlertID_Sensor_InvalidSentence	Caution category B.
kAlertID_Sensor_NavigationalStatusUnsafe	Caution category B.
kAlertID_Sensor_NavigationalStatusCaution	Caution category B.
kAlertID_TCS_Lost	Warning category B Track Control Lost.
kAlertID_Sensor_Failure	Caution category B.
kAlertID_RouteFallsWithinARegionBeyondTheMaximumLatitude	Caution category B - route falls within a region beyond the maximum latitude.
kAlertID_RadarTargets_TargetCapacity	Warning category A.
kAlertID_RadarTargets_CPA_TCPA	Alarm category A.
kAlertID_RadarTargets_LostTargetAlarm	Warning category A.
kAlertID_RadarTargets_AutoAcquiredTargetAlarm	Warning category A.
kAlertID_AnchorWatch	Warning category A.
kAlertID_BAM_ConnectionLost	Caution category B.
kAlertID_VDR_ConnectionLost	Warning category B.
kAlertID_BAM_AbnormalWork	Caution category B.
kAlertID_Sensor_AbsentCRC	Caution category B.
kAlertID_Sensor_LostRadar	Warning category B.

◆ AlertClass

enum AlertClass

Alert class.

Enumerator
kAlertClass_NULL	Undefined alert class.
kAlertClass_System	ECDIS alerts.
kAlertClass_Sensors	Sensors alerts.
kAlertClass_AISTargets	AIS alerts.
kAlertClass_RadarTargets	ARPA alerts.
kAlertClass_RouteMonitoring	Route monitoring alerts.
kAlertClass_External	External alerts (ALR/ACK)

Variable Documentation

◆ kLogging_On_Entry

const char* kLogging_On_Entry = "app_logging/on"

static

Logging configuration paths.

Logging on/off entry configuration path

◆ kSensorTypeAbbr

const SensorTypeAbbr kSensorTypeAbbr[]