NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
source_nmea_sentence_value_ids.h File Reference

List of appropriate source value IDs to compose new NMEA sentence. More...

Go to the source code of this file.

Enumerations

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
}
 New NMEA sentence type. More...
 
enum  OutgoingAISChannel { kOutgoingAISChannel_Any = 0, kOutgoingAISChannel_ChannelA = 1, kOutgoingAISChannel_ChannelB = 2, kOutgoingAISChannel_Both = 3 }
 Outgoing AIS channel. More...
 
enum  AlertCondition { kAlertCondition_Active = kAlarmCondition_ThresholdExceeded, kAlertCondition_Inactive = kAlarmCondition_ThresholdNotExceeded }
 Alert condition. More...
 
enum  NmeaAlertAckState { kNmeaAlertAckState_Acknowledged = kAlarmAcknowledgeState_Acknowledged, kNmeaAlertAckState_NotAcknowledged = kAlarmAcknowledgeState_Unacknowledged }
 Alert acknowledge state. More...
 
enum  ConfigurationSentenceID { kConfigurationSentenceID_Navtex = 0 }
 Configuration sentence ID. More...
 
enum  SourceValueIDs {
  kSourceTalkerID = 0, kMessageID = 1, kDestinationMMSI = 2, kOutgoingChannel = 3,
  kAckRequired = 4, kTextID = 5, kText = 6, kRouteData = 7,
  kUTCTime = 8, kStatus = 9, kManufacturerCode = 10, kAlertID = 11,
  kAlertInstance = 12, kAlertRevCounter = 13, kAlertSentenceID = 14, kShipStaticData_SourceTalkerID = kSourceTalkerID,
  kShipStaticData_CallSign = 100, kShipStaticData_Name = 101, kShipStaticData_DimA = 102, kShipStaticData_DimB = 103,
  kShipStaticData_DimC = 104, kShipStaticData_DimD = 105, kShipStaticData_DTEIndicator = 106, kShipStaticData_SourceIdentifier = 107,
  kVoyageStaticData_SourceTalkerID = kSourceTalkerID, kVoyageStaticData_TypeOfShipAndCargo = 120, kVoyageStaticData_MaxDraft = 121, kVoyageStaticData_PersonsOnBoard = 122,
  kVoyageStaticData_Destination = 123, kVoyageStaticData_DateTimeOfArrival = 124, kVoyageStaticData_NavigationalStatus = 125, kVoyageStaticData_RegionalFlags = 126,
  kAddressedBinaryMessageText_SourceTalkerID = kSourceTalkerID, kAddressedBinaryMessageText_MessageID = kMessageID, kAddressedBinaryMessageText_DestinationMMSI = kDestinationMMSI, kAddressedBinaryMessageText_OutgoingChannel = kOutgoingChannel,
  kAddressedBinaryMessageText_AckRequired = kAckRequired, kAddressedBinaryMessageText_TextID = kTextID, kAddressedBinaryMessageText_Text = kText, kAddressedSafetyRelatedMessage_SourceTalkerID = kSourceTalkerID,
  kAddressedSafetyRelatedMessage_MessageID = kMessageID, kAddressedSafetyRelatedMessage_DestinationMMSI = kDestinationMMSI, kAddressedSafetyRelatedMessage_OutgoingChannel = kOutgoingChannel, kAddressedSafetyRelatedMessage_Text = kText,
  kBinaryBroadcastMessageText_SourceTalkerID = kSourceTalkerID, kBinaryBroadcastMessageText_MessageID = kMessageID, kBinaryBroadcastMessageText_OutgoingChannel = kOutgoingChannel, kBinaryBroadcastMessageText_TextID = kTextID,
  kBinaryBroadcastMessageText_Text = kText, kSafetyRelatedBroadcastMessage_SourceTalkerID = kSourceTalkerID, kSafetyRelatedBroadcastMessage_MessageID = kMessageID, kSafetyRelatedBroadcastMessage_OutgoingChannel = kOutgoingChannel,
  kSafetyRelatedBroadcastMessage_Text = kText, kRouteDataRTEWPL_SourceTalkerID = kSourceTalkerID, kRouteDataRTEWPL_RouteData = kRouteData, kAcknowledgeAlert_SourceTalkerID = kSourceTalkerID,
  kAcknowledgeAlert_AlertID = kAlertID, kSetAlertState_SourceTalkerID = kSourceTalkerID, kSetAlertState_TimeOfAlertConditionChange = kUTCTime, kSetAlertState_AlertID = kAlertID,
  kSetAlertState_AlertCondition = 160, kSetAlertState_AlertAcknowledgeState = 161, kSetAlertState_AlertDescriptionText = kText, kGeneralEventMessage_SourceTalkerID = kSourceTalkerID,
  kGeneralEventMessage_EventTime = kUTCTime, kGeneralEventMessage_SourceOfEvent = 180, kGeneralEventMessage_EventDescription = kText, kHearbeat_SourceTalkerID = kSourceTalkerID,
  kHearbeat_RepeatInterval = 200, kHearbeat_EquipmentStatus = kStatus, kHearbeat_SeqSentenceID = 201, kAlertCommand_SourceTalkerID = kSourceTalkerID,
  kAlertCommand_Time = kUTCTime, kAlertCommand_ManufacturerCode = kManufacturerCode, kAlertCommand_AlertID = kAlertID, kAlertCommand_AlertInstance = kAlertInstance,
  kAlertCommand_Command = 223, kCyclicAlertList_SourceTalkerID = kSourceTalkerID, kCyclicAlertList_AlertListData = 240, kAlertSentence_SourceTalkerID = kSourceTalkerID,
  kAlertSentence_SentenceID = kAlertSentenceID, kAlertSentence_TimeOfLastChange = kUTCTime, kAlertSentence_AlertCategory = 260, kAlertSentence_AlertPriority = 261,
  kAlertSentence_AlertState = 262, kAlertSentence_ManufacturerCode = kManufacturerCode, kAlertSentence_AlertID = kAlertID, kAlertSentence_AlertInstance = kAlertInstance,
  kAlertSentence_RevisionCounter = kAlertRevCounter, kAlertSentence_EscalationCounter = 263, kAlertSentence_AlertTitle = 264, kAlertSentence_AlertDescription = 265,
  kAlertCommandRefused_SourceTalkerID = kSourceTalkerID, kAlertCommandRefused_ReleaseTime = kUTCTime, kAlertCommandRefused_ManufacturerCode = kManufacturerCode, kAlertCommandRefused_AlertID = kAlertID,
  kAlertCommandRefused_AlertInstance = kAlertInstance, kAlertCommandRefused_RefusedAlertCommand = 280, kConfigurationRequest_SourceTalkerID = kSourceTalkerID, kConfigurationRequest_SentenceID = 300,
  kReportRouteTransfer_SourceTalkerID = kSourceTalkerID, kReportRouteTransfer_TransferType = 320, kReportRouteTransfer_RouteName = 321, kReportRouteTransfer_RouteVersion = 322,
  kReportRouteTransfer_WaypointID = 323, kReportRouteTransfer_FileTransferStatus = 324, kReportRouteTransfer_ApplicationStatus = 325, kNavtexReceiverMask_SourceTalkerID = kSourceTalkerID,
  kNavtexReceiverMask_FunctionCode = 340, kNavtexReceiverMask_FrequencyTableIndex = 341, kNavtexReceiverMask_TransmitterCoverageAreaMask = 342, kNavtexReceiverMask_MessageTypeMask = 343,
  kNavtexReceiverMask_SentenceStatusFlag = 344
}
 List of required values to compose new NMEA sentence In case given parameter will not be specified, it will not be specified in appropriate NMEA sentence (null field value will be used) In case given parameter is specified with NULL value, the appropriate undefined value will be used (for example for NULL CallSign the appropriate NMEA sentence will be filled with @@@@ value which is equal to undefined CallSign value) More...
 

Detailed Description

List of appropriate source value IDs to compose new NMEA sentence.

Copyright (c) 2011 The NAVTOR SDK. All Rights Reserved.

Author
The NAVTOR SDK authors.
Date
11/2012
Maintenance:
The NAVTOR SDK authors.

Enumeration Type Documentation

◆ SentenceID

enum SentenceID

New NMEA sentence type.

Enumerator
kSentenceID_ShipStaticData 

Ship static data (SSD sentence)

kSentenceID_VoyageStaticData 

Voyage static data (VSD sentence)

kSentenceID_AddressedBinaryMessage_Text 

Addressed binary message text - Message 6 DAC = 1, FI = 0 (ABM sentence)

kSentenceID_AddressedSafetyRelatedMessage 

Addressed safety related message - Message 12 (ABM sentence)

kSentenceID_BinaryBroadcastMessage_Text 

Binary broadcast message text - Message 8 DAC = 1, FI = 0 (BBM sentence)

kSentenceID_SafetyRelatedBroadcastMessage 

Safety related broadcast message - Message 14 (BBM sentence)

kSentenceID_RouteData_RTE_WPL 

Route data (RTE/WPL sentences)

kSentenceID_AcknowledgeAlert 

Acknowledge alert (ACK sentence)

kSentenceID_SetAlertState 

Set alert state (ALR sentence)

kSentenceID_GeneralEventMessage 

General event message (EVE sentence)

kSentenceID_Heartbeat 

Heartbeat (HBT sentence)

kSentenceID_AlertCommand 

Alert command (ACM sentence)

kSentenceID_CyclicAlertList 

Cyclic alert list (ALC sentence)

kSentenceID_AlertSentence 

Alert sentence (ALF sentence)

kSentenceID_AlertCommandRefused 

Alert command refused (ARC sentence)

kSentenceID_ConfigurationRequest 

Configuration information request (CRQ sentence)

kSentenceID_ReportRouteTransfer 

Report route transfer (RRT sentence)

kSentenceID_NavtexReceiverMask 

NAVTEX receiver mask (NRM sentence)

◆ OutgoingAISChannel

enum OutgoingAISChannel

Outgoing AIS channel.

Enumerator
kOutgoingAISChannel_Any 

No broadcast channel preference.

kOutgoingAISChannel_ChannelA 

Broadcast on AIS channel A.

kOutgoingAISChannel_ChannelB 

Broadcast on AIS channel B.

kOutgoingAISChannel_Both 

Broadcast message on both AIS channels A and B.

◆ AlertCondition

enum AlertCondition

Alert condition.

Enumerator
kAlertCondition_Active 

Alert is active.

kAlertCondition_Inactive 

Alert is rectified.

◆ NmeaAlertAckState

enum NmeaAlertAckState

Alert acknowledge state.

Enumerator
kNmeaAlertAckState_Acknowledged 

Alert is acknowledged.

kNmeaAlertAckState_NotAcknowledged 

Alert is not acknowledged.

◆ ConfigurationSentenceID

enum ConfigurationSentenceID

Configuration sentence ID.

Enumerator
kConfigurationSentenceID_Navtex 

Navtex receiver mask (NRM sentence)

◆ SourceValueIDs

enum SourceValueIDs

List of required values to compose new NMEA sentence In case given parameter will not be specified, it will not be specified in appropriate NMEA sentence (null field value will be used) In case given parameter is specified with NULL value, the appropriate undefined value will be used (for example for NULL CallSign the appropriate NMEA sentence will be filled with @@@@ value which is equal to undefined CallSign value)

Enumerator
kSourceTalkerID 

Source NMEA sentence talker ID.

kMessageID 

Sequential message identifier.

kDestinationMMSI 

The MMSI of the destination AIS unit for the ITU-R M.1371.

kOutgoingChannel 

AIS channel for broadcast of the radio message.

kAckRequired 

Acknowledge required flag.

kTextID 

Message text ID.

kText 

Message text.

kRouteData 

Route data.

kUTCTime 

UTC Time.

kStatus 

Status.

kManufacturerCode 

Manufacturer mnemonic code.

kAlertID 

Alert identifier.

kAlertInstance 

Alert instance.

kAlertRevCounter 

Alert revision counter.

kAlertSentenceID 

Alert sentence ID (sequential message identifier)

kShipStaticData_SourceTalkerID 

Source talker ID.

kShipStaticData_CallSign 

Ship�s call sign, 1 to 7 characters.

kShipStaticData_Name 

Ship�s name, 1 to 20 characters.

kShipStaticData_DimA 

Pos. ref., point dist.�A,� from bow, 0 to 511 m.

kShipStaticData_DimB 

Pos. ref.,point dist. �B,� from stern, 0 to 511 m.

kShipStaticData_DimC 

Pos. ref., point dist.�C,� from port beam, 0 to 63 m.

kShipStaticData_DimD 

Pos. ref.,point dist. �D,� from starboard beam, 0 to 63 m.

kShipStaticData_DTEIndicator 

DTE indicator flag.

kShipStaticData_SourceIdentifier 

Source identifier.

kVoyageStaticData_SourceTalkerID 

Source talker ID.

kVoyageStaticData_TypeOfShipAndCargo 

Type of ship and cargo category, 0 to 255.

kVoyageStaticData_MaxDraft 

Maximum present static draught, 0 to 25,5 m.

kVoyageStaticData_PersonsOnBoard 

Persons on-board, 0 to 8 191.

kVoyageStaticData_Destination 

Destination, 1-20 characters.

kVoyageStaticData_DateTimeOfArrival 

Estimated UTC of arrival at destination Estimated day of arrival at destination, 00 to 31 (UTC) Estimated month of arrival at destination, 00 to 12 (UTC)

kVoyageStaticData_NavigationalStatus 

Navigational status, 0 to 15.

kVoyageStaticData_RegionalFlags 

Regional application flags, 0 to 15.

kAddressedBinaryMessageText_SourceTalkerID 

Source talker ID.

kAddressedBinaryMessageText_MessageID 

Sequential message identifier, 0 to 3.

kAddressedBinaryMessageText_DestinationMMSI 

The MMSI of the destination AIS unit for the ITU-R M.1371.

kAddressedBinaryMessageText_OutgoingChannel 

AIS channel for broadcast of the radio message.

kAddressedBinaryMessageText_AckRequired 

Acknowledge required flag.

kAddressedBinaryMessageText_TextID 

Message text ID (0 - 2047)

kAddressedBinaryMessageText_Text 

Message text, up to 151 symbols.

kAddressedSafetyRelatedMessage_SourceTalkerID 

Source talker ID.

kAddressedSafetyRelatedMessage_MessageID 

Sequential message identifier, 0 to 3.

kAddressedSafetyRelatedMessage_DestinationMMSI 

The MMSI of the destination AIS unit for the ITU-R M.1371.

kAddressedSafetyRelatedMessage_OutgoingChannel 

AIS channel for broadcast of the radio message.

kAddressedSafetyRelatedMessage_Text 

Safety related message text, up to 156 symbols.

kBinaryBroadcastMessageText_SourceTalkerID 

Source talker ID.

kBinaryBroadcastMessageText_MessageID 

Sequential message identifier, 0 to 9.

kBinaryBroadcastMessageText_OutgoingChannel 

AIS channel for broadcast of the radio message.

kBinaryBroadcastMessageText_TextID 

Message text ID (0 - 2047)

kBinaryBroadcastMessageText_Text 

Message text, up to 156 symbols.

kSafetyRelatedBroadcastMessage_SourceTalkerID 

Source talker ID.

kSafetyRelatedBroadcastMessage_MessageID 

Sequential message identifier, 0 to 9.

kSafetyRelatedBroadcastMessage_OutgoingChannel 

AIS channel for broadcast of the radio message.

kSafetyRelatedBroadcastMessage_Text 

Message text, up to 161 symbols.

kRouteDataRTEWPL_SourceTalkerID 

Route data (RTE/WPL sentences) Source talker ID

kRouteDataRTEWPL_RouteData 

Route data.

kAcknowledgeAlert_SourceTalkerID 

Acknowledge alert (ACK sentence) Source talker ID

kAcknowledgeAlert_AlertID 

Alert ID (000 - 999)

kSetAlertState_SourceTalkerID 

Set alert state (ALR sentence) Source talker ID

kSetAlertState_TimeOfAlertConditionChange 

Time of alert condition change, UTC.

kSetAlertState_AlertID 

Alert ID (000 - 999)

kSetAlertState_AlertCondition 

Alert condition.

kSetAlertState_AlertAcknowledgeState 

Alert acknowledge state.

kSetAlertState_AlertDescriptionText 

Alert description text.

kGeneralEventMessage_SourceTalkerID 

General event message (EVE sentence) Source talker ID

kGeneralEventMessage_EventTime 

Event time.

kGeneralEventMessage_SourceOfEvent 

Source of event.

kGeneralEventMessage_EventDescription 

Event description.

kHearbeat_SourceTalkerID 

Heartbeat (HBT sentence) Source talker ID

kHearbeat_RepeatInterval 

Repeat interval.

kHearbeat_EquipmentStatus 

Equipment status.

kHearbeat_SeqSentenceID 

Sequential sentence ID, 0 - 9.

kAlertCommand_SourceTalkerID 

Alert command (ACM sentence) Source talker ID

kAlertCommand_Time 

Time.

kAlertCommand_ManufacturerCode 

Manufacturer mnemonic code, 3 symbols.

kAlertCommand_AlertID 

Alert identifier, 0 - 9999999.

kAlertCommand_AlertInstance 

Alert instance, 0 - 999999.

kAlertCommand_Command 

Alert command.

kCyclicAlertList_SourceTalkerID 

Cyclic alert list (ALC sentence) Source talker ID

kCyclicAlertList_AlertListData 

Cyclic alert list data.

kAlertSentence_SourceTalkerID 

Alert sentence (ALF sentence) Source talker ID

kAlertSentence_SentenceID 

Sentence ID (sequential message identifier)

kAlertSentence_TimeOfLastChange 

Time of last change.

kAlertSentence_AlertCategory 

Alert category.

kAlertSentence_AlertPriority 

Alert priority.

kAlertSentence_AlertState 

Alert state.

kAlertSentence_ManufacturerCode 

Manufacturer mnemonic code.

kAlertSentence_AlertID 

Alert ID.

kAlertSentence_AlertInstance 

Alert instance.

kAlertSentence_RevisionCounter 

Revision counter.

kAlertSentence_EscalationCounter 

Escalation counter.

kAlertSentence_AlertTitle 

Alert title.

kAlertSentence_AlertDescription 

Alert description.

kAlertCommandRefused_SourceTalkerID 

Alert command refused (ARC sentence) Source talker ID

kAlertCommandRefused_ReleaseTime 

Time of last change.

kAlertCommandRefused_ManufacturerCode 

Manufacturer mnemonic code.

kAlertCommandRefused_AlertID 

Alert ID.

kAlertCommandRefused_AlertInstance 

Alert instance.

kAlertCommandRefused_RefusedAlertCommand 

Refused alert command.

kConfigurationRequest_SourceTalkerID 

Configuration information request (CRQ sentence) Source talker ID

kConfigurationRequest_SentenceID 

Sentence ID.

kReportRouteTransfer_SourceTalkerID 

Report route transfer (RRT sentence) Source talker ID

kReportRouteTransfer_TransferType 

Reported transfer type.

kReportRouteTransfer_RouteName 

Route name.

kReportRouteTransfer_RouteVersion 

Route version.

kReportRouteTransfer_WaypointID 

Current waypoint ID.

kReportRouteTransfer_FileTransferStatus 

File transfer status.

kReportRouteTransfer_ApplicationStatus 

Application status.

kNavtexReceiverMask_SourceTalkerID 

NAVTEX receiver mask (NRM sentence) Source talker ID

kNavtexReceiverMask_FunctionCode 

Function code.

kNavtexReceiverMask_FrequencyTableIndex 

Frequency table index.

kNavtexReceiverMask_TransmitterCoverageAreaMask 

Transmitter coverage area mask.

kNavtexReceiverMask_MessageTypeMask 

Transmitter coverage area mask.

kNavtexReceiverMask_SentenceStatusFlag 

Status flag.