NMEA2000 Library  0.1
Library to handle NMEA 2000 Communication written in C++
tN2kAISAtoNReportData Struct Reference

Dedicated structure to handle AIS Aids to Navigation (AtoN) Report. More...

#include <N2kMessages.h>

Public Member Functions

 tN2kAISAtoNReportData ()
 Construct a new t N2k AIS AtoN Report Data object. More...
 
void SetAtoNName (const char *name)
 Set the AtoN Name. More...
 

Public Attributes

bool Accuracy
 position accuracy More...
 
tN2kAISTransceiverInformation AISTransceiverInformation
 AIS Transceiver Information see tN2kAISTransceiverInformation. More...
 
bool AssignedModeFlag
 Assigned Mode Flag. More...
 
char AtoNName [34+1]
 Name of AtoN Object. More...
 
uint8_t AtoNStatus
 AtoN Status byte Reserved for the indication of the AtoN status 00000000 = default. More...
 
tN2kAISAtoNType AtoNType
 Aid to Navigation (AtoN) Type, see tN2kAISAtoNType. More...
 
double Beam
 AtoN Structure Beam/Diameter in meters. More...
 
tN2kGNSStype GNSSType
 Type of electronic position fixing device See tN2kGNSStype. More...
 
double Latitude
 latitude of position [degree] More...
 
double Length
 AtoN Structure Length/Diameter in meters. More...
 
double Longitude
 longitude of position [degree] More...
 
uint8_t MessageID
 Message Type ID according to e ITU-R M.1371. More...
 
bool OffPositionIndicator
 Off Position Indicator For floating AtoN, only. More...
 
double PositionReferenceStarboard
 Position Reference Point from Starboard Structure Edge/Radius. More...
 
double PositionReferenceTrueNorth
 Position Reference Point from True North facing Structure Edge/Radius. More...
 
bool RAIM
 Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device. More...
 
tN2kAISRepeat Repeat
 Repeat indicator, Used by the repeater to indicate how many times a message has been repeated. see tN2kAISRepeat. More...
 
uint8_t Seconds
 TimeStamp UTC second when the report was generated. More...
 
uint32_t UserID
 MMSI number. More...
 
bool VirtualAtoNFlag
 Virtual AtoN flag. More...
 

Detailed Description

Dedicated structure to handle AIS Aids to Navigation (AtoN) Report.

This structure should provide an a more convenient way to process data of an AIS Aids to Navigation (AtoN) Report. The data can be used in PGN 129041. It also handles initialization of all values.

See also
SetN2kPGN129041 and ParseN2kPGN129041
ITU-R M.1371

Definition at line 3577 of file N2kMessages.h.

Constructor & Destructor Documentation

◆ tN2kAISAtoNReportData()

tN2kAISAtoNReportData::tN2kAISAtoNReportData ( )
inline

Construct a new t N2k AIS AtoN Report Data object.

This constructor takes care of a proper initialisation.

Definition at line 3689 of file N2kMessages.h.

Member Function Documentation

◆ SetAtoNName()

void tN2kAISAtoNReportData::SetAtoNName ( const char *  name)
inline

Set the AtoN Name.

Parameters
nameName of Aid-to-Navigation

Definition at line 3717 of file N2kMessages.h.

Member Data Documentation

◆ Accuracy

bool tN2kAISAtoNReportData::Accuracy

position accuracy

  • 0 = default
  • 1 = high (≤10 m)
  • 0 = low (>10 m)

Definition at line 3594 of file N2kMessages.h.

◆ AISTransceiverInformation

tN2kAISTransceiverInformation tN2kAISAtoNReportData::AISTransceiverInformation

AIS Transceiver Information see tN2kAISTransceiverInformation.

Definition at line 3667 of file N2kMessages.h.

◆ AssignedModeFlag

bool tN2kAISAtoNReportData::AssignedModeFlag

Assigned Mode Flag.

  • 0 = Station operating in autonomous and continuous mode = default
  • 1 = Station operating in assigned mode

Definition at line 3650 of file N2kMessages.h.

◆ AtoNName

char tN2kAISAtoNReportData::AtoNName[34+1]

Name of AtoN Object.

According to e ITU-R M.1371

This parameter of up to 14 additional 6-bit-ASCII characters for a 2-slot message may be combined with the parameter “Name of Aid-to-Navigation” at the end of that parameter, when more than 20 characters are needed for the name of the AtoN. This parameter should be omitted when no more than 20 characters for the name of the A-to-N are needed in total. Only the required number of characters should be transmitted, i.e. no -character should be used

Definition at line 3682 of file N2kMessages.h.

◆ AtoNStatus

uint8_t tN2kAISAtoNReportData::AtoNStatus

AtoN Status byte Reserved for the indication of the AtoN status 00000000 = default.

Definition at line 3662 of file N2kMessages.h.

◆ AtoNType

tN2kAISAtoNType tN2kAISAtoNReportData::AtoNType

Aid to Navigation (AtoN) Type, see tN2kAISAtoNType.

Definition at line 3624 of file N2kMessages.h.

◆ Beam

double tN2kAISAtoNReportData::Beam

AtoN Structure Beam/Diameter in meters.

Definition at line 3617 of file N2kMessages.h.

◆ GNSSType

tN2kGNSStype tN2kAISAtoNReportData::GNSSType

Type of electronic position fixing device See tN2kGNSStype.

Definition at line 3656 of file N2kMessages.h.

◆ Latitude

double tN2kAISAtoNReportData::Latitude

latitude of position [degree]

Definition at line 3587 of file N2kMessages.h.

◆ Length

double tN2kAISAtoNReportData::Length

AtoN Structure Length/Diameter in meters.

Definition at line 3615 of file N2kMessages.h.

◆ Longitude

double tN2kAISAtoNReportData::Longitude

longitude of position [degree]

Definition at line 3585 of file N2kMessages.h.

◆ MessageID

uint8_t tN2kAISAtoNReportData::MessageID

Message Type ID according to e ITU-R M.1371.

Definition at line 3579 of file N2kMessages.h.

◆ OffPositionIndicator

bool tN2kAISAtoNReportData::OffPositionIndicator

Off Position Indicator For floating AtoN, only.

  • 0 = on position
  • 1 = off position.
Note
This flag should only be considered valid by receiving station, if the AtoN is a floating aid, and if time stamp is equal to or below 59. For floating AtoN the guard zone parameters should be set on installation

Definition at line 3636 of file N2kMessages.h.

◆ PositionReferenceStarboard

double tN2kAISAtoNReportData::PositionReferenceStarboard

Position Reference Point from Starboard Structure Edge/Radius.

Definition at line 3619 of file N2kMessages.h.

◆ PositionReferenceTrueNorth

double tN2kAISAtoNReportData::PositionReferenceTrueNorth

Position Reference Point from True North facing Structure Edge/Radius.

Definition at line 3622 of file N2kMessages.h.

◆ RAIM

bool tN2kAISAtoNReportData::RAIM

Receiver autonomous integrity monitoring (RAIM) flag of electronic position fixing device.

  • 0 = RAIM not in use = default
  • 1 = RAIM in use

Definition at line 3601 of file N2kMessages.h.

◆ Repeat

tN2kAISRepeat tN2kAISAtoNReportData::Repeat

Repeat indicator, Used by the repeater to indicate how many times a message has been repeated. see tN2kAISRepeat.

Definition at line 3581 of file N2kMessages.h.

◆ Seconds

uint8_t tN2kAISAtoNReportData::Seconds

TimeStamp UTC second when the report was generated.

TimeStamp UTC second when the report was generated by the EPFS (0-59 or 60) if time stamp is not available, which should also be the default value or 61 if positioning system is in manual input mode or 62 if electronic position fixing system operates in estimated (dead reckoning) mode, or 63 if the positioning system is inoperative)

Definition at line 3613 of file N2kMessages.h.

◆ UserID

uint32_t tN2kAISAtoNReportData::UserID

MMSI number.

Definition at line 3583 of file N2kMessages.h.

◆ VirtualAtoNFlag

bool tN2kAISAtoNReportData::VirtualAtoNFlag

Virtual AtoN flag.

  • 0 = default = real AtoN at indicated position
  • 1 = virtual AtoN, does not physically exist.

Definition at line 3643 of file N2kMessages.h.


The documentation for this struct was generated from the following file: