Represents a parsed NMEA 0183 DPT (Depth of Water) sentence. More...

#include <dpt.h>

Inheritance diagram for nmealib::nmea0183::DPT:

[legend]

Collaboration diagram for nmealib::nmea0183::DPT:

[legend]

Public Member Functions
	DPT (std::string talkerId, double waterDepthMeters, double transducerOffset, double maxRangeScale)
	Construct a DPT message from individual field values.

	DPT (const DPT &)=default

DPT &	operator= (const DPT &)=default

	DPT (DPT &&) noexcept=default

DPT &	operator= (DPT &&) noexcept=default

	~DPT () override=default

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

double	getWaterDepthMeters () const noexcept
	Get water depth in meters.

double	getTransducerOffset () const noexcept
	Get transducer offset in meters.

double	getMaxRangeScale () const noexcept
	Get maximum range scale in meters.

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

bool	operator== (const DPT &other) const noexcept
	Compare two DPT 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.

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

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 DPT (Depth of Water) sentence.

The DPT sentence reports water depth relative to the transducer, the transducer offset, and optionally the maximum range scale in use.

Sentence format:

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

nmealib::nmea0183::DPT

Represents a parsed NMEA 0183 DPT (Depth of Water) sentence.

Definition dpt.h:37

Definition at line 37 of file dpt.h.

Constructor & Destructor Documentation

◆ DPT() [1/3]

nmealib::nmea0183::DPT::DPT	(	std::string	talkerId,
		double	waterDepthMeters,
		double	transducerOffset,
		double	maxRangeScale
	)

Construct a DPT message from individual field values.

Parameters

talkerId	Two-character talker identifier.
waterDepthMeters	Depth relative to transducer, meters.
transducerOffset	Transducer offset, meters.
maxRangeScale	Maximum range scale, meters.

Definition at line 64 of file dpt.cpp.

◆ DPT() [2/3]

nmealib::nmea0183::DPT::DPT ( const DPT & )

default

◆ DPT() [3/3]

nmealib::nmea0183::DPT::DPT ( DPT && )

defaultnoexcept

◆ ~DPT()

nmealib::nmea0183::DPT::~DPT ( )

overridedefault

Member Function Documentation

◆ clone()

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

overridevirtual

Create a polymorphic copy of this DPT message.

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

Implements nmealib::Message.

Definition at line 76 of file dpt.cpp.

◆ getMaxRangeScale()

double nmealib::nmea0183::DPT::getMaxRangeScale ( ) const

noexcept

Get maximum range scale in meters.

Definition at line 119 of file dpt.cpp.

◆ getStringContent()

std::string nmealib::nmea0183::DPT::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 80 of file dpt.cpp.

◆ getTransducerOffset()

double nmealib::nmea0183::DPT::getTransducerOffset ( ) const

noexcept

Get transducer offset in meters.

Definition at line 115 of file dpt.cpp.

◆ getWaterDepthMeters()

double nmealib::nmea0183::DPT::getWaterDepthMeters ( ) const

noexcept

Get water depth in meters.

Definition at line 111 of file dpt.cpp.

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

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

defaultnoexcept

◆ operator==()

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

noexcept

Compare two DPT messages for equality.

Equality checks both Message0183 base fields and DPT-specific fields.

Parameters

other The DPT message to compare with.

Returns: bool true if equal, false otherwise.

Definition at line 123 of file dpt.cpp.

Friends And Related Symbol Documentation

◆ MessageRegistry

friend class MessageRegistry

friend

Definition at line 112 of file dpt.h.

◆ Nmea0183Factory

friend class Nmea0183Factory

friend

Definition at line 111 of file dpt.h.

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

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DPT() [1/3]

◆ DPT() [2/3]

◆ DPT() [3/3]

◆ ~DPT()

Member Function Documentation

◆ clone()

◆ getMaxRangeScale()

◆ getStringContent()

◆ getTransducerOffset()

◆ getWaterDepthMeters()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

Friends And Related Symbol Documentation

◆ MessageRegistry

◆ Nmea0183Factory