Represents a parsed NMEA 0183 ZDA (Time and Date) sentence. More...

#include <zda.h>

Inheritance diagram for nmealib::nmea0183::ZDA:

[legend]

Collaboration diagram for nmealib::nmea0183::ZDA:

[legend]

Public Member Functions
	ZDA (std::string talkerId, double utcTime, unsigned int day, unsigned int month, unsigned int year, int localZoneHours, int localZoneMinutes)
	Construct a ZDA message from individual field values.

	ZDA (const ZDA &)=default

ZDA &	operator= (const ZDA &)=default

	ZDA (ZDA &&) noexcept=default

ZDA &	operator= (ZDA &&) noexcept=default

	~ZDA () override=default

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

double	getUtcTime () const noexcept
	Get UTC time in hhmmss.ss numeric form.

unsigned int	getDay () const noexcept
	Get day of month.

unsigned int	getMonth () const noexcept
	Get month number.

unsigned int	getYear () const noexcept
	Get four-digit year.

int	getLocalZoneHours () const noexcept
	Get local zone offset hours.

int	getLocalZoneMinutes () const noexcept
	Get local zone offset minutes.

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

bool	operator== (const ZDA &other) const noexcept
	Compare two ZDA 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 ZDA (Time and Date) sentence.

ZDA carries UTC time, calendar date, and local zone offset.

Sentence format:

$--ZDA,hhmmss.ss,dd,mm,yyyy,zh,zm*hh<CR><LF>

nmealib::nmea0183::ZDA

Represents a parsed NMEA 0183 ZDA (Time and Date) sentence.

Definition zda.h:36

Definition at line 36 of file zda.h.

Constructor & Destructor Documentation

◆ ZDA() [1/3]

nmealib::nmea0183::ZDA::ZDA	(	std::string	talkerId,
		double	utcTime,
		unsigned int	day,
		unsigned int	month,
		unsigned int	year,
		int	localZoneHours,
		int	localZoneMinutes
	)

Construct a ZDA message from individual field values.

Parameters

talkerId	Two-character talker identifier.
utcTime	UTC time in hhmmss.ss numeric form.
day	Day of month.
month	Month number.
year	Four-digit year.
localZoneHours	Local zone offset hours.
localZoneMinutes	Local zone offset minutes.

Definition at line 80 of file zda.cpp.

◆ ZDA() [2/3]

nmealib::nmea0183::ZDA::ZDA ( const ZDA & )

default

◆ ZDA() [3/3]

nmealib::nmea0183::ZDA::ZDA ( ZDA && )

defaultnoexcept

◆ ~ZDA()

nmealib::nmea0183::ZDA::~ZDA ( )

overridedefault

Member Function Documentation

◆ clone()

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

overridevirtual

Create a polymorphic copy of this ZDA message.

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

Reimplemented from nmealib::nmea0183::Message0183.

Definition at line 101 of file zda.cpp.

◆ getDay()

unsigned int nmealib::nmea0183::ZDA::getDay ( ) const

noexcept

Get day of month.

Definition at line 151 of file zda.cpp.

◆ getLocalZoneHours()

int nmealib::nmea0183::ZDA::getLocalZoneHours ( ) const

noexcept

Get local zone offset hours.

Definition at line 163 of file zda.cpp.

◆ getLocalZoneMinutes()

int nmealib::nmea0183::ZDA::getLocalZoneMinutes ( ) const

noexcept

Get local zone offset minutes.

Definition at line 167 of file zda.cpp.

◆ getMonth()

unsigned int nmealib::nmea0183::ZDA::getMonth ( ) const

noexcept

Get month number.

Definition at line 155 of file zda.cpp.

◆ getStringContent()

std::string nmealib::nmea0183::ZDA::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 105 of file zda.cpp.

◆ getUtcTime()

double nmealib::nmea0183::ZDA::getUtcTime ( ) const

noexcept

Get UTC time in hhmmss.ss numeric form.

Definition at line 147 of file zda.cpp.

◆ getYear()

unsigned int nmealib::nmea0183::ZDA::getYear ( ) const

noexcept

Get four-digit year.

Definition at line 159 of file zda.cpp.

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

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

defaultnoexcept

◆ operator==()

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

noexcept

Compare two ZDA messages for equality.

Equality delegates to Message0183::operator==.

Parameters

other The ZDA message to compare with.

Returns: bool true if equal, false otherwise.

Definition at line 171 of file zda.cpp.

Friends And Related Symbol Documentation

◆ MessageRegistry

friend class MessageRegistry

friend

Definition at line 132 of file zda.h.

◆ Nmea0183Factory

friend class Nmea0183Factory

friend

Definition at line 131 of file zda.h.

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

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ZDA() [1/3]

◆ ZDA() [2/3]

◆ ZDA() [3/3]

◆ ~ZDA()

Member Function Documentation

◆ clone()

◆ getDay()

◆ getLocalZoneHours()

◆ getLocalZoneMinutes()

◆ getMonth()

◆ getStringContent()

◆ getUtcTime()

◆ getYear()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

Friends And Related Symbol Documentation

◆ MessageRegistry

◆ Nmea0183Factory