OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
AbstractCommDriver Class Referenceabstract

Common interface for all drivers. More...

#include <comm_driver.h>

Inheritance diagram for AbstractCommDriver:
CommDriverInternal CommDriverN0183 CommDriverN2K CommDriverSignalK FileCommDriver CommDriverN0183AndroidBT CommDriverN0183AndroidInt CommDriverN0183Net CommDriverN0183Serial CommDriverN2KNet CommDriverN2KSerial CommDriverN2KSocketCAN CommDriverSignalKNet

Public Member Functions

virtual bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr)=0
 
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
 

Public Attributes

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

 AbstractCommDriver (NavAddr::Bus b)
 
 AbstractCommDriver (NavAddr::Bus b, const std::string &s)
 

Detailed Description

Common interface for all drivers.


Definition at line 58 of file comm_driver.h.

Constructor & Destructor Documentation

◆ AbstractCommDriver() [1/3]

AbstractCommDriver::AbstractCommDriver ( )
inline

Definition at line 60 of file comm_driver.h.

◆ AbstractCommDriver() [2/3]

AbstractCommDriver::AbstractCommDriver ( NavAddr::Bus  b)
inlineprotected

Definition at line 98 of file comm_driver.h.

◆ AbstractCommDriver() [3/3]

AbstractCommDriver::AbstractCommDriver ( NavAddr::Bus  b,
const std::string &  s 
)
inlineprotected

Definition at line 101 of file comm_driver.h.

Member Function Documentation

◆ Clone()

virtual std::pair< CommStatus, std::string > AbstractCommDriver::Clone ( )
inlinevirtual

Create a new virtual interface using a new instance of this driver.

A successful return guarantees that the new driver is registered in the device registry and activated.

Returns
<CommStatus::ok, interface> on success else <error_code, message>.

Definition at line 80 of file comm_driver.h.

◆ GetAttributes()

virtual std::unordered_map< std::string, std::string > AbstractCommDriver::GetAttributes ( ) const
inlinevirtual

Definition at line 91 of file comm_driver.h.

◆ Key()

std::string AbstractCommDriver::Key ( ) const
inline

Definition at line 85 of file comm_driver.h.

◆ SendMessage()

virtual bool AbstractCommDriver::SendMessage ( std::shared_ptr< const NavMsg >  msg,
std::shared_ptr< const NavAddr >  addr 
)
pure virtual

Implemented in CommDriverInternal.

◆ SetListener()

virtual void AbstractCommDriver::SetListener ( DriverListener &  l)
inlinevirtual

Set the entity which will receive incoming data.

By default, such data is ignored

Reimplemented in CommDriverN0183, CommDriverN2K, CommDriverN2KNet, CommDriverN2KSerial, CommDriverN2KSocketCAN, and CommDriverSignalK.

Definition at line 71 of file comm_driver.h.

Member Data Documentation

◆ attributes

std::unordered_map<std::string, std::string> AbstractCommDriver::attributes

Definition at line 95 of file comm_driver.h.

◆ bus

const NavAddr::Bus AbstractCommDriver::bus

Definition at line 87 of file comm_driver.h.

◆ iface

const std::string AbstractCommDriver::iface

Physical device for 0183, else a unique string.

Definition at line 88 of file comm_driver.h.

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