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

Message withg decoded values, available on AppMsgBus. More...

#include <comm_appmsg.h>

Inheritance diagram for AppMsg:
KeyProvider AisData BasicNavDataMsg CustomMsg DataPrioNeeded GPSWatchdogMsg GnssFix

Public Types

enum class  Type {
  BasicNavData , GPSWatchdog , GnssFix , AisData ,
  DataPrioNeeded , CustomMsg , Undef
}
 

Public Member Functions

 AppMsg (AppMsg::Type t)
 
virtual std::string key () const
 
std::string GetKey () const
 Return key used to listen and notify. More...
 
std::string TypeToString (const Type t) const
 
virtual std::string GetKey () const =0
 Return key used to listen and notify. More...
 

Public Attributes

const Type type
 
const std::string name
 
NavAddr source
 
unsigned short prio
 

Protected Member Functions

 AppMsg (AppMsg::Type tp, const std::string &nm, NavAddr src)
 

Detailed Description

Message withg decoded values, available on AppMsgBus.

Definition at line 90 of file comm_appmsg.h.

Member Enumeration Documentation

◆ Type

enum class AppMsg::Type
strong

Definition at line 112 of file comm_appmsg.h.

Constructor & Destructor Documentation

◆ AppMsg() [1/2]

AppMsg::AppMsg ( AppMsg::Type  t)
inline

Definition at line 93 of file comm_appmsg.h.

◆ AppMsg() [2/2]

AppMsg::AppMsg ( AppMsg::Type  tp,
const std::string &  nm,
NavAddr  src 
)
inlineprotected

Definition at line 108 of file comm_appmsg.h.

Member Function Documentation

◆ GetKey()

std::string AppMsg::GetKey ( ) const
inlinevirtual

Return key used to listen and notify.

Implements KeyProvider.

Definition at line 98 of file comm_appmsg.h.

◆ key()

virtual std::string AppMsg::key ( ) const
inlinevirtual

Definition at line 96 of file comm_appmsg.h.

◆ TypeToString()

std::string AppMsg::TypeToString ( const Type  t) const

Definition at line 156 of file comm_appmsg.cpp.

Member Data Documentation

◆ name

const std::string AppMsg::name

Definition at line 103 of file comm_appmsg.h.

◆ prio

unsigned short AppMsg::prio

Definition at line 105 of file comm_appmsg.h.

◆ source

NavAddr AppMsg::source

Definition at line 104 of file comm_appmsg.h.

◆ type

const Type AppMsg::type

Definition at line 102 of file comm_appmsg.h.


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