create::Serial Class Reference

#include <serial.h>

Inheritance diagram for create::Serial:

Public Member Functions
bool	connect (const std::string &port, const int &baud=115200, std::function< void()> cb=0)
bool	connected () const
void	disconnect ()
uint64_t	getNumCorruptPackets () const
uint64_t	getTotalPackets () const
bool	send (const uint8_t *bytes, const uint32_t numBytes)
bool	sendOpcode (const Opcode &code)
	Serial (std::shared_ptr< Data > data, bool install_signal_handler)
	~Serial ()

Protected Member Functions
void	notifyDataReady ()
virtual void	processByte (uint8_t byteRead)=0
void	signalHandler (const boost::system::error_code &error, int signal_number)
virtual bool	startSensorStream ()=0

Protected Attributes
uint64_t	corruptPackets
std::shared_ptr< Data >	data
boost::asio::io_service	io
boost::asio::serial_port	port
boost::asio::signal_set	signals
uint64_t	totalPackets

Private Member Functions
bool	closePort ()
void	onData (const boost::system::error_code &e, const std::size_t &size)
bool	openPort (const std::string &portName, const int &baud)
bool	startReading ()
void	stopReading ()

Private Attributes
uint8_t	byteRead
std::function< void()>	callback
bool	dataReady
std::condition_variable	dataReadyCond
std::mutex	dataReadyMut
bool	firstRead
std::thread	ioThread
bool	isReading

Detailed Description

Definition at line 51 of file serial.h.

Constructor & Destructor Documentation

Serial()

create::Serial::Serial	(	std::shared_ptr< Data >	data,
		bool	install_signal_handler
	)

Definition at line 10 of file serial.cpp.

~Serial()

create::Serial::~Serial

(

)

Definition at line 25 of file serial.cpp.

Member Function Documentation

closePort()

bool create::Serial::closePort ( )

private

Definition at line 95 of file serial.cpp.

connect()

bool create::Serial::connect	(	const std::string &	port,
		const int &	baud = 115200,
		std::function< void()>	cb = 0
	)

Definition at line 41 of file serial.cpp.

connected()

bool create::Serial::connected ( ) const

inline

Definition at line 95 of file serial.h.

disconnect()

void create::Serial::disconnect

(

)

Definition at line 65 of file serial.cpp.

getNumCorruptPackets()

uint64_t create::Serial::getNumCorruptPackets

(

)

const

Definition at line 231 of file serial.cpp.

getTotalPackets()

uint64_t create::Serial::getTotalPackets

(

)

const

Definition at line 235 of file serial.cpp.

notifyDataReady()

void create::Serial::notifyDataReady ( )

protected

Definition at line 174 of file serial.cpp.

onData()

void create::Serial::onData ( const boost::system::error_code &  e, const std::size_t &  size  )

private

Definition at line 191 of file serial.cpp.

openPort()

bool create::Serial::openPort ( const std::string &  portName, const int &  baud  )

private

Definition at line 79 of file serial.cpp.

processByte()

virtual void create::Serial::processByte ( uint8_t  byteRead )

protectedpure virtual

Implemented in create::SerialStream, and create::SerialQuery.

send()

bool create::Serial::send	(	const uint8_t *	bytes,
		const uint32_t	numBytes
	)

Definition at line 211 of file serial.cpp.

sendOpcode()

bool create::Serial::sendOpcode

(

const Opcode &

code

)

Definition at line 226 of file serial.cpp.

signalHandler()

void create::Serial::signalHandler ( const boost::system::error_code &  error, int  signal_number  )

protected

Definition at line 29 of file serial.cpp.

startReading()

bool create::Serial::startReading ( )

private

Definition at line 106 of file serial.cpp.

startSensorStream()

virtual bool create::Serial::startSensorStream ( )

protectedpure virtual

Implemented in create::SerialStream, and create::SerialQuery.

stopReading()

void create::Serial::stopReading ( )

private

Definition at line 161 of file serial.cpp.

Member Data Documentation

byteRead

uint8_t create::Serial::byteRead

private

Definition at line 65 of file serial.h.

callback

std::function<void()> create::Serial::callback

private

Definition at line 70 of file serial.h.

corruptPackets

uint64_t create::Serial::corruptPackets

protected

Definition at line 80 of file serial.h.

data

std::shared_ptr<Data> create::Serial::data

protected

Definition at line 78 of file serial.h.

dataReady

bool create::Serial::dataReady

private

Definition at line 62 of file serial.h.

dataReadyCond

std::condition_variable create::Serial::dataReadyCond

private

Definition at line 60 of file serial.h.

dataReadyMut

std::mutex create::Serial::dataReadyMut

private

Definition at line 61 of file serial.h.

firstRead

bool create::Serial::firstRead

private

Definition at line 64 of file serial.h.

io

boost::asio::io_service create::Serial::io

protected

Definition at line 54 of file serial.h.

ioThread

std::thread create::Serial::ioThread

private

Definition at line 59 of file serial.h.

isReading

bool create::Serial::isReading

private

Definition at line 63 of file serial.h.

port

boost::asio::serial_port create::Serial::port

protected

Definition at line 56 of file serial.h.

signals

boost::asio::signal_set create::Serial::signals

protected

Definition at line 55 of file serial.h.

totalPackets

uint64_t create::Serial::totalPackets

protected

Definition at line 81 of file serial.h.

---

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

• serial.h
• serial.cpp