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

Send only driver facilitating sending messages to all plugins and core. More...

#include <comm_drv_internal.h>

Inheritance diagram for CommDriverInternal:
AbstractCommDriver

Public Member Functions

 CommDriverInternal (DriverListener &l)
 
bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr) override
 Send a message to all plugins and core on internal bus.
 
- Public Member Functions inherited from AbstractCommDriver
virtual void SetListener (DriverListener &l)
 Set the entity which will receive incoming data.
 
virtual std::pair< CommStatus, std::string > Clone ()
 Create a new virtual interface using a new instance of this driver.
 
std::string Key () const
 
virtual std::unordered_map< std::string, std::string > GetAttributes () const
 

Additional Inherited Members

- Public Attributes inherited from AbstractCommDriver
const NavAddr::Bus bus
 
const std::string iface
 Physical device for 0183, else a unique string.
 
std::unordered_map< std::string, std::string > attributes
 
- Protected Member Functions inherited from AbstractCommDriver
 AbstractCommDriver (NavAddr::Bus b)
 
 AbstractCommDriver (NavAddr::Bus b, const std::string &s)
 

Detailed Description

Send only driver facilitating sending messages to all plugins and core.

Definition at line 33 of file comm_drv_internal.h.

Constructor & Destructor Documentation

◆ CommDriverInternal()

CommDriverInternal::CommDriverInternal ( DriverListener l)

Definition at line 43 of file comm_drv_internal.cpp.

Member Function Documentation

◆ SendMessage()

bool CommDriverInternal::SendMessage ( std::shared_ptr< const NavMsg msg,
std::shared_ptr< const NavAddr addr 
)
overridevirtual

Send a message to all plugins and core on internal bus.

Parameters
msgMust be PluginMsg, by convention a type + a json encoded string.
addrNot used

Implements AbstractCommDriver.

Definition at line 50 of file comm_drv_internal.cpp.


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