Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
rp::arch::net::raw_serial Class Reference

#include <net_serial.h>

Inheritance diagram for rp::arch::net::raw_serial:
Inheritance graph
[legend]

Public Types

enum  { SERIAL_RX_BUFFER_SIZE = 512, SERIAL_TX_BUFFER_SIZE = 128 }
 
enum  { SERIAL_RX_BUFFER_SIZE = 512, SERIAL_TX_BUFFER_SIZE = 128 }
 
enum  { SERIAL_RX_BUFFER_SIZE = 512, SERIAL_TX_BUFFER_SIZE = 128, SERIAL_RX_TIMEOUT = 2000, SERIAL_TX_TIMEOUT = 2000 }
 
- Public Types inherited from rp::hal::serial_rxtx
enum  { ANS_OK = 0, ANS_TIMEOUT = -1, ANS_DEV_ERR = -2 }
 

Public Member Functions

virtual bool bind (const char *portname, uint32_t baudrate, uint32_t flags=0)
 
virtual bool bind (const char *portname, uint32_t baudrate, uint32_t flags=0)
 
virtual bool bind (const char *portname, _u32 baudrate, _u32 flags=0)
 
virtual void cancelOperation ()
 
virtual void clearDTR ()
 
virtual void clearDTR ()
 
virtual void clearDTR ()
 
virtual void close ()
 
virtual void close ()
 
virtual void close ()
 
virtual void flush (_u32 flags)
 
virtual void flush (_u32 flags)
 
virtual void flush (_u32 flags)
 
_u32 getTermBaudBitmap (_u32 baud)
 
_u32 getTermBaudBitmap (_u32 baud)
 
virtual bool open ()
 
virtual bool open ()
 
virtual bool open ()
 
 raw_serial ()
 
 raw_serial ()
 
 raw_serial ()
 
virtual int recvdata (unsigned char *data, size_t size)
 
virtual int recvdata (unsigned char *data, _word_size_t size)
 
virtual int recvdata (unsigned char *data, size_t size)
 
virtual size_t rxqueue_count ()
 
virtual size_t rxqueue_count ()
 
virtual size_t rxqueue_count ()
 
virtual int senddata (const unsigned char *data, size_t size)
 
virtual int senddata (const unsigned char *data, _word_size_t size)
 
virtual int senddata (const unsigned char *data, size_t size)
 
virtual void setDTR ()
 
virtual void setDTR ()
 
virtual void setDTR ()
 
virtual int waitfordata (size_t data_count, _u32 timeout=-1, size_t *returned_size=NULL)
 
virtual int waitfordata (_word_size_t data_count, _u32 timeout=-1, _word_size_t *returned_size=NULL)
 
virtual int waitfordata (size_t data_count, _u32 timeout=-1, size_t *returned_size=NULL)
 
virtual int waitforrecv (_u32 timeout=-1, size_t *returned_size=NULL)
 
virtual int waitforrecv (_u32 timeout=-1, _word_size_t *returned_size=NULL)
 
virtual int waitforrecv (_u32 timeout=-1, size_t *returned_size=NULL)
 
virtual int waitforsent (_u32 timeout=-1, _word_size_t *returned_size=NULL)
 
virtual int waitforsent (_u32 timeout=-1, size_t *returned_size=NULL)
 
virtual int waitforsent (_u32 timeout=-1, size_t *returned_size=NULL)
 
virtual ~raw_serial ()
 
virtual ~raw_serial ()
 
virtual ~raw_serial ()
 
- Public Member Functions inherited from rp::hal::serial_rxtx
virtual bool isOpened ()
 
 serial_rxtx ()
 
virtual ~serial_rxtx ()
 

Protected Member Functions

void _init ()
 
void _init ()
 
void _init ()
 
bool open (const char *portname, uint32_t baudrate, uint32_t flags=0)
 
bool open (const char *portname, _u32 baudrate, _u32 flags)
 
bool open (const char *portname, uint32_t baudrate, uint32_t flags=0)
 

Protected Attributes

uint32_t _baudrate
 
COMMTIMEOUTS _co
 
DCB _dcb
 
uint32_t _flags
 
bool _operation_aborted
 
char _portName [200]
 
OVERLAPPED _ro
 
int _selfpipe [2]
 
volatile HANDLE _serial_handle
 
OVERLAPPED _wait_o
 
OVERLAPPED _wo
 
size_t required_rx_cnt
 
size_t required_tx_cnt
 
int serial_fd
 
- Protected Attributes inherited from rp::hal::serial_rxtx
volatile bool _is_serial_opened
 

Additional Inherited Members

- Static Public Member Functions inherited from rp::hal::serial_rxtx
static serial_rxtx * CreateRxTx ()
 
static void ReleaseRxTx (serial_rxtx *)
 

Detailed Description

Definition at line 41 of file linux/net_serial.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SERIAL_RX_BUFFER_SIZE 
SERIAL_TX_BUFFER_SIZE 

Definition at line 44 of file linux/net_serial.h.

◆ anonymous enum

anonymous enum
Enumerator
SERIAL_RX_BUFFER_SIZE 
SERIAL_TX_BUFFER_SIZE 

Definition at line 44 of file macOS/net_serial.h.

◆ anonymous enum

anonymous enum
Enumerator
SERIAL_RX_BUFFER_SIZE 
SERIAL_TX_BUFFER_SIZE 
SERIAL_RX_TIMEOUT 
SERIAL_TX_TIMEOUT 

Definition at line 44 of file win32/net_serial.h.

Constructor & Destructor Documentation

◆ raw_serial() [1/3]

rp::arch::net::raw_serial::raw_serial ( )

Definition at line 69 of file linux/net_serial.cpp.

◆ ~raw_serial() [1/3]

rp::arch::net::raw_serial::~raw_serial ( )
virtual

Definition at line 78 of file linux/net_serial.cpp.

◆ raw_serial() [2/3]

rp::arch::net::raw_serial::raw_serial ( )

◆ ~raw_serial() [2/3]

virtual rp::arch::net::raw_serial::~raw_serial ( )
virtual

◆ raw_serial() [3/3]

rp::arch::net::raw_serial::raw_serial ( )

◆ ~raw_serial() [3/3]

virtual rp::arch::net::raw_serial::~raw_serial ( )
virtual

Member Function Documentation

◆ _init() [1/3]

void rp::arch::net::raw_serial::_init ( )
protected

◆ _init() [2/3]

void rp::arch::net::raw_serial::_init ( )
protected

◆ _init() [3/3]

void rp::arch::net::raw_serial::_init ( )
protected

Definition at line 414 of file linux/net_serial.cpp.

◆ bind() [1/3]

virtual bool rp::arch::net::raw_serial::bind ( const char *  portname,
uint32_t  baudrate,
uint32_t  flags = 0 
)
virtual

Implements rp::hal::serial_rxtx.

◆ bind() [2/3]

bool rp::arch::net::raw_serial::bind ( const char *  portname,
uint32_t  baudrate,
uint32_t  flags = 0 
)
virtual

Implements rp::hal::serial_rxtx.

Definition at line 89 of file linux/net_serial.cpp.

◆ bind() [3/3]

virtual bool rp::arch::net::raw_serial::bind ( const char *  portname,
_u32  baudrate,
_u32  flags = 0 
)
virtual

Implements rp::hal::serial_rxtx.

◆ cancelOperation()

void rp::arch::net::raw_serial::cancelOperation ( )
virtual

Reimplemented from rp::hal::serial_rxtx.

Definition at line 423 of file linux/net_serial.cpp.

◆ clearDTR() [1/3]

virtual void rp::arch::net::raw_serial::clearDTR ( )
virtual

Implements rp::hal::serial_rxtx.

◆ clearDTR() [2/3]

void rp::arch::net::raw_serial::clearDTR ( )
virtual

Implements rp::hal::serial_rxtx.

Definition at line 406 of file linux/net_serial.cpp.

◆ clearDTR() [3/3]

virtual void rp::arch::net::raw_serial::clearDTR ( )
virtual

Implements rp::hal::serial_rxtx.

◆ close() [1/3]

virtual void rp::arch::net::raw_serial::close ( )
virtual

Implements rp::hal::serial_rxtx.

◆ close() [2/3]

void rp::arch::net::raw_serial::close ( )
virtual

Implements rp::hal::serial_rxtx.

Definition at line 228 of file linux/net_serial.cpp.

◆ close() [3/3]

virtual void rp::arch::net::raw_serial::close ( )
virtual

Implements rp::hal::serial_rxtx.

◆ flush() [1/3]

void rp::arch::net::raw_serial::flush ( _u32  flags)
virtual

Implements rp::hal::serial_rxtx.

Definition at line 281 of file linux/net_serial.cpp.

◆ flush() [2/3]

virtual void rp::arch::net::raw_serial::flush ( _u32  flags)
virtual

Implements rp::hal::serial_rxtx.

◆ flush() [3/3]

virtual void rp::arch::net::raw_serial::flush ( _u32  flags)
virtual

Implements rp::hal::serial_rxtx.

◆ getTermBaudBitmap() [1/2]

_u32 rp::arch::net::raw_serial::getTermBaudBitmap ( _u32  baud)

Definition at line 431 of file linux/net_serial.cpp.

◆ getTermBaudBitmap() [2/2]

_u32 rp::arch::net::raw_serial::getTermBaudBitmap ( _u32  baud)

◆ open() [1/6]

bool rp::arch::net::raw_serial::open ( )
virtual

Implements rp::hal::serial_rxtx.

Definition at line 84 of file linux/net_serial.cpp.

◆ open() [2/6]

virtual bool rp::arch::net::raw_serial::open ( )
virtual

Implements rp::hal::serial_rxtx.

◆ open() [3/6]

virtual bool rp::arch::net::raw_serial::open ( )
virtual

Implements rp::hal::serial_rxtx.

◆ open() [4/6]

bool rp::arch::net::raw_serial::open ( const char *  portname,
uint32_t  baudrate,
uint32_t  flags = 0 
)
protected

◆ open() [5/6]

bool rp::arch::net::raw_serial::open ( const char *  portname,
_u32  baudrate,
_u32  flags 
)
protected

◆ open() [6/6]

bool rp::arch::net::raw_serial::open ( const char *  portname,
uint32_t  baudrate,
uint32_t  flags = 0 
)
protected

Definition at line 97 of file linux/net_serial.cpp.

◆ recvdata() [1/3]

int rp::arch::net::raw_serial::recvdata ( unsigned char *  data,
_word_size_t  size 
)
virtual

Definition at line 165 of file macOS/net_serial.cpp.

◆ recvdata() [2/3]

int rp::arch::net::raw_serial::recvdata ( unsigned char *  data,
size_t  size 
)
virtual

Implements rp::hal::serial_rxtx.

Definition at line 269 of file linux/net_serial.cpp.

◆ recvdata() [3/3]

virtual int rp::arch::net::raw_serial::recvdata ( unsigned char *  data,
size_t  size 
)
virtual

Implements rp::hal::serial_rxtx.

◆ rxqueue_count() [1/3]

size_t rp::arch::net::raw_serial::rxqueue_count ( )
virtual

Implements rp::hal::serial_rxtx.

Definition at line 389 of file linux/net_serial.cpp.

◆ rxqueue_count() [2/3]

virtual size_t rp::arch::net::raw_serial::rxqueue_count ( )
virtual

Implements rp::hal::serial_rxtx.

◆ rxqueue_count() [3/3]

virtual size_t rp::arch::net::raw_serial::rxqueue_count ( )
virtual

Implements rp::hal::serial_rxtx.

◆ senddata() [1/3]

int rp::arch::net::raw_serial::senddata ( const unsigned char *  data,
_word_size_t  size 
)
virtual

Definition at line 141 of file macOS/net_serial.cpp.

◆ senddata() [2/3]

int rp::arch::net::raw_serial::senddata ( const unsigned char *  data,
size_t  size 
)
virtual

Implements rp::hal::serial_rxtx.

Definition at line 246 of file linux/net_serial.cpp.

◆ senddata() [3/3]

virtual int rp::arch::net::raw_serial::senddata ( const unsigned char *  data,
size_t  size 
)
virtual

Implements rp::hal::serial_rxtx.

◆ setDTR() [1/3]

virtual void rp::arch::net::raw_serial::setDTR ( )
virtual

Implements rp::hal::serial_rxtx.

◆ setDTR() [2/3]

void rp::arch::net::raw_serial::setDTR ( )
virtual

Implements rp::hal::serial_rxtx.

Definition at line 398 of file linux/net_serial.cpp.

◆ setDTR() [3/3]

virtual void rp::arch::net::raw_serial::setDTR ( )
virtual

Implements rp::hal::serial_rxtx.

◆ waitfordata() [1/3]

int rp::arch::net::raw_serial::waitfordata ( _word_size_t  data_count,
_u32  timeout = -1,
_word_size_t *  returned_size = NULL 
)
virtual

Definition at line 196 of file macOS/net_serial.cpp.

◆ waitfordata() [2/3]

int rp::arch::net::raw_serial::waitfordata ( size_t  data_count,
_u32  timeout = -1,
size_t *  returned_size = NULL 
)
virtual

Implements rp::hal::serial_rxtx.

Definition at line 300 of file linux/net_serial.cpp.

◆ waitfordata() [3/3]

virtual int rp::arch::net::raw_serial::waitfordata ( size_t  data_count,
_u32  timeout = -1,
size_t *  returned_size = NULL 
)
virtual

Implements rp::hal::serial_rxtx.

◆ waitforrecv() [1/3]

int rp::arch::net::raw_serial::waitforrecv ( _u32  timeout = -1,
size_t *  returned_size = NULL 
)
virtual

Implements rp::hal::serial_rxtx.

Definition at line 292 of file linux/net_serial.cpp.

◆ waitforrecv() [2/3]

int rp::arch::net::raw_serial::waitforrecv ( _u32  timeout = -1,
_word_size_t *  returned_size = NULL 
)
virtual

Definition at line 188 of file macOS/net_serial.cpp.

◆ waitforrecv() [3/3]

virtual int rp::arch::net::raw_serial::waitforrecv ( _u32  timeout = -1,
size_t *  returned_size = NULL 
)
virtual

Implements rp::hal::serial_rxtx.

◆ waitforsent() [1/3]

int rp::arch::net::raw_serial::waitforsent ( _u32  timeout = -1,
_word_size_t *  returned_size = NULL 
)
virtual

Definition at line 182 of file macOS/net_serial.cpp.

◆ waitforsent() [2/3]

int rp::arch::net::raw_serial::waitforsent ( _u32  timeout = -1,
size_t *  returned_size = NULL 
)
virtual

Implements rp::hal::serial_rxtx.

Definition at line 286 of file linux/net_serial.cpp.

◆ waitforsent() [3/3]

virtual int rp::arch::net::raw_serial::waitforsent ( _u32  timeout = -1,
size_t *  returned_size = NULL 
)
virtual

Implements rp::hal::serial_rxtx.

Member Data Documentation

◆ _baudrate

uint32_t rp::arch::net::raw_serial::_baudrate
protected

Definition at line 78 of file linux/net_serial.h.

◆ _co

COMMTIMEOUTS rp::arch::net::raw_serial::_co
protected

Definition at line 83 of file win32/net_serial.h.

◆ _dcb

DCB rp::arch::net::raw_serial::_dcb
protected

Definition at line 82 of file win32/net_serial.h.

◆ _flags

uint32_t rp::arch::net::raw_serial::_flags
protected

Definition at line 79 of file linux/net_serial.h.

◆ _operation_aborted

bool rp::arch::net::raw_serial::_operation_aborted
protected

Definition at line 87 of file linux/net_serial.h.

◆ _portName

char rp::arch::net::raw_serial::_portName
protected

Definition at line 77 of file linux/net_serial.h.

◆ _ro

OVERLAPPED rp::arch::net::raw_serial::_ro
protected

Definition at line 79 of file win32/net_serial.h.

◆ _selfpipe

int rp::arch::net::raw_serial::_selfpipe[2]
protected

Definition at line 86 of file linux/net_serial.h.

◆ _serial_handle

volatile HANDLE rp::arch::net::raw_serial::_serial_handle
protected

Definition at line 81 of file win32/net_serial.h.

◆ _wait_o

OVERLAPPED rp::arch::net::raw_serial::_wait_o
protected

Definition at line 80 of file win32/net_serial.h.

◆ _wo

OVERLAPPED rp::arch::net::raw_serial::_wo
protected

Definition at line 79 of file win32/net_serial.h.

◆ required_rx_cnt

size_t rp::arch::net::raw_serial::required_rx_cnt
protected

Definition at line 84 of file linux/net_serial.h.

◆ required_tx_cnt

size_t rp::arch::net::raw_serial::required_tx_cnt
protected

Definition at line 83 of file linux/net_serial.h.

◆ serial_fd

int rp::arch::net::raw_serial::serial_fd
protected

Definition at line 81 of file linux/net_serial.h.

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

rplidar_ros
Author(s):
autogenerated on Tue Jun 13 2023 02:07:38