nmealib 0.0.4
NMEA 0183/NMEA 2000 parsing library
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
nmealib::nmea0183::GLL Class Reference

Represents a parsed NMEA 0183 GLL (Geographic Position - Latitude/Longitude) sentence. More...

#include <gll.h>

Inheritance diagram for nmealib::nmea0183::GLL:
Inheritance graph
[legend]
Collaboration diagram for nmealib::nmea0183::GLL:
Collaboration graph
[legend]

Public Member Functions

 GLL (std::string talkerId, double latitude, char latitudeDirection, double longitude, char longitudeDirection, double timestamp, char status, char modeIndicator)
 Construct a GLL message from individual field values.
 
 GLL (const GLL &)=default
 
GLLoperator= (const GLL &)=default
 
 GLL (GLL &&) noexcept=default
 
GLLoperator= (GLL &&) noexcept=default
 
 ~GLL () override=default
 
std::unique_ptr< nmealib::Messageclone () const override
 Create a polymorphic copy of this GLL message.
 
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 getUtcTime () const noexcept
 Get UTC time in hhmmss.ss numeric form.
 
char getStatus () const noexcept
 Get status indicator (typically 'A' or 'V').
 
char getModeIndicator () const noexcept
 Get mode indicator character.
 
std::string getStringContent (bool verbose) const noexcept override
 Return a human-readable string representation of this message.
 
bool operator== (const GLL &other) const noexcept
 Compare two GLL messages for equality.
 
- Public Member Functions inherited from nmealib::nmea0183::Message0183
 Message0183 (const Message0183 &)=default
 Copy constructor.
 
Message0183operator= (const Message0183 &)=default
 Copy assignment operator.
 
 Message0183 (Message0183 &&) noexcept=default
 Move constructor.
 
Message0183operator= (Message0183 &&) noexcept=default
 Move assignment operator.
 
 ~Message0183 () override=default
 Destructor.
 
std::unique_ptr< nmealib::Messageclone () 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
 
Messageoperator= (const Message &)=default
 
 Message (Message &&) noexcept=default
 
Messageoperator= (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< Message0183create (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 GLL (Geographic Position - Latitude/Longitude) sentence.

GLL carries geographic position, UTC time, status, and mode information.

Sentence format:

$--GLL,llll.ll,a,yyyyy.yy,a,hhmmss.ss,A,a*hh<CR><LF>
Represents a parsed NMEA 0183 GLL (Geographic Position - Latitude/Longitude) sentence.
Definition gll.h:36

Definition at line 36 of file gll.h.

Constructor & Destructor Documentation

◆ GLL() [1/3]

nmealib::nmea0183::GLL::GLL ( std::string  talkerId,
double  latitude,
char  latitudeDirection,
double  longitude,
char  longitudeDirection,
double  timestamp,
char  status,
char  modeIndicator 
)

Construct a GLL 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
talkerIdTwo-character talker identifier.
latitudeLatitude in decimal degrees.
latitudeDirectionLatitude hemisphere indicator ('N' or 'S').
longitudeLongitude in decimal degrees.
longitudeDirectionLongitude hemisphere indicator ('E' or 'W').
timestampUTC time in hhmmss.ss format.
statusData status indicator (typically 'A' or 'V').
modeIndicatorMode indicator.

Definition at line 84 of file gll.cpp.

◆ GLL() [2/3]

nmealib::nmea0183::GLL::GLL ( const GLL )
default

◆ GLL() [3/3]

nmealib::nmea0183::GLL::GLL ( GLL &&  )
defaultnoexcept

◆ ~GLL()

nmealib::nmea0183::GLL::~GLL ( )
overridedefault

Member Function Documentation

◆ clone()

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

Create a polymorphic copy of this GLL message.

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

Implements nmealib::Message.

Definition at line 108 of file gll.cpp.

◆ getLatitude()

double nmealib::nmea0183::GLL::getLatitude ( ) const
noexcept

Get latitude in decimal degrees.

Definition at line 171 of file gll.cpp.

◆ getLatitudeDirection()

char nmealib::nmea0183::GLL::getLatitudeDirection ( ) const
noexcept

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

Definition at line 175 of file gll.cpp.

◆ getLongitude()

double nmealib::nmea0183::GLL::getLongitude ( ) const
noexcept

Get longitude in decimal degrees.

Definition at line 179 of file gll.cpp.

◆ getLongitudeDirection()

char nmealib::nmea0183::GLL::getLongitudeDirection ( ) const
noexcept

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

Definition at line 183 of file gll.cpp.

◆ getModeIndicator()

char nmealib::nmea0183::GLL::getModeIndicator ( ) const
noexcept

Get mode indicator character.

Definition at line 195 of file gll.cpp.

◆ getStatus()

char nmealib::nmea0183::GLL::getStatus ( ) const
noexcept

Get status indicator (typically 'A' or 'V').

Definition at line 191 of file gll.cpp.

◆ getStringContent()

std::string nmealib::nmea0183::GLL::getStringContent ( bool  verbose) const
overridevirtualnoexcept

Return a human-readable string representation of this message.

Parameters
verboseWhen true, returns a multi-line detailed representation.
Returns
std::string Formatted string content.

Reimplemented from nmealib::nmea0183::Message0183.

Definition at line 112 of file gll.cpp.

◆ getUtcTime()

double nmealib::nmea0183::GLL::getUtcTime ( ) const
noexcept

Get UTC time in hhmmss.ss numeric form.

Definition at line 187 of file gll.cpp.

◆ operator=() [1/2]

GLL & nmealib::nmea0183::GLL::operator= ( const GLL )
default

◆ operator=() [2/2]

GLL & nmealib::nmea0183::GLL::operator= ( GLL &&  )
defaultnoexcept

◆ operator==()

bool nmealib::nmea0183::GLL::operator== ( const GLL other) const
noexcept

Compare two GLL messages for equality.

Equality delegates to Message0183::operator==.

Parameters
otherThe GLL message to compare with.
Returns
bool true if equal, false otherwise.

Definition at line 199 of file gll.cpp.

Friends And Related Symbol Documentation

◆ MessageRegistry

friend class MessageRegistry
friend

Definition at line 142 of file gll.h.

◆ Nmea0183Factory

friend class Nmea0183Factory
friend

Definition at line 141 of file gll.h.


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