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

Inheritance diagram for SickToolbox::SickLMS1xxBufferMonitor:

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

	SickLMS1xxBufferMonitor ()
	A standard constructor. More...

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

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

void	GetNextMessageFromDataStream (SickLMS1xxMessage &sick_message)

bool	GetNextMessageFromMonitor (SickLMS1xxMessage &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 (SickLMS1xxBufferMonitor *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...

Private Member Functions
void	_flushTCPRecvBuffer () const throw ( SickIOException )
	Flushes TCP receive buffer contents. More...

Additional Inherited Members
Protected Member Functions inherited from SickToolbox::SickBufferMonitor< SickLMS1xxBufferMonitor, SickLMS1xxMessage >
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< SickLMS1xxBufferMonitor, SickLMS1xxMessage >
unsigned int	_sick_fd

Detailed Description

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

Definition at line 34 of file SickLMS1xxBufferMonitor.hh.

Constructor & Destructor Documentation

SickToolbox::SickLMS1xxBufferMonitor::SickLMS1xxBufferMonitor ( )

A standard constructor.

A standard constructor

Definition at line 35 of file SickLMS1xxBufferMonitor.cc.

SickToolbox::SickLMS1xxBufferMonitor::~SickLMS1xxBufferMonitor ( )

A standard destructor.

A standard destructor

void SickToolbox::SickLMS1xxBufferMonitor::_flushTCPRecvBuffer	(		)	const
throw	(	SickIOException
	)

private

Flushes TCP receive buffer contents.

void SickToolbox::SickLMS1xxBufferMonitor::GetNextMessageFromDataStream	(	SickLMS1xxMessage &	sick_message	)
throw	(	SickIOException
	)

Acquires the next message from the SickLMS1xx byte stream.

A method for extracting a single message from the stream

Parameters

&sick_message The returned message object

Definition at line 41 of file SickLMS1xxBufferMonitor.cc.

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