source_nmea_sentence_value_ids.h

Go to the documentation of this file.

#ifndef SDK_ECDIS_NMEA_PARSER_SOURCE_NMEA_SENTENCE_VALUE_IDS_H_
#define SDK_ECDIS_NMEA_PARSER_SOURCE_NMEA_SENTENCE_VALUE_IDS_H_
#pragma once
 
#include <base/inc/platform.h>
#include <ecdislayer/inc/ecdislayer_const.h>
#include <ecdislayer/inc/nmea_parser/parsed_nmea_sentence_value_ids.h>
 
SDK_ECDISLAYER_BEGIN_NAMESPACE
 
namespace nmea {
 
static const SDKUInt32 kALC_MaxNumberOfAlerts = 99UL;
 
enum SentenceID
{
  kSentenceID_ShipStaticData                = 0, 
 
  kSentenceID_VoyageStaticData              = 1,
 
  kSentenceID_AddressedBinaryMessage_Text   = 2,
 
  kSentenceID_AddressedSafetyRelatedMessage = 3,
 
  kSentenceID_BinaryBroadcastMessage_Text   = 4,
 
  kSentenceID_SafetyRelatedBroadcastMessage = 5,
 
  kSentenceID_RouteData_RTE_WPL             = 6,
 
  kSentenceID_AcknowledgeAlert              = 7,
 
  kSentenceID_SetAlertState                 = 8,
 
  kSentenceID_GeneralEventMessage           = 9,
 
  kSentenceID_Heartbeat                     = 10,
 
  kSentenceID_AlertCommand                  = 11,
 
  kSentenceID_CyclicAlertList               = 12,
 
  kSentenceID_AlertSentence                 = 13,
 
  kSentenceID_AlertCommandRefused           = 14,
 
  kSentenceID_ConfigurationRequest          = 15,
 
  kSentenceID_ReportRouteTransfer           = 16,
 
  kSentenceID_NavtexReceiverMask            = 17,
};
 
enum OutgoingAISChannel
{
  kOutgoingAISChannel_Any      = 0, 
  kOutgoingAISChannel_ChannelA = 1, 
  kOutgoingAISChannel_ChannelB = 2, 
  kOutgoingAISChannel_Both     = 3, 
};
 
enum AlertCondition
{
  kAlertCondition_Active   = kAlarmCondition_ThresholdExceeded,    
  kAlertCondition_Inactive = kAlarmCondition_ThresholdNotExceeded, 
};
 
enum NmeaAlertAckState
{
  kNmeaAlertAckState_Acknowledged    = kAlarmAcknowledgeState_Acknowledged,   
  kNmeaAlertAckState_NotAcknowledged = kAlarmAcknowledgeState_Unacknowledged, 
};
enum ConfigurationSentenceID
{
  kConfigurationSentenceID_Navtex = 0, 
};
 
enum SourceValueIDs
{
  kSourceTalkerID                           = 0,  // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kMessageID                                = 1,  // kSDKAnyType_Uint32
 
  kDestinationMMSI                          = 2,  // kSDKAnyType_Uint32
 
  kOutgoingChannel                          = 3,  // kSDKAnyType_Uint32, one of OutgoingAISChannel enum value
 
  kAckRequired                              = 4, // kSDKAnyType_Bool,
 
  kTextID                                   = 5,  // kSDKAnyType_Uint32
 
  kText                                     = 6,  // kSDKAnyType_SDKStringPtr
  
  kRouteData                                = 7,  // kSDKAnyType_SDKComponentPtr with IRouteData component
 
  kUTCTime                                  = 8,  // kSDKAnyType_SDKTimePacked
 
  kStatus                                   = 9,  // kSDKAnyType_Uint32, one of StatusField enum
 
  kManufacturerCode                         = 10, // kSDKAnyType_SDKStringPtr, 3 symbols
 
  kAlertID                                  = 11, // kSDKAnyType_Uint32, 0 - 9999999
 
  kAlertInstance                            = 12, // kSDKAnyType_Uint32, 1 - 999999
 
  kAlertRevCounter                          = 13, // kSDKAnyType_Uint32, 1 - 99
 
  kAlertSentenceID                          = 14, // kSDKAnyType_Uint32, 0 - 99
 
  // Ship static data (SSD sentence)
  kShipStaticData_SourceTalkerID            = kSourceTalkerID,        // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kShipStaticData_CallSign                  = 100,                    // kSDKAnyType_SDKStringPtr
 
  kShipStaticData_Name                      = 101,                    // kSDKAnyType_SDKStringPtr
 
  kShipStaticData_DimA                      = 102,                    // kSDKAnyType_Uint32
 
  kShipStaticData_DimB                      = 103,                    // kSDKAnyType_Uint32
 
  kShipStaticData_DimC                      = 104,                    // kSDKAnyType_Uint32
 
  kShipStaticData_DimD                      = 105,                    // kSDKAnyType_Uint32
 
  kShipStaticData_DTEIndicator              = 106,                    // kSDKAnyType_Bool
 
  kShipStaticData_SourceIdentifier          = 107,                    // kSDKAnyType_SDKStringPtr, 2 symbols
 
  // Voyage static data (VSD sentence)
  kVoyageStaticData_SourceTalkerID          = kSourceTalkerID,        // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kVoyageStaticData_TypeOfShipAndCargo      = 120,                    // kSDKAnyType_Uint32
 
  kVoyageStaticData_MaxDraft                = 121,                    // kSDKAnyType_Double
 
  kVoyageStaticData_PersonsOnBoard          = 122,                    // kSDKAnyType_Uint32
 
  kVoyageStaticData_Destination             = 123,                    // kSDKAnyType_SDKStringPtr
                                                                      
  kVoyageStaticData_DateTimeOfArrival       = 124,                    // kSDKAnyType_SDKTimePacked
 
  kVoyageStaticData_NavigationalStatus      = 125,                    // kSDKAnyType_Uint32, one of VDOVDMNavigationalStatus enum value
 
  kVoyageStaticData_RegionalFlags           = 126,                    // kSDKAnyType_Uint32
 
  // Addressed binary message text - Message 6 DAC = 1, FI = 0 (ABM sentence)
  kAddressedBinaryMessageText_SourceTalkerID = kSourceTalkerID,       // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kAddressedBinaryMessageText_MessageID      = kMessageID,            // kSDKAnyType_Uint32
 
  kAddressedBinaryMessageText_DestinationMMSI = kDestinationMMSI,     // kSDKAnyType_Uint32
 
  kAddressedBinaryMessageText_OutgoingChannel = kOutgoingChannel,     // kSDKAnyType_Uint32, one of OutgoingAISChannel enum value
 
  kAddressedBinaryMessageText_AckRequired     = kAckRequired,         // kSDKAnyType_Bool,
 
  kAddressedBinaryMessageText_TextID          = kTextID,              // kSDKAnyType_Uint32
 
  kAddressedBinaryMessageText_Text            = kText,                // kSDKAnyType_SDKStringPtr
 
  // Addressed safety related message - Message 12 (ABM sentence)
  kAddressedSafetyRelatedMessage_SourceTalkerID = kSourceTalkerID,    // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kAddressedSafetyRelatedMessage_MessageID      = kMessageID,         // kSDKAnyType_Uint32
 
  kAddressedSafetyRelatedMessage_DestinationMMSI = kDestinationMMSI,  // kSDKAnyType_Uint32
 
  kAddressedSafetyRelatedMessage_OutgoingChannel = kOutgoingChannel,  // kSDKAnyType_Uint32, one of OutgoingAISChannel enum value
 
  kAddressedSafetyRelatedMessage_Text         = kText,                // kSDKAnyType_SDKStringPtr
 
  // Binary broadcast message text - Message 8 DAC = 1, FI = 0 (BBM sentence)
  kBinaryBroadcastMessageText_SourceTalkerID  = kSourceTalkerID,      // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kBinaryBroadcastMessageText_MessageID       = kMessageID,           // kSDKAnyType_Uint32
 
  kBinaryBroadcastMessageText_OutgoingChannel = kOutgoingChannel,     // kSDKAnyType_Uint32, one of OutgoingAISChannel enum value
 
  kBinaryBroadcastMessageText_TextID          = kTextID,              // kSDKAnyType_Uint32
 
  kBinaryBroadcastMessageText_Text            = kText,                // kSDKAnyType_SDKStringPtr
 
  // Safety related broadcast message - Message 14 (BBM sentence)
  kSafetyRelatedBroadcastMessage_SourceTalkerID  = kSourceTalkerID,   // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kSafetyRelatedBroadcastMessage_MessageID       = kMessageID,        // kSDKAnyType_Uint32
 
  kSafetyRelatedBroadcastMessage_OutgoingChannel = kOutgoingChannel,  // kSDKAnyType_Uint32, one of OutgoingAISChannel enum value
 
  kSafetyRelatedBroadcastMessage_Text            = kText,             // kSDKAnyType_SDKStringPtr
 
  kRouteDataRTEWPL_SourceTalkerID                = kSourceTalkerID,   // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kRouteDataRTEWPL_RouteData                     = kRouteData,        // kSDKAnyType_SDKComponentPtr with IRouteData component
 
  kAcknowledgeAlert_SourceTalkerID               = kSourceTalkerID,   // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kAcknowledgeAlert_AlertID                      = kAlertID,          // kSDKAnyType_Uint32
 
  kSetAlertState_SourceTalkerID                  = kSourceTalkerID,   // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kSetAlertState_TimeOfAlertConditionChange      = kUTCTime,          // kSDKAnyType_SDKTimePacked
 
  kSetAlertState_AlertID                         = kAlertID,          // kSDKAnyType_Uint32
 
  kSetAlertState_AlertCondition                  = 160,               // kSDKAnyType_Uint32, one of AlertCondition enum value
 
  kSetAlertState_AlertAcknowledgeState           = 161,               // kSDKAnyType_Uint32, one of NmeaAlertAckState enum value
 
  kSetAlertState_AlertDescriptionText            = kText,             // kSDKAnyType_SDKStringPtr
 
  kGeneralEventMessage_SourceTalkerID            = kSourceTalkerID,   // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kGeneralEventMessage_EventTime                 = kUTCTime,          // kSDKAnyType_SDKTimePacked
 
  kGeneralEventMessage_SourceOfEvent             = 180,               // kSDKAnyType_SDKStringPtr
 
  kGeneralEventMessage_EventDescription          = kText,             // kSDKAnyType_SDKStringPtr
 
  kHearbeat_SourceTalkerID                       = kSourceTalkerID,   // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kHearbeat_RepeatInterval                       = 200,               // kSDKAnyType_Double
 
  kHearbeat_EquipmentStatus                      = kStatus,           // kSDKAnyType_Uint32, one of StatusField enum value
 
  kHearbeat_SeqSentenceID                        = 201,               // kSDKAnyType_Uint32
 
  kAlertCommand_SourceTalkerID                   = kSourceTalkerID,   // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kAlertCommand_Time                             = kUTCTime,          // kSDKAnyType_SDKTimePacked
 
  kAlertCommand_ManufacturerCode                 = kManufacturerCode, // kSDKAnyType_SDKStringPtr, 3 symbols
 
  kAlertCommand_AlertID                          = kAlertID,          // kSDKAnyType_Uint32, 0 - 9999999
 
  kAlertCommand_AlertInstance                    = kAlertInstance,    // kSDKAnyType_Uint32, 1 - 999999
  
  kAlertCommand_Command                          = 223,               // kSDKAnyType_Uint32, one of AlertCommand enum
 
  kCyclicAlertList_SourceTalkerID                = kSourceTalkerID,   // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kCyclicAlertList_AlertListData                 = 240,               // kSDKAnyType_SDKComponentPtr with ICyclicAlertListData component
 
  kAlertSentence_SourceTalkerID                  = kSourceTalkerID,   // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kAlertSentence_SentenceID                      = kAlertSentenceID,  // kSDKAnyType_Uint32, 0 - 9
 
  kAlertSentence_TimeOfLastChange                = kUTCTime,          // kSDKAnyType_SDKTimePacked
 
  kAlertSentence_AlertCategory                   = 260,               // kSDKAnyType_Uint32, one of NmeaAlertCategory enum
 
  kAlertSentence_AlertPriority                   = 261,               // kSDKAnyType_Uint32, one of NmeaAlertPriority enum
 
  kAlertSentence_AlertState                      = 262,               // kSDKAnyType_Uint32, one of NmeaAlertState enum
 
  kAlertSentence_ManufacturerCode                = kManufacturerCode, // kSDKAnyType_SDKStringPtr, 3 symbols
 
  kAlertSentence_AlertID                         = kAlertID,          // kSDKAnyType_Uint32, 0 - 9999999
 
  kAlertSentence_AlertInstance                   = kAlertInstance,    // kSDKAnyType_Uint32, 1 - 999999
 
  kAlertSentence_RevisionCounter                 = kAlertRevCounter,  // kSDKAnyType_Uint32, 1 - 99
 
  kAlertSentence_EscalationCounter               = 263,               // kSDKAnyType_Uint32, 0 - 9
 
  kAlertSentence_AlertTitle                      = 264,               // kSDKAnyType_SDKStringPtr
 
  kAlertSentence_AlertDescription                = 265,               // kSDKAnyType_SDKStringPtr
 
  kAlertCommandRefused_SourceTalkerID            = kSourceTalkerID,   // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kAlertCommandRefused_ReleaseTime               = kUTCTime,          // kSDKAnyType_SDKTimePacked
 
  kAlertCommandRefused_ManufacturerCode          = kManufacturerCode, // kSDKAnyType_SDKStringPtr, 3 symbols
 
  kAlertCommandRefused_AlertID                   = kAlertID,          // kSDKAnyType_Uint32, 0 - 9999999
 
  kAlertCommandRefused_AlertInstance             = kAlertInstance,    // kSDKAnyType_Uint32, 1 - 999999
 
  kAlertCommandRefused_RefusedAlertCommand       = 280,               // kSDKAnyType_Uint32, one of RefusedAlertCommand enum
 
  kConfigurationRequest_SourceTalkerID           = kSourceTalkerID,  // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kConfigurationRequest_SentenceID               = 300,              // kSDKAnyType_Uint32, one of ConfigurationSentenceID enum
 
  kReportRouteTransfer_SourceTalkerID            = kSourceTalkerID,  // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kReportRouteTransfer_TransferType              = 320,              // kSDKAnyType_Uint32, one of RouteTransferType enum
 
  kReportRouteTransfer_RouteName                 = 321,              // kSDKAnyType_SDKStringPtr, up to 30 symbols
 
  kReportRouteTransfer_RouteVersion              = 322,              // kSDKAnyType_SDKStringPtr, up to 20 symbols
 
  kReportRouteTransfer_WaypointID                = 323,              // kSDKAnyType_SDKStringPtr, up to 10 symbols
 
  kReportRouteTransfer_FileTransferStatus        = 324,              // kSDKAnyType_Uint32, one of RouteFileTransferStatus enum
 
  kReportRouteTransfer_ApplicationStatus         = 325,              // kSDKAnyType_Uint32, one of ApplicationRouteStatus enum
 
  kNavtexReceiverMask_SourceTalkerID             = kSourceTalkerID,  // kSDKAnyType_SDKStringPtr, 2 symbols
 
  kNavtexReceiverMask_FunctionCode               = 340,              // kSDKAnyType_Uint32, one of FunctionCode enum
 
  kNavtexReceiverMask_FrequencyTableIndex        = 341,              // kSDKAnyType_Uint32, one of FrequencyIndicator enum
 
  kNavtexReceiverMask_TransmitterCoverageAreaMask = 342,             // kSDKAnyType_Uint32, combination of TransmitterCoverageAreaMask values
 
  kNavtexReceiverMask_MessageTypeMask            = 343,              // kSDKAnyType_Uint32, combination of MessageTypeMask values
 
  kNavtexReceiverMask_SentenceStatusFlag         = 344,              // kSDKAnyType_Uint32, one of SentenceStatusFlag values
};
 
} // namespace nmea
 
SDK_ECDISLAYER_END_NAMESPACE
 
#endif // SDK_ECDIS_NMEA_PARSER_SOURCE_NMEA_SENTENCE_VALUE_IDS_H_