OpenCPN Partial API docs
Loading...
Searching...
No Matches
Nmea0183Msg Class Reference

A regular Nmea0183 message. More...

#include <comm_navmsg.h>

Inheritance diagram for Nmea0183Msg:
NavMsg KeyProvider

Public Member Functions

 Nmea0183Msg (const std::string &id, const std::string &_payload, std::shared_ptr< const NavAddr > src)
 
 Nmea0183Msg (const std::string &id)
 
 Nmea0183Msg (const Nmea0183Msg &other, const std::string &t)
 
std::string key () const
 
std::string to_string () const
 
- Public Member Functions inherited from NavMsg
virtual std::string key () const =0
 
virtual std::string to_string () const
 
std::string GetKey () const
 Return key used to listen and notify. More...
 
virtual std::string GetKey () const =0
 Return key used to listen and notify. More...
 

Static Public Member Functions

static std::string MessageKey (const char *type="ALL")
 Return key which should be used to listen to given message type. More...
 

Public Attributes

const std::string talker
 For example 'GP'. More...
 
const std::string type
 For example 'GGA'. More...
 
const std::string payload
 Complete NMEA0183 sentence, also prefix. More...
 
- Public Attributes inherited from NavMsg
const NavAddr::Bus bus
 
std::shared_ptr< const NavAddrsource
 

Additional Inherited Members

- Protected Member Functions inherited from NavMsg
 NavMsg (const NavAddr::Bus &_bus, std::shared_ptr< const NavAddr > src)
 

Detailed Description

A regular Nmea0183 message.

Definition at line 241 of file comm_navmsg.h.

Constructor & Destructor Documentation

◆ Nmea0183Msg() [1/4]

Nmea0183Msg::Nmea0183Msg ( const std::string &  id,
const std::string &  _payload,
std::shared_ptr< const NavAddr src 
)
inline

Definition at line 243 of file comm_navmsg.h.

◆ Nmea0183Msg() [2/4]

Nmea0183Msg::Nmea0183Msg ( )
inline

Definition at line 250 of file comm_navmsg.h.

◆ Nmea0183Msg() [3/4]

Nmea0183Msg::Nmea0183Msg ( const std::string &  id)
inline

Definition at line 253 of file comm_navmsg.h.

◆ Nmea0183Msg() [4/4]

Nmea0183Msg::Nmea0183Msg ( const Nmea0183Msg other,
const std::string &  t 
)
inline

Definition at line 257 of file comm_navmsg.h.

Member Function Documentation

◆ key()

std::string Nmea0183Msg::key ( ) const
inlinevirtual

Implements NavMsg.

Definition at line 265 of file comm_navmsg.h.

◆ MessageKey()

static std::string Nmea0183Msg::MessageKey ( const char *  type = "ALL")
inlinestatic

Return key which should be used to listen to given message type.

Definition at line 272 of file comm_navmsg.h.

◆ to_string()

std::string Nmea0183Msg::to_string ( ) const
inlinevirtual

Reimplemented from NavMsg.

Definition at line 267 of file comm_navmsg.h.

Member Data Documentation

◆ payload

const std::string Nmea0183Msg::payload

Complete NMEA0183 sentence, also prefix.

Definition at line 279 of file comm_navmsg.h.

◆ talker

const std::string Nmea0183Msg::talker

For example 'GP'.

Definition at line 277 of file comm_navmsg.h.

◆ type

const std::string Nmea0183Msg::type

For example 'GGA'.

Definition at line 278 of file comm_navmsg.h.


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