A class for monitoring the receive buffer when interfacing with a Sick PLS LIDAR. More...

Inheritance diagram for SickToolbox::SickPLSBufferMonitor:

Public Member Functions
void	GetNextMessageFromDataStream (SickPLSMessage &sick_message) throw ( SickIOException )
	Acquires the next message from the SickPLS byte stream. More...

	SickPLSBufferMonitor ()
	A standard constructor. More...

	~SickPLSBufferMonitor ()
	A standard destructor. More...

Public Member Functions inherited from SickToolbox::SickBufferMonitor< SickPLSBufferMonitor, SickPLSMessage >
void	AcquireDataStream () throw ( SickThreadException )
	Acquires a lock on the data stream. More...

void	GetNextMessageFromDataStream (SickPLSMessage &sick_message)

bool	GetNextMessageFromMonitor (SickPLSMessage &sick_message) throw ( SickThreadException )
	Checks the message container for the next available Sick message. More...

void	ReleaseDataStream () throw ( SickThreadException )
	Releases a lock on the data stream. More...

void	SetDataStream (const unsigned int sick_fd) throw ( SickThreadException )
	A method for setting/changing the current data stream. More...

	SickBufferMonitor (SickPLSBufferMonitor *const monitor_instance) throw ( SickThreadException )
	Primary constructor. More...

void	StartMonitor (const unsigned int sick_fd) throw ( SickThreadException )
	Creates and starts the buffer monitor thread. More...

void	StopMonitor () throw ( SickThreadException )
	Cancels the buffer monitor thread. More...

	~SickBufferMonitor () throw ( SickThreadException )
	The destructor (kills the mutex) More...

Additional Inherited Members
Protected Member Functions inherited from SickToolbox::SickBufferMonitor< SickPLSBufferMonitor, SickPLSMessage >
void	_readBytes (uint8_t *const dest_buffer, const int num_bytes_to_read, const unsigned int timeout_value=0) const throw ( SickTimeoutException, SickIOException )
	Attempt to read a certain number of bytes from the stream. More...

Protected Attributes inherited from SickToolbox::SickBufferMonitor< SickPLSBufferMonitor, SickPLSMessage >
unsigned int	_sick_fd

Detailed Description

A class for monitoring the receive buffer when interfacing with a Sick PLS LIDAR.

Definition at line 35 of file SickPLSBufferMonitor.hh.

Constructor & Destructor Documentation

SickToolbox::SickPLSBufferMonitor::SickPLSBufferMonitor ( )

A standard constructor.

A standard constructor

Definition at line 37 of file SickPLSBufferMonitor.cc.

SickToolbox::SickPLSBufferMonitor::~SickPLSBufferMonitor ( )

A standard destructor.

A standard destructor

Definition at line 155 of file SickPLSBufferMonitor.cc.

void SickToolbox::SickPLSBufferMonitor::GetNextMessageFromDataStream	(	SickPLSMessage &	sick_message	)
throw	(	SickIOException
	)

Acquires the next message from the SickPLS byte stream.

A method for extracting a single message from the stream

Parameters

&sick_message The returned message object

Definition at line 43 of file SickPLSBufferMonitor.cc.

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