OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
CommDriverN2KSerial Class Reference
Inheritance diagram for CommDriverN2KSerial:
CommDriverN2K DriverStatsProvider AbstractCommDriver

Public Member Functions

 CommDriverN2KSerial (const ConnectionParams *params, DriverListener &listener)
 
void SetListener (DriverListener &l) override
 Set the entity which will receive incoming data.
 
bool Open ()
 
void Close ()
 
bool SendMessage (std::shared_ptr< const NavMsg > msg, std::shared_ptr< const NavAddr > addr) override
 
void AddTxPGN (int pgn)
 
int SetTXPGN (int pgn) override
 
void SetSecThreadActive (void)
 
void SetSecThreadInActive (void)
 
bool IsSecThreadActive () const
 
void SetSecondaryThread (CommDriverN2KSerialThread *secondary_Thread)
 
CommDriverN2KSerialThread * GetSecondaryThread ()
 
void SetThreadRunFlag (int run)
 
void handle_N2K_SERIAL_RAW (CommDriverN2KSerialEvent &event)
 
int GetMfgCode ()
 
DriverStats GetDriverStats () const override
 Get the Driver Statistics.
 
- Public Member Functions inherited from CommDriverN2K
 CommDriverN2K (const std::string &s="n2k0")
 
virtual std::shared_ptr< NavAddr2000 > GetAddress (const N2kName &name)
 
- 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.
 

Public Attributes

std::atomic_int m_Thread_run_flag
 
ConnectionParams m_params
 
- 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
 

Additional Inherited Members

- Protected Member Functions inherited from AbstractCommDriver
 AbstractCommDriver (NavAddr::Bus b)
 
 AbstractCommDriver (NavAddr::Bus b, const std::string &s)
 

Detailed Description

Definition at line 56 of file comm_drv_n2k_serial.h.

Constructor & Destructor Documentation

◆ CommDriverN2KSerial()

CommDriverN2KSerial::CommDriverN2KSerial ( const ConnectionParams *  params,
DriverListener &  listener 
)

Definition at line 223 of file comm_drv_n2k_serial.cpp.

◆ ~CommDriverN2KSerial()

CommDriverN2KSerial::~CommDriverN2KSerial ( )
virtual

Definition at line 259 of file comm_drv_n2k_serial.cpp.

Member Function Documentation

◆ AddTxPGN()

void CommDriverN2KSerial::AddTxPGN ( int  pgn)

Definition at line 573 of file comm_drv_n2k_serial.cpp.

◆ Close()

void CommDriverN2KSerial::Close ( )

Definition at line 289 of file comm_drv_n2k_serial.cpp.

◆ GetDriverStats()

DriverStats CommDriverN2KSerial::GetDriverStats ( ) const
overridevirtual

Get the Driver Statistics.

Returns
DriverStats Object containing the driver statistics.

Implements DriverStatsProvider.

Definition at line 261 of file comm_drv_n2k_serial.cpp.

◆ GetMfgCode()

int CommDriverN2KSerial::GetMfgCode ( )

Definition at line 453 of file comm_drv_n2k_serial.cpp.

◆ GetSecondaryThread()

CommDriverN2KSerialThread * CommDriverN2KSerial::GetSecondaryThread ( )
inline

Definition at line 87 of file comm_drv_n2k_serial.h.

◆ handle_N2K_SERIAL_RAW()

void CommDriverN2KSerial::handle_N2K_SERIAL_RAW ( CommDriverN2KSerialEvent &  event)

Definition at line 425 of file comm_drv_n2k_serial.cpp.

◆ IsSecThreadActive()

bool CommDriverN2KSerial::IsSecThreadActive ( ) const
inline

Definition at line 82 of file comm_drv_n2k_serial.h.

◆ Open()

bool CommDriverN2KSerial::Open ( )

Definition at line 272 of file comm_drv_n2k_serial.cpp.

◆ SendMessage()

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

Implements CommDriverN2K.

Definition at line 323 of file comm_drv_n2k_serial.cpp.

◆ SetListener()

void CommDriverN2KSerial::SetListener ( DriverListener &  l)
inlineoverridevirtual

Set the entity which will receive incoming data.

By default, such data is ignored

Reimplemented from CommDriverN2K.

Definition at line 65 of file comm_drv_n2k_serial.h.

◆ SetSecondaryThread()

void CommDriverN2KSerial::SetSecondaryThread ( CommDriverN2KSerialThread *  secondary_Thread)
inline

Definition at line 84 of file comm_drv_n2k_serial.h.

◆ SetSecThreadActive()

void CommDriverN2KSerial::SetSecThreadActive ( void  )
inline

Definition at line 80 of file comm_drv_n2k_serial.h.

◆ SetSecThreadInActive()

void CommDriverN2KSerial::SetSecThreadInActive ( void  )
inline

Definition at line 81 of file comm_drv_n2k_serial.h.

◆ SetThreadRunFlag()

void CommDriverN2KSerial::SetThreadRunFlag ( int  run)
inline

Definition at line 90 of file comm_drv_n2k_serial.h.

◆ SetTXPGN()

int CommDriverN2KSerial::SetTXPGN ( int  pgn)
overridevirtual

Reimplemented from CommDriverN2K.

Definition at line 546 of file comm_drv_n2k_serial.cpp.

Member Data Documentation

◆ m_params

ConnectionParams CommDriverN2KSerial::m_params

Definition at line 98 of file comm_drv_n2k_serial.h.

◆ m_Thread_run_flag

std::atomic_int CommDriverN2KSerial::m_Thread_run_flag

Definition at line 97 of file comm_drv_n2k_serial.h.

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