OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Nmea2000Msg Class Reference

See: https://github.com/OpenCPN/OpenCPN/issues/2729#issuecomment-1179506343. More...

#include <comm_navmsg.h>

Inheritance diagram for Nmea2000Msg:
NavMsg KeyProvider

Public Member Functions

 Nmea2000Msg (const uint64_t _pgn)
 
 Nmea2000Msg (const uint64_t _pgn, std::shared_ptr< const NavAddr2000 > src)
 
 Nmea2000Msg (const uint64_t _pgn, const std::vector< unsigned char > &_payload, std::shared_ptr< const NavAddr2000 > src)
 
 Nmea2000Msg (const uint64_t _pgn, const std::vector< unsigned char > &_payload, std::shared_ptr< const NavAddr2000 > src, int _priority)
 
std::string key () const override
 Return unique key used by observable to notify/listen.
 
std::string to_string () const override
 Print "bus key id payload".
 
std::string to_vdr () const override
 Return message in unquoted format used by VDR plugin, see https://opencpn-manuals.github.io/main/vdr/log_format.html.
 
- Public Member Functions inherited from NavMsg
std::string GetKey () const
 Alias for key().
 

Public Attributes

N2kPGN PGN
 
std::vector< unsigned char > payload
 
int priority
 
- Public Attributes inherited from NavMsg
const NavAddr::Bus bus
 
std::shared_ptr< const NavAddr > source
 Source address is set by drivers when receiving, unused and should be empty when sending.
 
const NavmsgTimePoint created_at
 

Additional Inherited Members

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

Detailed Description

See: https://github.com/OpenCPN/OpenCPN/issues/2729#issuecomment-1179506343.

Definition at line 264 of file comm_navmsg.h.

Constructor & Destructor Documentation

◆ Nmea2000Msg() [1/4]

Nmea2000Msg::Nmea2000Msg ( const uint64_t  _pgn)
inline

Definition at line 266 of file comm_navmsg.h.

◆ Nmea2000Msg() [2/4]

Nmea2000Msg::Nmea2000Msg ( const uint64_t  _pgn,
std::shared_ptr< const NavAddr2000 >  src 
)
inline

Definition at line 269 of file comm_navmsg.h.

◆ Nmea2000Msg() [3/4]

Nmea2000Msg::Nmea2000Msg ( const uint64_t  _pgn,
const std::vector< unsigned char > &  _payload,
std::shared_ptr< const NavAddr2000 >  src 
)
inline

Definition at line 272 of file comm_navmsg.h.

◆ Nmea2000Msg() [4/4]

Nmea2000Msg::Nmea2000Msg ( const uint64_t  _pgn,
const std::vector< unsigned char > &  _payload,
std::shared_ptr< const NavAddr2000 >  src,
int  _priority 
)
inline

Definition at line 276 of file comm_navmsg.h.

Member Function Documentation

◆ key()

std::string Nmea2000Msg::key ( ) const
inlineoverridevirtual

Return unique key used by observable to notify/listen.

Implements NavMsg.

Definition at line 285 of file comm_navmsg.h.

◆ to_string()

std::string Nmea2000Msg::to_string ( ) const
overridevirtual

Print "bus key id payload".

Reimplemented from NavMsg.

Definition at line 92 of file comm_navmsg.cpp.

◆ to_vdr()

std::string Nmea2000Msg::to_vdr ( ) const
overridevirtual

Return message in unquoted format used by VDR plugin, see https://opencpn-manuals.github.io/main/vdr/log_format.html.

Reimplemented from NavMsg.

Definition at line 128 of file comm_navmsg.cpp.

Member Data Documentation

◆ payload

std::vector<unsigned char> Nmea2000Msg::payload

Definition at line 295 of file comm_navmsg.h.

◆ PGN

N2kPGN Nmea2000Msg::PGN

Definition at line 294 of file comm_navmsg.h.

◆ priority

int Nmea2000Msg::priority

Definition at line 296 of file comm_navmsg.h.

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