Represents a parsed NMEA 0183 DBT (Depth Below Transducer) sentence. More...

#include <dbt.h>

Inheritance diagram for nmealib::nmea0183::DBT:

[legend]

Collaboration diagram for nmealib::nmea0183::DBT:

[legend]

Public Member Functions
	DBT (std::string talkerId, double depthFeet, char feetUnit, double depthMeters, char metersUnit, double depthFathoms, char fathomsUnit)
	Construct a DBT message from individual field values.

	DBT (const DBT &)=default

DBT &	operator= (const DBT &)=default

	DBT (DBT &&) noexcept=default

DBT &	operator= (DBT &&) noexcept=default

	~DBT () override=default

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

double	getDepthFeet () const noexcept
	Get the depth in feet.

char	getFeetUnit () const noexcept
	Get the feet unit indicator.

double	getDepthMeters () const noexcept
	Get the depth in meters.

char	getMetersUnit () const noexcept
	Get the meters unit indicator.

double	getDepthFathoms () const noexcept
	Get the depth in fathoms.

char	getFathomsUnit () const noexcept
	Get the fathoms unit indicator.

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

bool	operator== (const DBT &other) const noexcept
	Compare two DBT 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 DBT (Depth Below Transducer) sentence.

The DBT sentence reports measured depth in three units: feet, meters, and fathoms.

Sentence format:

$--DBT,x.x,f,x.x,M,x.x,F*hh<CR><LF>

nmealib::nmea0183::DBT

Represents a parsed NMEA 0183 DBT (Depth Below Transducer) sentence.

Definition dbt.h:37

Definition at line 37 of file dbt.h.

Constructor & Destructor Documentation

◆ DBT() [1/3]

nmealib::nmea0183::DBT::DBT	(	std::string	talkerId,
		double	depthFeet,
		char	feetUnit,
		double	depthMeters,
		char	metersUnit,
		double	depthFathoms,
		char	fathomsUnit
	)

Construct a DBT message from individual field values.

Parameters

talkerId	Two-character talker identifier.
depthFeet	Depth value in feet.
feetUnit	Unit indicator for feet field (typically 'f').
depthMeters	Depth value in meters.
metersUnit	Unit indicator for meter field (typically 'M').
depthFathoms	Depth value in fathoms.
fathomsUnit	Unit indicator for fathom field (typically 'F').

Definition at line 77 of file dbt.cpp.

◆ DBT() [2/3]

nmealib::nmea0183::DBT::DBT ( const DBT & )

default

◆ DBT() [3/3]

nmealib::nmea0183::DBT::DBT ( DBT && )

defaultnoexcept

◆ ~DBT()

nmealib::nmea0183::DBT::~DBT ( )

overridedefault

Member Function Documentation

◆ clone()

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

overridevirtual

Create a polymorphic copy of this DBT message.

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

Implements nmealib::Message.

Definition at line 98 of file dbt.cpp.

◆ getDepthFathoms()

double nmealib::nmea0183::DBT::getDepthFathoms ( ) const

noexcept

Get the depth in fathoms.

Returns: double Depth value in fathoms.

Definition at line 156 of file dbt.cpp.

◆ getDepthFeet()

double nmealib::nmea0183::DBT::getDepthFeet ( ) const

noexcept

Get the depth in feet.

Returns: double Depth value in feet.

Definition at line 140 of file dbt.cpp.

◆ getDepthMeters()

double nmealib::nmea0183::DBT::getDepthMeters ( ) const

noexcept

Get the depth in meters.

Returns: double Depth value in meters.

Definition at line 148 of file dbt.cpp.

◆ getFathomsUnit()

char nmealib::nmea0183::DBT::getFathomsUnit ( ) const

noexcept

Get the fathoms unit indicator.

Returns: char Unit indicator for fathoms (typically 'F').

Definition at line 160 of file dbt.cpp.

◆ getFeetUnit()

char nmealib::nmea0183::DBT::getFeetUnit ( ) const

noexcept

Get the feet unit indicator.

Returns: char Unit indicator for feet (typically 'f').

Definition at line 144 of file dbt.cpp.

◆ getMetersUnit()

char nmealib::nmea0183::DBT::getMetersUnit ( ) const

noexcept

Get the meters unit indicator.

Returns: char Unit indicator for meters (typically 'M').

Definition at line 152 of file dbt.cpp.

◆ getStringContent()

std::string nmealib::nmea0183::DBT::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 102 of file dbt.cpp.

◆ operator=() [1/2]

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

default

◆ operator=() [2/2]

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

defaultnoexcept

◆ operator==()

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

noexcept

Compare two DBT messages for equality.

Equality delegates to Message0183::operator==.

Parameters

other The DBT message to compare with.

Returns: bool true if equal, false otherwise.

Definition at line 164 of file dbt.cpp.

Friends And Related Symbol Documentation

◆ MessageRegistry

friend class MessageRegistry

friend

Definition at line 162 of file dbt.h.

◆ Nmea0183Factory

friend class Nmea0183Factory

friend

Definition at line 161 of file dbt.h.

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

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DBT() [1/3]

◆ DBT() [2/3]

◆ DBT() [3/3]

◆ ~DBT()

Member Function Documentation

◆ clone()

◆ getDepthFathoms()

◆ getDepthFeet()

◆ getDepthMeters()

◆ getFathomsUnit()

◆ getFeetUnit()

◆ getMetersUnit()

◆ getStringContent()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

Friends And Related Symbol Documentation

◆ MessageRegistry

◆ Nmea0183Factory