OpenCPN Partial API docs
Loading...
Searching...
No Matches
CommDriverN0183Serial Class Reference
Inheritance diagram for CommDriverN0183Serial:
CommDriverN0183 DriverStatsProvider AbstractCommDriver

Public Member Functions

 CommDriverN0183Serial (const ConnectionParams *params, DriverListener &l)
bool Open ()
void Close ()
bool IsSecThreadActive () const
bool IsGarminThreadActive () const
void StopGarminUSBIOThread (bool bPause) const
const ConnectionParams & GetParams () const override
bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr) override
DriverStats GetDriverStats () const override
 Get the Driver Statistics.
Public Member Functions inherited from CommDriverN0183
 CommDriverN0183 (NavAddr::Bus b, const std::string &s)
void SetListener (DriverListener &l) override
 Set the entity which will receive incoming data.
virtual std::shared_ptr< NavAddr > GetAddress ()
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.
std::string Key () const
virtual std::unordered_map< std::string, std::string > GetAttributes () const
Public Member Functions inherited from DriverStatsProvider
virtual ~DriverStatsProvider ()=default
 Destroy the Driver Stats Provider object.

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 CommDriverN0183
void SendToListener (const std::string &payload, DriverListener &listener, const ConnectionParams &params)
 Wrap argument string in NavMsg pointer, forward to listener.
Protected Member Functions inherited from AbstractCommDriver
 AbstractCommDriver (NavAddr::Bus b)
 AbstractCommDriver (NavAddr::Bus b, const std::string &s)

Detailed Description

Definition at line 38 of file comm_drv_n0183_serial.h.

Constructor & Destructor Documentation

◆ CommDriverN0183Serial()

CommDriverN0183Serial::CommDriverN0183Serial ( const ConnectionParams * params,
DriverListener & l )

Definition at line 48 of file comm_drv_n0183_serial.cpp.

◆ ~CommDriverN0183Serial()

CommDriverN0183Serial::~CommDriverN0183Serial ( )
override

Definition at line 67 of file comm_drv_n0183_serial.cpp.

Member Function Documentation

◆ Close()

void CommDriverN0183Serial::Close ( )

Definition at line 90 of file comm_drv_n0183_serial.cpp.

◆ GetDriverStats()

DriverStats CommDriverN0183Serial::GetDriverStats ( ) const
inlineoverridevirtual

Get the Driver Statistics.

Returns
DriverStats Object containing the driver statistics.

Implements DriverStatsProvider.

Definition at line 59 of file comm_drv_n0183_serial.h.

◆ GetParams()

const ConnectionParams & CommDriverN0183Serial::GetParams ( ) const
inlineoverridevirtual

Implements CommDriverN0183.

Definition at line 54 of file comm_drv_n0183_serial.h.

◆ IsGarminThreadActive()

bool CommDriverN0183Serial::IsGarminThreadActive ( ) const

Definition at line 116 of file comm_drv_n0183_serial.cpp.

◆ IsSecThreadActive()

bool CommDriverN0183Serial::IsSecThreadActive ( ) const
inline

Definition at line 49 of file comm_drv_n0183_serial.h.

◆ Open()

bool CommDriverN0183Serial::Open ( )

Definition at line 69 of file comm_drv_n0183_serial.cpp.

◆ SendMessage()

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

Implements CommDriverN0183.

Definition at line 136 of file comm_drv_n0183_serial.cpp.

◆ StopGarminUSBIOThread()

void CommDriverN0183Serial::StopGarminUSBIOThread ( bool bPause) const

Definition at line 130 of file comm_drv_n0183_serial.cpp.


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