gbxiceutilacfr Namespace Reference

Utility namespace (part of SICK-ACFR driver). More...

Classes
class	Buffer
	A thread-safe data pipe with buffer semantics. More...
class	NotifyHandler
	The object which implements the callback function. More...
class	Notify
	A data pipe with callback semantics. More...
class	SafeThread
	A version of the Thread class which catches all possible exceptions. More...
class	Store
	Thread-safe storage for a single data objects. More...
class	Thread
	A minor extention of the IceUtil::Thread class. More...
class	Timer
	A handy class that performs timing functions using Ice Time class. More...
Typedefs
typedef IceUtil::Handle < SafeThread >	SafeThreadPtr
	A smart pointer to the SafeThread class.
typedef IceUtil::Handle < gbxiceutilacfr::Thread >	ThreadPtr
	A smart pointer to the thread class.
Enumerations
enum	BufferType { BufferTypeCircular, BufferTypeQueue }
	Buffer type defines behavior when the buffer is full More...
Functions
void	stop (gbxiceutilacfr::Thread *thread)
void	stopAndJoin (gbxiceutilacfr::Thread *thread)
void	stop (const gbxiceutilacfr::ThreadPtr &thread)
void	stopAndJoin (const gbxiceutilacfr::ThreadPtr &thread)
void	checkedSleep (gbxutilacfr::Stoppable *activity, const IceUtil::Time &duration, int checkIntervalMs)
void	checkedSleep (gbxutilacfr::Stoppable *activity, int durationMs, int checkIntervalMs=250)
	Same as above, but sleep duration is specified in milliseconds.

---

Detailed Description

Utility namespace (part of SICK-ACFR driver).

Compiles into a library libGbxIceUtilAcfr

---

Enumeration Type Documentation

enum gbxiceutilacfr::BufferType

Buffer type defines behavior when the buffer is full

Enumerator:

BufferTypeCircular	When the maximum depth of the buffer is reached, removes the oldest entry to make room for the new data.
BufferTypeQueue	When the maximum depth of the buffer is reached, ignores new incoming data, until the oldest entry is popped to make room.

---

Function Documentation

void gbxiceutilacfr::checkedSleep	(	gbxutilacfr::Stoppable *	activity,
		const IceUtil::Time &	duration,
		int	checkIntervalMs = 250
	)

Sleeps for duration waking up every checkIntervalMs [ms] to check if the activity was told to stop. This implementation is very simple so the error in total sleep duration can be as large as checkIntervalMs. In particular, if duration is shorter than checkIntervalMs, this function will sleep for checkIntervalMs.

References gbxutilacfr::Stoppable::isStopping().

Referenced by checkedSleep().

void gbxiceutilacfr::stop

(

const gbxiceutilacfr::ThreadPtr &

thread

)

[inline]

Stops the thread but doesn't wait for it to terminate. If the smart pointer is 0, this function quietly returns.

References stop().

void gbxiceutilacfr::stop

(

gbxiceutilacfr::Thread *

thread

)

Stops the thread but doesn't wait for it to terminate. If the smart pointer is 0, this function quietly returns.

References gbxiceutilacfr::Thread::stop().

Referenced by stop().

void gbxiceutilacfr::stopAndJoin

(

const gbxiceutilacfr::ThreadPtr &

thread

)

[inline]

A convenience function which first stops the thread and then waits for it to terminate. If the smart pointer is 0, this function quietly returns.

References stopAndJoin().

void gbxiceutilacfr::stopAndJoin

(

gbxiceutilacfr::Thread *

thread

)

A convenience function which first stops the thread and then waits for it to terminate. If the pointer is NULL, this function quietly returns.

References gbxiceutilacfr::Thread::stop().

Referenced by stopAndJoin().