Represents a parsed NMEA 0183 HDG (Heading, Deviation & Variation) sentence. More...

#include <hdg.h>

Inheritance diagram for nmealib::nmea0183::HDG:

[legend]

Collaboration diagram for nmealib::nmea0183::HDG:

[legend]

Public Member Functions
	HDG (std::string talkerId, double magneticHeading, double magneticDeviation, char deviationDirection, double magneticVariation, char variationDirection)
	Construct an HDG message from individual field values.

	HDG (const HDG &)=default

HDG &	operator= (const HDG &)=default

	HDG (HDG &&) noexcept=default

HDG &	operator= (HDG &&) noexcept=default

	~HDG () override=default

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

double	getMagneticHeading () const noexcept

double	getMagneticDeviation () const noexcept

char	getDeviationDirection () const noexcept

double	getMagneticVariation () const noexcept

char	getVariationDirection () const noexcept

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

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

Public Member Functions inherited from nmealib::nmea0183::Message0183
	Message0183 (const Message0183 &)=default
	Copy constructor.

Message0183 &	operator= (const Message0183 &)=default
	Copy assignment operator.

	Message0183 (Message0183 &&) noexcept=default
	Move constructor.

Message0183 &	operator= (Message0183 &&) noexcept=default
	Move assignment operator.

	~Message0183 () override=default
	Destructor.

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

char	getStartChar () const noexcept
	Returns the start character of the NMEA 0183 sentence.

std::string	getTalker () const noexcept
	Returns the talker identifier extracted from the sentence.

std::string	getSentenceType () const noexcept
	Returns the sentence type identifier extracted from the sentence.

std::string	getPayload () const noexcept
	Returns the payload of the NMEA 0183 sentence.

std::string	getChecksumStr () const
	Get the checksum string extracted from the raw sentence.

std::string	getCalculatedChecksumStr () const noexcept
	Get the calculated checksum string for the sentence payload.

std::string	serialize () const override
	Returns the wire-format representation of the NMEA 0183 sentence, that is, the raw information that was passed when the message was created.

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

bool	validate () const noexcept override
	Returns whether the message is valid or not.

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	Nmea0183Factory

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::nmea0183::Message0183
static double	convertNmeaCoordinateToDecimalDegrees (const std::string &nmeaCoordinate)
	Converts an NMEA coordinate in ddmm.mmmm / dddmm.mmmm format to decimal degrees.

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::nmea0183::Message0183
std::string	toString (bool verbose) const noexcept
	Provides the common string representation for every NMEA 0183 message, which can be used by derived classes to implement their own getStringContent method.

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::nmea0183::Message0183
static std::unique_ptr< Message0183 >	create (const std::string &raw, TimePoint ts=std::chrono::system_clock::now())
	Protected factory method to create a Message0183 from a raw sentence string.

Protected Attributes inherited from nmealib::nmea0183::Message0183
char	startChar_

std::string	talker_

std::string	sentenceType_

std::string	payload_

std::string	checksumStr_

std::string	calculatedChecksumStr_

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

Type	type_ {Type::Unknown}

TimePoint	timestamp_ {}

Detailed Description

Represents a parsed NMEA 0183 HDG (Heading, Deviation & Variation) sentence.

HDG carries magnetic heading from the sensor and optional magnetic deviation and variation with their East/West direction indicators.

Sentence format:

$--HDG,x.x,x.x,a,x.x,a*hh<CR><LF>

nmealib::nmea0183::HDG

Represents a parsed NMEA 0183 HDG (Heading, Deviation & Variation) sentence.

Definition hdg.h:37

Definition at line 37 of file hdg.h.

Constructor & Destructor Documentation

◆ HDG() [1/3]

nmealib::nmea0183::HDG::HDG	(	std::string	talkerId,
		double	magneticHeading,
		double	magneticDeviation,
		char	deviationDirection,
		double	magneticVariation,
		char	variationDirection
	)

Construct an HDG message from individual field values.

Parameters

talkerId	Two-character talker identifier.
magneticHeading	Magnetic sensor heading in degrees.
magneticDeviation	Magnetic deviation in degrees.
deviationDirection	Deviation direction ('E' or 'W').
magneticVariation	Magnetic variation in degrees.
variationDirection	Variation direction ('E' or 'W').

Definition at line 73 of file hdg.cpp.

◆ HDG() [2/3]

nmealib::nmea0183::HDG::HDG ( const HDG & )

default

◆ HDG() [3/3]

nmealib::nmea0183::HDG::HDG ( HDG && )

defaultnoexcept

◆ ~HDG()

nmealib::nmea0183::HDG::~HDG ( )

overridedefault

Member Function Documentation

◆ clone()

std::unique_ptr< nmealib::Message > nmealib::nmea0183::HDG::clone ( ) const

overridevirtual

Creates a polymorphic deep copy of this message.

Returns: std::unique_ptr<Message> A unique pointer to the cloned message.

Implements nmealib::Message.

Definition at line 91 of file hdg.cpp.

◆ getDeviationDirection()

char nmealib::nmea0183::HDG::getDeviationDirection ( ) const

noexcept

Definition at line 141 of file hdg.cpp.

◆ getMagneticDeviation()

double nmealib::nmea0183::HDG::getMagneticDeviation ( ) const

noexcept

Definition at line 137 of file hdg.cpp.

◆ getMagneticHeading()

double nmealib::nmea0183::HDG::getMagneticHeading ( ) const

noexcept

Definition at line 133 of file hdg.cpp.

◆ getMagneticVariation()

double nmealib::nmea0183::HDG::getMagneticVariation ( ) const

noexcept

Definition at line 145 of file hdg.cpp.

◆ getStringContent()

std::string nmealib::nmea0183::HDG::getStringContent ( bool verbose ) const

overridevirtualnoexcept

Returns a human-readable string representation of the message content.

Parameters

verbose Selects whether to print a one-liner or a more detailed multi-line string with field names and values.

Returns: std::string The string representation of the message content

Reimplemented from nmealib::nmea0183::Message0183.

Definition at line 95 of file hdg.cpp.

◆ getVariationDirection()

char nmealib::nmea0183::HDG::getVariationDirection ( ) const

noexcept

Definition at line 149 of file hdg.cpp.

◆ operator=() [1/2]

HDG & nmealib::nmea0183::HDG::operator= ( const HDG & )

default

◆ operator=() [2/2]

HDG & nmealib::nmea0183::HDG::operator= ( HDG && )

defaultnoexcept

◆ operator==()

bool nmealib::nmea0183::HDG::operator== ( const HDG & other ) const

noexcept

Definition at line 153 of file hdg.cpp.

Friends And Related Symbol Documentation

◆ MessageRegistry

friend class MessageRegistry

friend

Definition at line 100 of file hdg.h.

◆ Nmea0183Factory

friend class Nmea0183Factory

friend

Definition at line 99 of file hdg.h.

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

include/nmealib/nmea0183/hdg.h
src/nmea0183/hdg.cpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HDG() [1/3]

◆ HDG() [2/3]

◆ HDG() [3/3]

◆ ~HDG()

Member Function Documentation

◆ clone()

◆ getDeviationDirection()

◆ getMagneticDeviation()

◆ getMagneticHeading()

◆ getMagneticVariation()

◆ getStringContent()

◆ getVariationDirection()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

Friends And Related Symbol Documentation

◆ MessageRegistry

◆ Nmea0183Factory