OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | List of all members
StdSerialIo Class Reference

SerialIo implementation based on serial/serial.h. More...

Inheritance diagram for StdSerialIo:
SerialIo ThreadCtrl

Public Member Functions

 StdSerialIo (SendMsgFunc send_func, const std::string &port, unsigned baud)
 
bool SetOutMsg (const wxString &msg) override
 Send a message to remote peer.
 
void Start () override
 Start IO operations including input, possibly in separate thread.
 
DriverStats GetStats () const override
 Retrieve updated driver statistics.
 
- Public Member Functions inherited from ThreadCtrl
virtual ~ThreadCtrl ()=default
 Destroy the Thread Ctrl object.
 
bool IsRunning () const
 Return true if thread is running.
 
void WaitUntilStopped ()
 Block until thread invokes SignalExit().
 
bool WaitUntilStopped (std::chrono::duration< int > timeout)
 Block until thread invokes SignalExit() or timeout.
 
bool WaitUntilStopped (std::chrono::duration< int > timeout, std::chrono::milliseconds &elapsed)
 Block until thread invokes SignalExit() or timeout.
 

Additional Inherited Members

- Static Public Member Functions inherited from SerialIo
static std::unique_ptr< SerialIo > Create (SendMsgFunc send_msg_func, const std::string &port, unsigned baud)
 Factory.
 
- Protected Member Functions inherited from SerialIo
 SerialIo (SendMsgFunc send_msg_func, const std::string &port, unsigned baud)
 
- Protected Member Functions inherited from ThreadCtrl
bool KeepGoing () const
 If true continue thread operation, else exit and invoke SignalExit()
 
void SignalExit ()
 Signal that thread has exited.
 
- Protected Attributes inherited from SerialIo
const wxString m_portname
 
const unsigned m_baud
 
const SendMsgFunc m_send_msg_func
 
DriverStats m_stats
 
std::mutex m_stats_mutex
 
TimedLogFilter m_open_log_filter
 

Detailed Description

SerialIo implementation based on serial/serial.h.

Definition at line 52 of file std_serial_io.cpp.

Constructor & Destructor Documentation

◆ StdSerialIo()

StdSerialIo::StdSerialIo ( SendMsgFunc  send_func,
const std::string &  port,
unsigned  baud 
)
inline

Definition at line 54 of file std_serial_io.cpp.

Member Function Documentation

◆ GetStats()

DriverStats StdSerialIo::GetStats ( ) const
overridevirtual

Retrieve updated driver statistics.

Implements SerialIo.

Definition at line 166 of file std_serial_io.cpp.

◆ SetOutMsg()

bool StdSerialIo::SetOutMsg ( const wxString &  msg)
overridevirtual

Send a message to remote peer.

Implements SerialIo.

Definition at line 160 of file std_serial_io.cpp.

◆ Start()

void StdSerialIo::Start ( )
overridevirtual

Start IO operations including input, possibly in separate thread.

Implements SerialIo.

Definition at line 155 of file std_serial_io.cpp.

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