Represents a parsed NMEA 0183 RMC (Recommended Minimum Navigation Information) sentence. More...

#include <rmc.h>

Inheritance diagram for nmealib::nmea0183::RMC:

[legend]

Collaboration diagram for nmealib::nmea0183::RMC:

[legend]

Public Member Functions
	RMC (std::string talkerId, unsigned int utcFix, char status, double latitude, char latitudeDirection, double longitude, char longitudeDirection, double speedOverGround, double courseOverGround, unsigned int date, double magneticVariation, char magneticVariationDirection, char modeIndicator, char navigationStatus)
	Construct an RMC message from individual field values.

	RMC (const RMC &)=default

RMC &	operator= (const RMC &)=default

	RMC (RMC &&) noexcept=default

RMC &	operator= (RMC &&) noexcept=default

	~RMC () override=default

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

unsigned int	getUtcFix () const noexcept
	Get UTC fix time in hhmmss[.ss] numeric form.

char	getStatus () const noexcept
	Get status indicator.

double	getLatitude () const noexcept
	Get latitude in decimal degrees.

char	getLatitudeDirection () const noexcept
	Get latitude hemisphere indicator ('N' or 'S').

double	getLongitude () const noexcept
	Get longitude in decimal degrees.

char	getLongitudeDirection () const noexcept
	Get longitude hemisphere indicator ('E' or 'W').

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

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

unsigned int	getDate () const noexcept
	Get date in ddmmyy numeric form.

double	getMagneticVariation () const noexcept
	Get magnetic variation in degrees.

char	getMagneticVariationDirection () const noexcept
	Get magnetic variation direction ('E' or 'W').

char	getModeIndicator () const noexcept
	Get mode indicator character.

char	getNavigationStatus () const noexcept
	Get navigation status character.

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

bool	operator== (const RMC &other) const noexcept
	Compare two RMC 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 RMC (Recommended Minimum Navigation Information) sentence.

RMC carries core navigation data including UTC time, status, position, speed/course over ground, date, magnetic variation, and mode/status fields.

Sentence format (common modern variant):

$--RMC,hhmmss.ss,A,llll.ll,a,yyyyy.yy,a,x.x,x.x,ddmmyy,x.x,a,a,a*hh<CR><LF>

nmealib::nmea0183::RMC

Represents a parsed NMEA 0183 RMC (Recommended Minimum Navigation Information) sentence.

Definition rmc.h:37

Definition at line 37 of file rmc.h.

Constructor & Destructor Documentation

◆ RMC() [1/3]

nmealib::nmea0183::RMC::RMC	(	std::string	talkerId,
		unsigned int	utcFix,
		char	status,
		double	latitude,
		char	latitudeDirection,
		double	longitude,
		char	longitudeDirection,
		double	speedOverGround,
		double	courseOverGround,
		unsigned int	date,
		double	magneticVariation,
		char	magneticVariationDirection,
		char	modeIndicator,
		char	navigationStatus
	)

Construct an RMC message from individual field values.

Latitude and longitude are expected in decimal degrees and are serialized to NMEA coordinate format in the wire sentence.

Parameters

talkerId	Two-character talker identifier.
utcFix	UTC time in hhmmss[.ss] numeric form.
status	Navigation receiver warning/status indicator.
latitude	Latitude in decimal degrees.
latitudeDirection	Latitude hemisphere indicator ('N' or 'S').
longitude	Longitude in decimal degrees.
longitudeDirection	Longitude hemisphere indicator ('E' or 'W').
speedOverGround	Speed over ground in knots.
courseOverGround	Course over ground in degrees.
date	Date in ddmmyy numeric form.
magneticVariation	Magnetic variation in degrees.
magneticVariationDirection	Magnetic variation direction ('E' or 'W').
modeIndicator	Optional mode indicator.
navigationStatus	Navigation status indicator.

Definition at line 123 of file rmc.cpp.

◆ RMC() [2/3]

nmealib::nmea0183::RMC::RMC ( const RMC & )

default

◆ RMC() [3/3]

nmealib::nmea0183::RMC::RMC ( RMC && )

defaultnoexcept

◆ ~RMC()

nmealib::nmea0183::RMC::~RMC ( )

overridedefault

Member Function Documentation

◆ clone()

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

overridevirtual

Create a polymorphic copy of this RMC message.

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

Reimplemented from nmealib::nmea0183::Message0183.

Definition at line 154 of file rmc.cpp.

◆ getCourseOverGround()

double nmealib::nmea0183::RMC::getCourseOverGround ( ) const

noexcept

Get course over ground in degrees.

Definition at line 263 of file rmc.cpp.

◆ getDate()

unsigned int nmealib::nmea0183::RMC::getDate ( ) const

noexcept

Get date in ddmmyy numeric form.

Definition at line 267 of file rmc.cpp.

◆ getLatitude()

double nmealib::nmea0183::RMC::getLatitude ( ) const

noexcept

Get latitude in decimal degrees.

Definition at line 243 of file rmc.cpp.

◆ getLatitudeDirection()

char nmealib::nmea0183::RMC::getLatitudeDirection ( ) const

noexcept

Get latitude hemisphere indicator ('N' or 'S').

Definition at line 247 of file rmc.cpp.

◆ getLongitude()

double nmealib::nmea0183::RMC::getLongitude ( ) const

noexcept

Get longitude in decimal degrees.

Definition at line 251 of file rmc.cpp.

◆ getLongitudeDirection()

char nmealib::nmea0183::RMC::getLongitudeDirection ( ) const

noexcept

Get longitude hemisphere indicator ('E' or 'W').

Definition at line 255 of file rmc.cpp.

◆ getMagneticVariation()

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

noexcept

Get magnetic variation in degrees.

Definition at line 271 of file rmc.cpp.

◆ getMagneticVariationDirection()

char nmealib::nmea0183::RMC::getMagneticVariationDirection ( ) const

noexcept

Get magnetic variation direction ('E' or 'W').

Definition at line 275 of file rmc.cpp.

◆ getModeIndicator()

char nmealib::nmea0183::RMC::getModeIndicator ( ) const

noexcept

Get mode indicator character.

Definition at line 279 of file rmc.cpp.

◆ getNavigationStatus()

char nmealib::nmea0183::RMC::getNavigationStatus ( ) const

noexcept

Get navigation status character.

Definition at line 283 of file rmc.cpp.

◆ getSpeedOverGround()

double nmealib::nmea0183::RMC::getSpeedOverGround ( ) const

noexcept

Get speed over ground in knots.

Definition at line 259 of file rmc.cpp.

◆ getStatus()

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

noexcept

Get status indicator.

Definition at line 239 of file rmc.cpp.

◆ getStringContent()

std::string nmealib::nmea0183::RMC::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 158 of file rmc.cpp.

◆ getUtcFix()

unsigned int nmealib::nmea0183::RMC::getUtcFix ( ) const

noexcept

Get UTC fix time in hhmmss[.ss] numeric form.

Definition at line 235 of file rmc.cpp.

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

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

defaultnoexcept

◆ operator==()

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

noexcept

Compare two RMC messages for equality.

Equality delegates to Message0183::operator==.

Parameters

other The RMC message to compare with.

Returns: bool true if equal, false otherwise.

Definition at line 287 of file rmc.cpp.

Friends And Related Symbol Documentation

◆ MessageRegistry

friend class MessageRegistry

friend

Definition at line 184 of file rmc.h.

◆ Nmea0183Factory

friend class Nmea0183Factory

friend

Definition at line 183 of file rmc.h.

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

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RMC() [1/3]

◆ RMC() [2/3]

◆ RMC() [3/3]

◆ ~RMC()

Member Function Documentation

◆ clone()

◆ getCourseOverGround()

◆ getDate()

◆ getLatitude()

◆ getLatitudeDirection()

◆ getLongitude()

◆ getLongitudeDirection()

◆ getMagneticVariation()

◆ getMagneticVariationDirection()

◆ getModeIndicator()

◆ getNavigationStatus()

◆ getSpeedOverGround()

◆ getStatus()

◆ getStringContent()

◆ getUtcFix()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

Friends And Related Symbol Documentation

◆ MessageRegistry

◆ Nmea0183Factory