Goby3  3.1.5a
2024.05.23
goby::util::NMEASentence Class Reference

#include <goby/util/linebasedcomms/nmea_sentence.h>

Inheritance diagram for goby::util::NMEASentence:

Public Types

enum  strategy { IGNORE, VALIDATE, REQUIRE }
 

Public Member Functions

 NMEASentence ()=default
 
 NMEASentence (std::string s, strategy cs_strat=VALIDATE)
 
std::string message_no_cs () const
 
std::string message () const
 
std::string message_cr_nl () const
 
std::string talker_id () const
 
std::string sentence_id () const
 
template<typename T >
as (int i) const
 
template<typename T >
void push_back (T t)
 
void push_back (const std::string &str)
 

Static Public Member Functions

static unsigned char checksum (const std::string &s)
 

Static Public Attributes

static bool enforce_talker_length
 

Detailed Description

Definition at line 51 of file nmea_sentence.h.

Member Enumeration Documentation

◆ strategy

Enumerator
IGNORE 
VALIDATE 
REQUIRE 

Definition at line 54 of file nmea_sentence.h.

Constructor & Destructor Documentation

◆ NMEASentence() [1/2]

goby::util::NMEASentence::NMEASentence ( )
default

◆ NMEASentence() [2/2]

goby::util::NMEASentence::NMEASentence ( std::string  s,
strategy  cs_strat = VALIDATE 
)

Member Function Documentation

◆ as()

template<typename T >
T goby::util::NMEASentence::as ( int  i) const
inline

Definition at line 79 of file nmea_sentence.h.

◆ checksum()

static unsigned char goby::util::NMEASentence::checksum ( const std::string &  s)
static

◆ message()

std::string goby::util::NMEASentence::message ( ) const

◆ message_cr_nl()

std::string goby::util::NMEASentence::message_cr_nl ( ) const
inline

Definition at line 71 of file nmea_sentence.h.

◆ message_no_cs()

std::string goby::util::NMEASentence::message_no_cs ( ) const

◆ push_back() [1/2]

void goby::util::NMEASentence::push_back ( const std::string &  str)
inline

Definition at line 85 of file nmea_sentence.h.

◆ push_back() [2/2]

template<typename T >
void goby::util::NMEASentence::push_back ( t)
inline

Definition at line 81 of file nmea_sentence.h.

◆ sentence_id()

std::string goby::util::NMEASentence::sentence_id ( ) const
inline

Definition at line 77 of file nmea_sentence.h.

◆ talker_id()

std::string goby::util::NMEASentence::talker_id ( ) const
inline

Definition at line 74 of file nmea_sentence.h.

Member Data Documentation

◆ enforce_talker_length

bool goby::util::NMEASentence::enforce_talker_length
static

Definition at line 103 of file nmea_sentence.h.


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