Represents a parsed NMEA 0183 MWV (Wind Speed and Angle) sentence. More...

#include <mwv.h>

Inheritance diagram for nmealib::nmea0183::MWV:

[legend]

Collaboration diagram for nmealib::nmea0183::MWV:

[legend]

Public Member Functions
	MWV (std::string talkerId, double windAngle, char reference, double windSpeed, char windSpeedUnits, char status)
	Construct an MWV message from individual field values.

	MWV (const MWV &)=default

MWV &	operator= (const MWV &)=default

	MWV (MWV &&) noexcept=default

MWV &	operator= (MWV &&) noexcept=default

	~MWV () override=default

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

double	getWindAngle () const noexcept
	Get wind angle in degrees.

char	getReference () const noexcept
	Get reference indicator.

double	getWindSpeed () const noexcept
	Get wind speed value.

char	getWindSpeedUnits () const noexcept
	Get wind speed unit indicator.

char	getStatus () const noexcept
	Get data status indicator.

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

bool	operator== (const MWV &other) const noexcept
	Compare two MWV 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 MWV (Wind Speed and Angle) sentence.

The MWV sentence reports wind angle and speed relative to either true or apparent reference.

Sentence format:

$--MWV,x.x,a,x.x,u,s*hh<CR><LF>

nmealib::nmea0183::MWV

Represents a parsed NMEA 0183 MWV (Wind Speed and Angle) sentence.

Definition mwv.h:37

Definition at line 37 of file mwv.h.

Constructor & Destructor Documentation

◆ MWV() [1/3]

nmealib::nmea0183::MWV::MWV	(	std::string	talkerId,
		double	windAngle,
		char	reference,
		double	windSpeed,
		char	windSpeedUnits,
		char	status
	)

Construct an MWV message from individual field values.

Parameters

talkerId	Two-character talker identifier.
windAngle	Wind angle in degrees.
reference	Wind reference indicator (for example 'R' or 'T').
windSpeed	Wind speed value.
windSpeedUnits	Wind speed unit indicator.
status	Data status indicator.

Definition at line 72 of file mwv.cpp.

◆ MWV() [2/3]

nmealib::nmea0183::MWV::MWV ( const MWV & )

default

◆ MWV() [3/3]

nmealib::nmea0183::MWV::MWV ( MWV && )

defaultnoexcept

◆ ~MWV()

nmealib::nmea0183::MWV::~MWV ( )

overridedefault

Member Function Documentation

◆ clone()

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

overridevirtual

Create a polymorphic copy of this MWV message.

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

Reimplemented from nmealib::nmea0183::Message0183.

Definition at line 90 of file mwv.cpp.

◆ getReference()

char nmealib::nmea0183::MWV::getReference ( ) const

noexcept

Get reference indicator.

Definition at line 135 of file mwv.cpp.

◆ getStatus()

char nmealib::nmea0183::MWV::getStatus ( ) const

noexcept

Get data status indicator.

Definition at line 147 of file mwv.cpp.

◆ getStringContent()

std::string nmealib::nmea0183::MWV::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 94 of file mwv.cpp.

◆ getWindAngle()

double nmealib::nmea0183::MWV::getWindAngle ( ) const

noexcept

Get wind angle in degrees.

Definition at line 131 of file mwv.cpp.

◆ getWindSpeed()

double nmealib::nmea0183::MWV::getWindSpeed ( ) const

noexcept

Get wind speed value.

Definition at line 139 of file mwv.cpp.

◆ getWindSpeedUnits()

char nmealib::nmea0183::MWV::getWindSpeedUnits ( ) const

noexcept

Get wind speed unit indicator.

Definition at line 143 of file mwv.cpp.

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

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

defaultnoexcept

◆ operator==()

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

noexcept

Compare two MWV messages for equality.

Equality delegates to Message0183::operator==.

Parameters

other The MWV message to compare with.

Returns: bool true if equal, false otherwise.

Definition at line 151 of file mwv.cpp.

Friends And Related Symbol Documentation

◆ MessageRegistry

friend class MessageRegistry

friend

Definition at line 126 of file mwv.h.

◆ Nmea0183Factory

friend class Nmea0183Factory

friend

Definition at line 125 of file mwv.h.

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

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MWV() [1/3]

◆ MWV() [2/3]

◆ MWV() [3/3]

◆ ~MWV()

Member Function Documentation

◆ clone()

◆ getReference()

◆ getStatus()

◆ getStringContent()

◆ getWindAngle()

◆ getWindSpeed()

◆ getWindSpeedUnits()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

Friends And Related Symbol Documentation

◆ MessageRegistry

◆ Nmea0183Factory