Strongly-typed class representing PGN 127250 - Heading. More...

#include <PGN127250.h>

Inheritance diagram for nmealib::nmea2000::PGN127250:

[legend]

Collaboration diagram for nmealib::nmea2000::PGN127250:

[legend]

Public Member Functions
	PGN127250 (uint8_t sequenceId, Angle heading, SignedAngle deviation, SignedAngle variation, HalfByte headingReference, Byte reserved=Byte::fromValue(0U)) noexcept

	PGN127250 (const PGN127250 &)=default

PGN127250 &	operator= (const PGN127250 &)=default

	PGN127250 (PGN127250 &&) noexcept=default

PGN127250 &	operator= (PGN127250 &&) noexcept=default

	~PGN127250 () override=default

std::unique_ptr< nmealib::Message >	clone () const override
	Creates a polymorphic deep copy of this Message2000.

uint8_t	getSequenceId () const noexcept

Angle	getHeading () const noexcept

SignedAngle	getDeviation () const noexcept

SignedAngle	getVariation () const noexcept

HalfByte	getHeadingReference () const noexcept

float	getHeadingDegrees () const noexcept

float	getDeviationDegrees () const noexcept

float	getVariationDegrees () const noexcept

std::string	getStringContent (bool verbose) const noexcept override
	Returns a human-readable string representation of the message.

bool	operator== (const PGN127250 &other) const noexcept

virtual bool	operator== (const Message2000 &other) const noexcept

Public Member Functions inherited from nmealib::nmea2000::Message2000
	Message2000 (const Message2000 &)=default

Message2000 &	operator= (const Message2000 &)=default

	Message2000 (Message2000 &&) noexcept=default

Message2000 &	operator= (Message2000 &&)=default

	~Message2000 () override=default

const std::vector< uint8_t > &	getCanId () const noexcept
	Returns the 29-bit CAN identifier as 4 bytes (big-endian).

const std::vector< uint8_t > &	getCanFrame () const noexcept
	Returns the raw CAN frame payload (0-223 bytes).

uint8_t	getCanFrameLength () const noexcept
	Returns the number of bytes in the CAN frame payload.

uint8_t	getPriority () const noexcept
	Returns the 3-bit message priority (0 = highest, 7 = lowest).

bool	getPriority3 () const noexcept
	Returns individual priority bits (P3 is the MSB).

bool	getPriority2 () const noexcept
	Bit 3 of canId_[0].

bool	getPriority1 () const noexcept
	Bit 2 of canId_[0].

bool	getHeaderReserved () const noexcept
	Returns the Reserved bit (R1).

bool	getDataPage () const noexcept
	Returns the Data Page bit (DP).

uint8_t	getPDUFormat () const noexcept
	Returns the PDU Format byte (PF).

uint8_t	getPDUSpecific () const noexcept
	Returns the PDU Specific byte (PS).

uint8_t	getSourceAddress () const noexcept
	Returns the source address of the transmitting device.

uint8_t	getDestinationAddress () const noexcept
	Returns the destination address.

uint32_t	getPgn () const noexcept
	Returns the PGN (Parameter Group Number) extracted from the CAN Id.

std::string	serialize () const override
	Serializes the message to "CANID:data" hex format.

bool	validate () const override
	Returns true if the PGN fits in 18 bits and the frame is 0-223 bytes.

Public Member Functions inherited from nmealib::Message
	Message ()

	Message (std::string raw, Type type=Type::Unknown, TimePoint ts=std::chrono::system_clock::now()) noexcept

virtual	~Message ()

	Message (const Message &)=default

Message &	operator= (const Message &)=default

	Message (Message &&) noexcept=default

Message &	operator= (Message &&) noexcept=default

Type	getType () const noexcept
	Returns the message type.

const std::string &	getRawData () const noexcept
	Returns the raw, unmodified data string as received.

TimePoint	getTimestamp () const noexcept
	Returns the timestamp associated with this message.

bool	operator== (const Message &other) const noexcept
	Compares two Message objects for equality based on their content.

Friends
class	Nmea2000Factory

class	MessageRegistry

Additional Inherited Members
Public Types inherited from nmealib::Message
enum class	Type { Unknown , NMEA0183 , NMEA2000 }
	Defines the type of NMEA message, allowing for differentiation between various standards. More...

using	TimePoint = std::chrono::system_clock::time_point

Static Public Member Functions inherited from nmealib::Message
static std::string	typeToString (Type t)
	Converts a Message::Type enum value to its string representation.

Protected Member Functions inherited from nmealib::nmea2000::Message2000
std::string	toString (bool verbose) const noexcept
	Returns the base string common to all PGNs (used by getStringContent).

Protected Member Functions inherited from nmealib::Message
void	setType (Type t) noexcept
	Sets the message type.

void	setRaw (std::string r) noexcept
	Sets the raw data string.

void	setTimestamp (TimePoint ts) noexcept
	Sets the message timestamp.

Static Protected Member Functions inherited from nmealib::nmea2000::Message2000
static std::unique_ptr< Message2000 >	create (std::string raw, TimePoint ts=std::chrono::system_clock::now())
	Protected factory — parses "CANID:data" (and variant formats) into a Message2000.

Protected Attributes inherited from nmealib::nmea2000::Message2000
std::vector< uint8_t >	canId_
	29-bit CAN Id stored as 4 bytes (big-endian)

std::vector< uint8_t >	canFrame_
	CAN frame payload (0-223 bytes)

Protected Attributes inherited from nmealib::Message
std::string	rawData_

Type	type_ {Type::Unknown}

TimePoint	timestamp_ {}

Detailed Description

Strongly-typed class representing PGN 127250 - Heading.

PGN 127250 is used to report the heading of the vessel. The message contains the following fields:

Sequence ID (1 byte): A counter that increments with each new message instance.
Heading (2 bytes): The heading stored in an Angle dataType, in radians [0, 2π], resolution 1e-4 rad.
Deviation (2 bytes): The deviation stored in a Signed Angle dataType, in radians [-π, π], resolution 1e-4 rad.
Variation (2 byte): The variation stored in a Signed Angle dataType, in radians [-π, π], resolution 1e-4 rad.
Heading Reference (4 bits): An enumeration indicating the reference for the heading sensor (0-True, 1-Magnetic, 2-Error, 3-Null).
Reserved (6bits): Used for Alignment and future expansion, should be set to 0.

Definition at line 28 of file PGN127250.h.

Constructor & Destructor Documentation

◆ PGN127250() [1/3]

nmealib::nmea2000::PGN127250::PGN127250	(	uint8_t	sequenceId,
		Angle	heading,
		SignedAngle	deviation,
		SignedAngle	variation,
		HalfByte	headingReference,
		Byte	reserved = `Byte::fromValue(0U)`
	)

noexcept

Definition at line 45 of file PGN127250.cpp.

◆ PGN127250() [2/3]

nmealib::nmea2000::PGN127250::PGN127250 ( const PGN127250 & )

default

◆ PGN127250() [3/3]

nmealib::nmea2000::PGN127250::PGN127250 ( PGN127250 && )

defaultnoexcept

◆ ~PGN127250()

nmealib::nmea2000::PGN127250::~PGN127250 ( )

overridedefault

Member Function Documentation

◆ clone()

std::unique_ptr< Message > nmealib::nmea2000::PGN127250::clone ( ) const

overridevirtual

Creates a polymorphic deep copy of this Message2000.

Reimplemented from nmealib::nmea2000::Message2000.

Definition at line 65 of file PGN127250.cpp.

◆ getDeviation()

SignedAngle nmealib::nmea2000::PGN127250::getDeviation ( ) const

noexcept

Returns: the deviation in radians.

Definition at line 135 of file PGN127250.cpp.

◆ getDeviationDegrees()

float nmealib::nmea2000::PGN127250::getDeviationDegrees ( ) const

noexcept

Definition at line 147 of file PGN127250.cpp.

◆ getHeading()

Angle nmealib::nmea2000::PGN127250::getHeading ( ) const

noexcept

Returns: the heading in radians.

Definition at line 132 of file PGN127250.cpp.

◆ getHeadingDegrees()

float nmealib::nmea2000::PGN127250::getHeadingDegrees ( ) const

noexcept

Definition at line 144 of file PGN127250.cpp.

◆ getHeadingReference()

HalfByte nmealib::nmea2000::PGN127250::getHeadingReference ( ) const

noexcept

Returns: the heading reference.

Definition at line 141 of file PGN127250.cpp.

◆ getSequenceId()

uint8_t nmealib::nmea2000::PGN127250::getSequenceId ( ) const

noexcept

Returns: the sequence ID.

Definition at line 129 of file PGN127250.cpp.

◆ getStringContent()

std::string nmealib::nmea2000::PGN127250::getStringContent ( bool verbose ) const

overridevirtualnoexcept

Returns a human-readable string representation of the message.

Verbose: multi-line dump of all fields. Non-verbose: single-line summary.

Reimplemented from nmealib::nmea2000::Message2000.

Definition at line 69 of file PGN127250.cpp.

◆ getVariation()

SignedAngle nmealib::nmea2000::PGN127250::getVariation ( ) const

noexcept

Returns: the variation in radians.

Definition at line 138 of file PGN127250.cpp.

◆ getVariationDegrees()

float nmealib::nmea2000::PGN127250::getVariationDegrees ( ) const

noexcept

Definition at line 150 of file PGN127250.cpp.

◆ operator=() [1/2]

PGN127250 & nmealib::nmea2000::PGN127250::operator= ( const PGN127250 & )

default

◆ operator=() [2/2]

PGN127250 & nmealib::nmea2000::PGN127250::operator= ( PGN127250 && )

defaultnoexcept

◆ operator==() [1/2]

bool nmealib::nmea2000::Message2000::operator== ( const Message2000 & other ) const

virtualnoexcept

Reimplemented from nmealib::nmea2000::Message2000.

Definition at line 192 of file nmea2000.cpp.

◆ operator==() [2/2]

bool nmealib::nmea2000::PGN127250::operator== ( const PGN127250 & other ) const

noexcept

Definition at line 154 of file PGN127250.cpp.

Friends And Related Symbol Documentation

◆ MessageRegistry

friend class MessageRegistry

friend

Definition at line 100 of file PGN127250.h.

◆ Nmea2000Factory

friend class Nmea2000Factory

friend

Definition at line 99 of file PGN127250.h.

The documentation for this class was generated from the following files:

include/nmealib/nmea2000/PGN127250.h
src/nmea2000/PGN127250.cpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PGN127250() [1/3]

◆ PGN127250() [2/3]

◆ PGN127250() [3/3]

◆ ~PGN127250()

Member Function Documentation

◆ clone()

◆ getDeviation()

◆ getDeviationDegrees()

◆ getHeading()

◆ getHeadingDegrees()

◆ getHeadingReference()

◆ getSequenceId()

◆ getStringContent()

◆ getVariation()

◆ getVariationDegrees()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

Friends And Related Symbol Documentation

◆ MessageRegistry

◆ Nmea2000Factory