rplidar_ros: rp::arch::net::raw_serial Class Reference

#include <net_serial.h>

Inheritance diagram for rp::arch::net::raw_serial:

Inheritance graph

List of all members.

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 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 ()
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

Detailed Description

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

Member Enumeration Documentation

anonymous enum

Enumerator:

SERIAL_RX_BUFFER_SIZE
SERIAL_TX_BUFFER_SIZE

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

anonymous enum

Enumerator:

SERIAL_RX_BUFFER_SIZE
SERIAL_TX_BUFFER_SIZE

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

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

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

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

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

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

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

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

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

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

Member Function Documentation

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

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

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

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

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

Implements rp::hal::serial_rxtx.

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.

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

Implements rp::hal::serial_rxtx.

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

Reimplemented from rp::hal::serial_rxtx.

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

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

Implements rp::hal::serial_rxtx.

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

Implements rp::hal::serial_rxtx.

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

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

Implements rp::hal::serial_rxtx.

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

Implements rp::hal::serial_rxtx.

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

Implements rp::hal::serial_rxtx.

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

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

Implements rp::hal::serial_rxtx.

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.

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

Implements rp::hal::serial_rxtx.

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

Implements rp::hal::serial_rxtx.

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

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

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

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

Implements rp::hal::serial_rxtx.

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

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

Implements rp::hal::serial_rxtx.

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

Implements rp::hal::serial_rxtx.

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

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

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.

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

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

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.

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

Implements rp::hal::serial_rxtx.

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.

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

Implements rp::hal::serial_rxtx.

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

Implements rp::hal::serial_rxtx.

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

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

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.

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

Implements rp::hal::serial_rxtx.

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

Implements rp::hal::serial_rxtx.

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

Implements rp::hal::serial_rxtx.

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

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

Implements rp::hal::serial_rxtx.

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 199 of file macOS/net_serial.cpp.

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.

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.

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.

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

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

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

Implements rp::hal::serial_rxtx.

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 Mon Mar 18 2019 02:34:23