<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GearBox Project</title>
<link rel="icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link rel="shortcut icon" href="gbx_icon_cardbox_sky.png" type="image/png">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<!-- Google Analytics -->
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-3583782-1");
pageTracker._initData();
pageTracker._trackPageview();
</script>
<!-- Returning you to your regular programming -->
</head><body>
<!-- Header -->
<table border="0" cellspacing="0" cellpadding="0">
<tr><!-- create row -->
<!-- spacer cell -->
<!-- #CC CC CC -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- menu cell -->
<td width="170" rowspan="1" colspan="1" align="left" valign="top" bgcolor="#EEEEEE">
<p> </p>
<p align="center"><a href="index.html"><img src="gbx_logo_cardbox_sky_150x150.png"></a></p><br>
<strong>INTRODUCTION</strong><br>
<strong><a href="gbx_doc_overview.html" style="text-decoration:none">Overview</a></strong><br>
<strong><a href="gbx_doc_getting.html" style="text-decoration:none">Download and Install</a></strong><br>
<!-- <strong><a href="gbx_doc_quickstart.html" style="text-decoration:none">Quick Start</a></strong><br> -->
<strong><a href="gbx_doc_documentation.html" style="text-decoration:none">Documentation</a></strong><br>
<strong><a href="gbx_doc_publications.html" style="text-decoration:none">Publications</a></strong><br>
<br>
<strong>REPOSITORY</strong><br>
<strong><a href="group__gbx__libs.html" style="text-decoration:none">Libraries</a></strong><br>
<!-- <strong><a href="group__gbx__utils.html" style="text-decoration:none">Utilities</a></strong><br> -->
<br>
<strong>DEVELOPER</strong><br>
<!--<strong><a href="gbx_doc_tutorials.html" style="text-decoration:none">Tutorials</a></strong><br>
<strong><a href="group__gbx__examples.html" style="text-decoration:none">Examples</a></strong><br>-->
<strong><a href="gbx_doc_devguide.html" style="text-decoration:none">Dev Guide</a></strong><br>
<!--
<strong><a href="gbx_doc_faq.html" style="text-decoration:none">FAQ</a></strong><br>
-->
<strong><a href="http://cdash.acfr.usyd.edu.au/index.php?project=Gearbox" style="text-decoration:none">Dashboard</a></strong><br>
<!--<strong><a href="http://wiki2.cas.edu.au/orca">Wiki</a></strong><br>
login/pass: orca/orca<br>-->
<br>
<strong>PEOPLE</strong><br>
<strong><a href="gbx_doc_contributors.html" style="text-decoration:none">Contributors</a></strong><br>
<strong><a href="gbx_doc_users.html" style="text-decoration:none">Users</a></strong><br>
<br>
<a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=216468&type=2" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a><br>
<strong><a href="http://sourceforge.net/projects/gearbox">Project</a></strong><br>
<strong><a href="http://sourceforge.net/project/showfiles.php?group_id=216468">Download</a></strong><br>
<!--<strong><a href="http://sourceforge.net/tracker/?group_id=216468">Bugs/Feedback</a></strong><br>-->
<strong><a href="http://sourceforge.net/mail/?group_id=216468">Mailing lists</a></strong></p>
<p> </p>
</td><!-- /menu cell -->
<!-- one grey spacer cells -->
<td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td>
<!-- one white spacer cells -->
<td rowspan="1" colspan="1"> </td>
<!-- main content cell -->
<td rowspan="1" colspan="1" align="left" valign="top">
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="namespaces.html"><span>Namespace List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>gbxiceutilacfr Namespace Reference</h1>
<p>Utility namespace (part of SICK-ACFR driver).
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxiceutilacfr_1_1Buffer.html">Buffer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A thread-safe data pipe with buffer semantics. <a href="classgbxiceutilacfr_1_1Buffer.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxiceutilacfr_1_1NotifyHandler.html">NotifyHandler</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The object which implements the callback function. <a href="classgbxiceutilacfr_1_1NotifyHandler.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxiceutilacfr_1_1Notify.html">Notify</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A data pipe with callback semantics. <a href="classgbxiceutilacfr_1_1Notify.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxiceutilacfr_1_1SafeThread.html">SafeThread</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A version of the <a class="el" href="classgbxiceutilacfr_1_1Thread.html" title="A minor extention of the IceUtil::Thread class.">Thread</a> class which catches all possible exceptions. <a href="classgbxiceutilacfr_1_1SafeThread.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxiceutilacfr_1_1Store.html">Store</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Thread-safe storage for a single data objects. <a href="classgbxiceutilacfr_1_1Store.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxiceutilacfr_1_1Thread.html">Thread</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A minor extention of the IceUtil::Thread class. <a href="classgbxiceutilacfr_1_1Thread.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxiceutilacfr_1_1Timer.html">Timer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A handy class that performs timing functions using Ice Time class. <a href="classgbxiceutilacfr_1_1Timer.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af098b524623d26b7ee388766f5f2ea09"></a><!-- doxytag: member="gbxiceutilacfr::SafeThreadPtr" ref="af098b524623d26b7ee388766f5f2ea09" args="" -->
typedef IceUtil::Handle<br class="typebreak"/>
< <a class="el" href="classgbxiceutilacfr_1_1SafeThread.html">SafeThread</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegbxiceutilacfr.html#af098b524623d26b7ee388766f5f2ea09">SafeThreadPtr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A smart pointer to the <a class="el" href="classgbxiceutilacfr_1_1SafeThread.html" title="A version of the Thread class which catches all possible exceptions.">SafeThread</a> class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a426649efe8df447b1e04fa1e46efde08"></a><!-- doxytag: member="gbxiceutilacfr::ThreadPtr" ref="a426649efe8df447b1e04fa1e46efde08" args="" -->
typedef IceUtil::Handle<br class="typebreak"/>
< <a class="el" href="classgbxiceutilacfr_1_1Thread.html">gbxiceutilacfr::Thread</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegbxiceutilacfr.html#a426649efe8df447b1e04fa1e46efde08">ThreadPtr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A smart pointer to the thread class. <br/></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegbxiceutilacfr.html#adb63e22074734759c387bf1494c39d58">BufferType</a> { <a class="el" href="namespacegbxiceutilacfr.html#adb63e22074734759c387bf1494c39d58a1d1af4db5a6306ef8ff06731810ea9b1">BufferTypeCircular</a>,
<a class="el" href="namespacegbxiceutilacfr.html#adb63e22074734759c387bf1494c39d58aace9508a711e08bfb1ee4c2ad809b68c">BufferTypeQueue</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Buffer type defines behavior when the buffer is full </p>
<a href="namespacegbxiceutilacfr.html#adb63e22074734759c387bf1494c39d58">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegbxiceutilacfr.html#a76e8a60c1aedfcd6eb8ee677ad05d6fd">stopAndJoin</a> (<a class="el" href="classgbxiceutilacfr_1_1Thread.html">gbxiceutilacfr::Thread</a> *thread)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegbxiceutilacfr.html#a1a0ede0789d998dfeb089f727e30f4d6">stopAndJoin</a> (const <a class="el" href="namespacegbxiceutilacfr.html#a426649efe8df447b1e04fa1e46efde08">gbxiceutilacfr::ThreadPtr</a> &thread)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegbxiceutilacfr.html#a954ed6c6e104e07d976334f9eadfe9cd">checkedSleep</a> (<a class="el" href="classgbxutilacfr_1_1Stoppable.html">gbxutilacfr::Stoppable</a> *activity, const IceUtil::Time &duration, int checkIntervalMs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9e27ac39cb10c121a3a9595ef9e411b"></a><!-- doxytag: member="gbxiceutilacfr::checkedSleep" ref="aa9e27ac39cb10c121a3a9595ef9e411b" args="(gbxutilacfr::Stoppable *activity, int durationMs, int checkIntervalMs=250)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacegbxiceutilacfr.html#aa9e27ac39cb10c121a3a9595ef9e411b">checkedSleep</a> (<a class="el" href="classgbxutilacfr_1_1Stoppable.html">gbxutilacfr::Stoppable</a> *activity, int durationMs, int checkIntervalMs=250)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Same as above, but sleep duration is specified in milliseconds. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Utility namespace (part of SICK-ACFR driver). </p>
<p>Compiles into a library libGbxIceUtilAcfr </p>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="adb63e22074734759c387bf1494c39d58"></a><!-- doxytag: member="gbxiceutilacfr::BufferType" ref="adb63e22074734759c387bf1494c39d58" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespacegbxiceutilacfr.html#adb63e22074734759c387bf1494c39d58">gbxiceutilacfr::BufferType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Buffer type defines behavior when the buffer is full </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="adb63e22074734759c387bf1494c39d58a1d1af4db5a6306ef8ff06731810ea9b1"></a><!-- doxytag: member="BufferTypeCircular" ref="adb63e22074734759c387bf1494c39d58a1d1af4db5a6306ef8ff06731810ea9b1" args="" -->BufferTypeCircular</em> </td><td>
<p>When the maximum depth of the buffer is reached, removes the oldest entry to make room for the new data. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="adb63e22074734759c387bf1494c39d58aace9508a711e08bfb1ee4c2ad809b68c"></a><!-- doxytag: member="BufferTypeQueue" ref="adb63e22074734759c387bf1494c39d58aace9508a711e08bfb1ee4c2ad809b68c" args="" -->BufferTypeQueue</em> </td><td>
<p>When the maximum depth of the buffer is reached, ignores new incoming data, until the oldest entry is popped to make room. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a954ed6c6e104e07d976334f9eadfe9cd"></a><!-- doxytag: member="gbxiceutilacfr::checkedSleep" ref="a954ed6c6e104e07d976334f9eadfe9cd" args="(gbxutilacfr::Stoppable *activity, const IceUtil::Time &duration, int checkIntervalMs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gbxiceutilacfr::checkedSleep </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgbxutilacfr_1_1Stoppable.html">gbxutilacfr::Stoppable</a> * </td>
<td class="paramname"> <em>activity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const IceUtil::Time & </td>
<td class="paramname"> <em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>checkIntervalMs</em> = <code>250</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sleeps for duration waking up every checkIntervalMs [ms] to check if the <code>activity</code> 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. </p>
</div>
</div>
<a class="anchor" id="a1a0ede0789d998dfeb089f727e30f4d6"></a><!-- doxytag: member="gbxiceutilacfr::stopAndJoin" ref="a1a0ede0789d998dfeb089f727e30f4d6" args="(const gbxiceutilacfr::ThreadPtr &thread)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gbxiceutilacfr::stopAndJoin </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacegbxiceutilacfr.html#a426649efe8df447b1e04fa1e46efde08">gbxiceutilacfr::ThreadPtr</a> & </td>
<td class="paramname"> <em>thread</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A convenience function which first stops the <code>thread</code> and then waits for it to terminate. If the smart pointer is 0, this function quietly returns. </p>
</div>
</div>
<a class="anchor" id="a76e8a60c1aedfcd6eb8ee677ad05d6fd"></a><!-- doxytag: member="gbxiceutilacfr::stopAndJoin" ref="a76e8a60c1aedfcd6eb8ee677ad05d6fd" args="(gbxiceutilacfr::Thread *thread)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gbxiceutilacfr::stopAndJoin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgbxiceutilacfr_1_1Thread.html">gbxiceutilacfr::Thread</a> * </td>
<td class="paramname"> <em>thread</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A convenience function which first stops the <code>thread</code> and then waits for it to terminate. If the pointer is NULL, this function quietly returns. </p>
</div>
</div>
</div>
</td>
<td colspan="1"> </td>
</tr>
</table>
<!-- end of table -->
<hr size="1"><address style="align: right;"><small>Generated for GearBox by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>
