#include <vlw.h>

Inheritance diagram for nmealib::nmea0183::VLW:

[legend]

Collaboration diagram for nmealib::nmea0183::VLW:

[legend]

Public Member Functions
	VLW (std::string talkerId, double totalWaterDistanceNm, double waterDistanceSinceResetNm, std::optional< double > totalGroundDistanceNm=std::nullopt, std::optional< double > groundDistanceSinceResetNm=std::nullopt)

	VLW (const VLW &)=default

VLW &	operator= (const VLW &)=default

	VLW (VLW &&) noexcept=default

VLW &	operator= (VLW &&) noexcept=default

	~VLW () override=default

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

double	getTotalWaterDistanceNm () const noexcept

char	getTotalWaterDistanceUnit () const noexcept

double	getWaterDistanceSinceResetNm () const noexcept

char	getWaterDistanceSinceResetUnit () const noexcept

bool	hasGroundDistanceData () const noexcept

double	getTotalGroundDistanceNm () const noexcept

char	getTotalGroundDistanceUnit () const noexcept

double	getGroundDistanceSinceResetNm () const noexcept

char	getGroundDistanceSinceResetUnit () const noexcept

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

bool	operator== (const VLW &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.

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

Definition at line 16 of file vlw.h.

Constructor & Destructor Documentation

◆ VLW() [1/3]

nmealib::nmea0183::VLW::VLW	(	std::string	talkerId,
		double	totalWaterDistanceNm,
		double	waterDistanceSinceResetNm,
		std::optional< double >	totalGroundDistanceNm = `std::nullopt`,
		std::optional< double >	groundDistanceSinceResetNm = `std::nullopt`
	)

Definition at line 99 of file vlw.cpp.

◆ VLW() [2/3]

nmealib::nmea0183::VLW::VLW ( const VLW & )

default

◆ VLW() [3/3]

nmealib::nmea0183::VLW::VLW ( VLW && )

defaultnoexcept

◆ ~VLW()

nmealib::nmea0183::VLW::~VLW ( )

overridedefault

Member Function Documentation

◆ clone()

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

overridevirtual

Creates a polymorphic deep copy of this Message0183.

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

Reimplemented from nmealib::nmea0183::Message0183.

Definition at line 119 of file vlw.cpp.

◆ getGroundDistanceSinceResetNm()

double nmealib::nmea0183::VLW::getGroundDistanceSinceResetNm ( ) const

noexcept

Definition at line 199 of file vlw.cpp.

◆ getGroundDistanceSinceResetUnit()

char nmealib::nmea0183::VLW::getGroundDistanceSinceResetUnit ( ) const

noexcept

Definition at line 203 of file vlw.cpp.

◆ getStringContent()

std::string nmealib::nmea0183::VLW::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 123 of file vlw.cpp.

◆ getTotalGroundDistanceNm()

double nmealib::nmea0183::VLW::getTotalGroundDistanceNm ( ) const

noexcept

Definition at line 191 of file vlw.cpp.

◆ getTotalGroundDistanceUnit()

char nmealib::nmea0183::VLW::getTotalGroundDistanceUnit ( ) const

noexcept

Definition at line 195 of file vlw.cpp.

◆ getTotalWaterDistanceNm()

double nmealib::nmea0183::VLW::getTotalWaterDistanceNm ( ) const

noexcept

Definition at line 171 of file vlw.cpp.

◆ getTotalWaterDistanceUnit()

char nmealib::nmea0183::VLW::getTotalWaterDistanceUnit ( ) const

noexcept

Definition at line 175 of file vlw.cpp.

◆ getWaterDistanceSinceResetNm()

double nmealib::nmea0183::VLW::getWaterDistanceSinceResetNm ( ) const

noexcept

Definition at line 179 of file vlw.cpp.

◆ getWaterDistanceSinceResetUnit()

char nmealib::nmea0183::VLW::getWaterDistanceSinceResetUnit ( ) const

noexcept

Definition at line 183 of file vlw.cpp.

◆ hasGroundDistanceData()

bool nmealib::nmea0183::VLW::hasGroundDistanceData ( ) const

noexcept

Definition at line 187 of file vlw.cpp.

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

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

defaultnoexcept

◆ operator==()

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

noexcept

Definition at line 207 of file vlw.cpp.

Friends And Related Symbol Documentation

◆ MessageRegistry

friend class MessageRegistry

friend

Definition at line 79 of file vlw.h.

◆ Nmea0183Factory

friend class Nmea0183Factory

friend

Definition at line 78 of file vlw.h.

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

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VLW() [1/3]

◆ VLW() [2/3]

◆ VLW() [3/3]

◆ ~VLW()

Member Function Documentation

◆ clone()

◆ getGroundDistanceSinceResetNm()

◆ getGroundDistanceSinceResetUnit()

◆ getStringContent()

◆ getTotalGroundDistanceNm()

◆ getTotalGroundDistanceUnit()

◆ getTotalWaterDistanceNm()

◆ getTotalWaterDistanceUnit()

◆ getWaterDistanceSinceResetNm()

◆ getWaterDistanceSinceResetUnit()

◆ hasGroundDistanceData()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

Friends And Related Symbol Documentation

◆ MessageRegistry

◆ Nmea0183Factory