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

Abstract SignalK driver interface. More...

#include <comm_drv_signalk.h>

Inheritance diagram for CommDriverSignalK:
AbstractCommDriver CommDriverSignalKNet

Public Member Functions

 CommDriverSignalK (const std::string &s="sk0")
 
virtual bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr) override
 
virtual void SetListener (DriverListener &l) override
 Set the entity which will receive incoming data. More...
 
virtual std::shared_ptr< NavAddrGetAddress (const NavAddrSignalK &name)
 
- Public Member Functions inherited from AbstractCommDriver
virtual bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr)=0
 
virtual void Activate ()=0
 Register driver in the driver Registry. More...
 
virtual void SetListener (DriverListener &l)
 Set the entity which will receive incoming data. More...
 
virtual std::pair< CommStatus, std::string > Clone ()
 Create a new virtual interface using a new instance of this driver. More...
 
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. More...
 
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

Abstract SignalK driver interface.

Definition at line 33 of file comm_drv_signalk.h.

Constructor & Destructor Documentation

◆ CommDriverSignalK()

CommDriverSignalK::CommDriverSignalK ( const std::string &  s = "sk0")

Definition at line 35 of file comm_drv_signalk.cpp.

◆ ~CommDriverSignalK()

CommDriverSignalK::~CommDriverSignalK ( )
virtual

Definition at line 38 of file comm_drv_signalk.cpp.

Member Function Documentation

◆ GetAddress()

std::shared_ptr< NavAddr > CommDriverSignalK::GetAddress ( const NavAddrSignalK name)
virtual

Definition at line 45 of file comm_drv_signalk.cpp.

◆ SendMessage()

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

Implements AbstractCommDriver.

Definition at line 40 of file comm_drv_signalk.cpp.

◆ SetListener()

void CommDriverSignalK::SetListener ( DriverListener l)
overridevirtual

Set the entity which will receive incoming data.

By default, such data is ignored

Reimplemented from AbstractCommDriver.

Definition at line 43 of file comm_drv_signalk.cpp.


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