Represents a parsed NMEA 0183 VTG (Course Over Ground and Ground Speed) sentence. More...

#include <vtg.h>

Inheritance diagram for nmealib::nmea0183::VTG:

[legend]

Collaboration diagram for nmealib::nmea0183::VTG:

[legend]

Public Member Functions
	VTG (std::string talkerId, double courseOverGroundTrue, double courseOverGroundMagnetic, double speedOverGroundKnots, double speedOverGroundKph, std::optional< char > faaModeIndicator=std::nullopt, bool legacyFormat=false)
	Construct a VTG message from individual field values.

	VTG (const VTG &)=default

VTG &	operator= (const VTG &)=default

	VTG (VTG &&) noexcept=default

VTG &	operator= (VTG &&) noexcept=default

	~VTG () override=default

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

double	getCourseOverGroundTrue () const noexcept
	Get true course over ground in degrees.

char	getCourseOverGroundTrueType () const noexcept
	Get true course type indicator (typically 'T', or '\0' in legacy format).

double	getCourseOverGroundMagnetic () const noexcept
	Get magnetic course over ground in degrees.

char	getCourseOverGroundMagneticType () const noexcept
	Get magnetic course type indicator (typically 'M', or '\0' in legacy format).

double	getSpeedOverGroundKnots () const noexcept
	Get speed over ground in knots.

char	getSpeedOverGroundKnotsType () const noexcept
	Get knots unit indicator (typically 'N', or '\0' in legacy format).

double	getSpeedOverGroundKph () const noexcept
	Get speed over ground in kilometers per hour.

char	getSpeedOverGroundKphType () const noexcept
	Get km/h unit indicator (typically 'K', or '\0' in legacy format).

bool	hasFaaModeIndicator () const noexcept
	Return whether FAA mode indicator is present.

std::optional< char >	getFaaModeIndicator () const noexcept
	Get optional FAA mode indicator.

bool	isLegacyFormat () const noexcept
	Return whether this sentence uses legacy compact VTG format.

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

bool	operator== (const VTG &other) const noexcept
	Compare two VTG messages for equality.

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.

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 VTG (Course Over Ground and Ground Speed) sentence.

VTG supports both modern tagged format and a legacy compact format. In legacy format, type indicators are omitted and only numeric values are present.

Modern sentence format:

$--VTG,x.x,T,x.x,M,x.x,N,x.x,K[,a]*hh<CR><LF>

nmealib::nmea0183::VTG

Represents a parsed NMEA 0183 VTG (Course Over Ground and Ground Speed) sentence.

Definition vtg.h:44

Legacy sentence format:

$--VTG,x.x,x.x,x.x,x.x*hh<CR><LF>

Definition at line 44 of file vtg.h.

Constructor & Destructor Documentation

◆ VTG() [1/3]

nmealib::nmea0183::VTG::VTG	(	std::string	talkerId,
		double	courseOverGroundTrue,
		double	courseOverGroundMagnetic,
		double	speedOverGroundKnots,
		double	speedOverGroundKph,
		std::optional< char >	faaModeIndicator = `std::nullopt`,
		bool	legacyFormat = `false`
	)

Construct a VTG message from individual field values.

Parameters

talkerId	Two-character talker identifier.
courseOverGroundTrue	True course over ground in degrees.
courseOverGroundMagnetic	Magnetic course over ground in degrees.
speedOverGroundKnots	Speed over ground in knots.
speedOverGroundKph	Speed over ground in kilometers per hour.
faaModeIndicator	Optional FAA mode indicator for modern format.
legacyFormat	When true, serializes/parses legacy compact format.

Definition at line 131 of file vtg.cpp.

◆ VTG() [2/3]

nmealib::nmea0183::VTG::VTG ( const VTG & )

default

◆ VTG() [3/3]

nmealib::nmea0183::VTG::VTG ( VTG && )

defaultnoexcept

◆ ~VTG()

nmealib::nmea0183::VTG::~VTG ( )

overridedefault

Member Function Documentation

◆ clone()

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

overridevirtual

Create a polymorphic copy of this VTG message.

Returns: std::unique_ptr<nmealib::Message> A heap-allocated copy of this object.

Reimplemented from nmealib::nmea0183::Message0183.

Definition at line 156 of file vtg.cpp.

◆ getCourseOverGroundMagnetic()

double nmealib::nmea0183::VTG::getCourseOverGroundMagnetic ( ) const

noexcept

Get magnetic course over ground in degrees.

Definition at line 228 of file vtg.cpp.

◆ getCourseOverGroundMagneticType()

char nmealib::nmea0183::VTG::getCourseOverGroundMagneticType ( ) const

noexcept

Get magnetic course type indicator (typically 'M', or '\0' in legacy format).

Definition at line 232 of file vtg.cpp.

◆ getCourseOverGroundTrue()

double nmealib::nmea0183::VTG::getCourseOverGroundTrue ( ) const

noexcept

Get true course over ground in degrees.

Definition at line 220 of file vtg.cpp.

◆ getCourseOverGroundTrueType()

char nmealib::nmea0183::VTG::getCourseOverGroundTrueType ( ) const

noexcept

Get true course type indicator (typically 'T', or '\0' in legacy format).

Definition at line 224 of file vtg.cpp.

◆ getFaaModeIndicator()

std::optional< char > nmealib::nmea0183::VTG::getFaaModeIndicator ( ) const

noexcept

Get optional FAA mode indicator.

Definition at line 256 of file vtg.cpp.

◆ getSpeedOverGroundKnots()

double nmealib::nmea0183::VTG::getSpeedOverGroundKnots ( ) const

noexcept

Get speed over ground in knots.

Definition at line 236 of file vtg.cpp.

◆ getSpeedOverGroundKnotsType()

char nmealib::nmea0183::VTG::getSpeedOverGroundKnotsType ( ) const

noexcept

Get knots unit indicator (typically 'N', or '\0' in legacy format).

Definition at line 240 of file vtg.cpp.

◆ getSpeedOverGroundKph()

double nmealib::nmea0183::VTG::getSpeedOverGroundKph ( ) const

noexcept

Get speed over ground in kilometers per hour.

Definition at line 244 of file vtg.cpp.

◆ getSpeedOverGroundKphType()

char nmealib::nmea0183::VTG::getSpeedOverGroundKphType ( ) const

noexcept

Get km/h unit indicator (typically 'K', or '\0' in legacy format).

Definition at line 248 of file vtg.cpp.

◆ getStringContent()

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

overridevirtualnoexcept

Return a human-readable string representation of this message.

Parameters

verbose When true, returns a multi-line detailed representation.

Returns: std::string Formatted string content.

Reimplemented from nmealib::nmea0183::Message0183.

Definition at line 160 of file vtg.cpp.

◆ hasFaaModeIndicator()

bool nmealib::nmea0183::VTG::hasFaaModeIndicator ( ) const

noexcept

Return whether FAA mode indicator is present.

Definition at line 252 of file vtg.cpp.

◆ isLegacyFormat()

bool nmealib::nmea0183::VTG::isLegacyFormat ( ) const

noexcept

Return whether this sentence uses legacy compact VTG format.

Definition at line 260 of file vtg.cpp.

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

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

defaultnoexcept

◆ operator==()

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

noexcept

Compare two VTG messages for equality.

Equality delegates to Message0183::operator==.

Parameters

other The VTG message to compare with.

Returns: bool true if equal, false otherwise.

Definition at line 264 of file vtg.cpp.

Friends And Related Symbol Documentation

◆ MessageRegistry

friend class MessageRegistry

friend

Definition at line 158 of file vtg.h.

◆ Nmea0183Factory

friend class Nmea0183Factory

friend

Definition at line 157 of file vtg.h.

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

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VTG() [1/3]

◆ VTG() [2/3]

◆ VTG() [3/3]

◆ ~VTG()

Member Function Documentation

◆ clone()

◆ getCourseOverGroundMagnetic()

◆ getCourseOverGroundMagneticType()

◆ getCourseOverGroundTrue()

◆ getCourseOverGroundTrueType()

◆ getFaaModeIndicator()

◆ getSpeedOverGroundKnots()

◆ getSpeedOverGroundKnotsType()

◆ getSpeedOverGroundKph()

◆ getSpeedOverGroundKphType()

◆ getStringContent()

◆ hasFaaModeIndicator()

◆ isLegacyFormat()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

Friends And Related Symbol Documentation

◆ MessageRegistry

◆ Nmea0183Factory