OpenCPN Partial API docs
CommDriverN2KSocketCAN Class Referenceabstract
Inheritance diagram for CommDriverN2KSocketCAN:
CommDriverN2K AbstractCommDriver CommDriverN2KSocketCanImpl

Public Member Functions

void Activate () override
 Register driver and possibly do other post-ctor steps.
 
void SetListener (DriverListener &l) override
 Set the entity which will receive incoming data. More...
 
bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr)=0
 
virtual bool Open ()=0
 
virtual void Close ()=0
 
void UpdateAttrCanAddress ()
 
- Public Member Functions inherited from CommDriverN2K
 CommDriverN2K (const std::string &s="n2k0")
 
virtual std::shared_ptr< NavAddrGetAddress (const N2kName &name)
 
virtual int SetTXPGN (int pgn)
 
- Public Member Functions inherited from AbstractCommDriver
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
 

Static Public Member Functions

static std::shared_ptr< CommDriverN2KSocketCANCreate (const ConnectionParams *params, DriverListener &listener)
 

Protected Member Functions

 CommDriverN2KSocketCAN (const ConnectionParams *params, DriverListener &listener)
 
- Protected Member Functions inherited from AbstractCommDriver
 AbstractCommDriver (NavAddr::Bus b)
 
 AbstractCommDriver (NavAddr::Bus b, const std::string &s)
 

Protected Attributes

ConnectionParams m_params
 
DriverListenerm_listener
 

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
 

Detailed Description

Definition at line 35 of file comm_drv_n2k_socketcan.h.

Member Function Documentation

◆ SetListener()

void CommDriverN2KSocketCAN::SetListener ( DriverListener l)
inlineoverridevirtual

Set the entity which will receive incoming data.

By default, such data is ignored

Reimplemented from CommDriverN2K.

Definition at line 45 of file comm_drv_n2k_socketcan.h.


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