<!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><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_b8ba9ebcb71a95a44c4fd60b7d348fe1.html">src</a> » <a class="el" href="dir_e6faee39d20d45fac309cc35f2ddb285.html">gbxsickacfr</a> » <a class="el" href="dir_40c823cb7c24b596a1e1c0c483dfcd86.html">gbxiceutilacfr</a>
</div>
</div>
<div class="contents">
<h1>notify.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * GearBox Project: Peer-Reviewed Open-Source Libraries for Robotics</span>
<a name="l00003"></a>00003 <span class="comment"> * http://gearbox.sf.net/</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (c) 2004-2008 Alex Brooks, Alexei Makarenko, Tobias Kaupp</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * This distribution is licensed to you under the terms described in</span>
<a name="l00007"></a>00007 <span class="comment"> * the LICENSE file included in this distribution.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> */</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="preprocessor">#ifndef GBXICEUTILACFR_NOTIFY_H</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span><span class="preprocessor">#define GBXICEUTILACFR_NOTIFY_H</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span>
<a name="l00014"></a>00014 <span class="preprocessor">#include <gbxutilacfr/exceptions.h></span>
<a name="l00015"></a>00015 <span class="preprocessor">#include <iostream></span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="comment">//</span>
<a name="l00018"></a>00018 <span class="comment">// note: this class can be libGbxUtilAcfr but we keep it with the other "data pattern"</span>
<a name="l00019"></a>00019 <span class="comment">// classes: Store and Buffer.</span>
<a name="l00020"></a>00020 <span class="comment">//</span>
<a name="l00021"></a>00021 <span class="keyword">namespace </span>gbxiceutilacfr {
<a name="l00022"></a>00022
<a name="l00029"></a>00029 <span class="keyword">template</span><<span class="keyword">class</span> Type>
<a name="l00030"></a><a class="code" href="classgbxiceutilacfr_1_1NotifyHandler.html">00030</a> <span class="keyword">class </span><a class="code" href="classgbxiceutilacfr_1_1NotifyHandler.html" title="The object which implements the callback function.">NotifyHandler</a>
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032 <span class="keyword">public</span>:
<a name="l00033"></a>00033 <span class="keyword">virtual</span> ~<a class="code" href="classgbxiceutilacfr_1_1NotifyHandler.html" title="The object which implements the callback function.">NotifyHandler</a>() {};
<a name="l00037"></a>00037 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgbxiceutilacfr_1_1NotifyHandler.html#a48ad52ad60714e769bfe36a47a731cf4">handleData</a>( <span class="keyword">const</span> Type & obj )=0;
<a name="l00038"></a>00038 };
<a name="l00039"></a>00039
<a name="l00051"></a>00051 <span class="keyword">template</span><<span class="keyword">class</span> Type>
<a name="l00052"></a><a class="code" href="classgbxiceutilacfr_1_1Notify.html">00052</a> <span class="keyword">class </span><a class="code" href="classgbxiceutilacfr_1_1Notify.html" title="A data pipe with callback semantics.">Notify</a>
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054 <span class="keyword">public</span>:
<a name="l00055"></a>00055 <a class="code" href="classgbxiceutilacfr_1_1Notify.html" title="A data pipe with callback semantics.">Notify</a>()
<a name="l00056"></a>00056 : hasNotifyHandler_(<span class="keyword">false</span>)
<a name="l00057"></a>00057 {};
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keyword">virtual</span> ~<a class="code" href="classgbxiceutilacfr_1_1Notify.html" title="A data pipe with callback semantics.">Notify</a>() {};
<a name="l00060"></a>00060
<a name="l00063"></a>00063 <span class="keywordtype">void</span> <a class="code" href="classgbxiceutilacfr_1_1Notify.html#af3ad1117862e4583f041b39c048f7afa">setNotifyHandler</a>( <a class="code" href="classgbxiceutilacfr_1_1NotifyHandler.html" title="The object which implements the callback function.">NotifyHandler<Type></a>* handler );
<a name="l00064"></a>00064
<a name="l00066"></a><a class="code" href="classgbxiceutilacfr_1_1Notify.html#a75e6af49dbdc257eab723d9c67df5ef5">00066</a> <span class="keywordtype">bool</span> <a class="code" href="classgbxiceutilacfr_1_1Notify.html#a75e6af49dbdc257eab723d9c67df5ef5" title="Returns TRUE is the notify handler has been set and FALSE otherwise.">hasNotifyHandler</a>() { <span class="keywordflow">return</span> hasNotifyHandler_; };
<a name="l00067"></a>00067
<a name="l00071"></a>00071 <span class="keywordtype">void</span> <span class="keyword">set</span>( <span class="keyword">const</span> Type & obj );
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keyword">protected</span>:
<a name="l00075"></a>00075 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgbxiceutilacfr_1_1Notify.html#ab981375176460f005b759e89db31f187" title="Reimplement this function for non-standard types.">internalSet</a>( <span class="keyword">const</span> Type & obj );
<a name="l00076"></a>00076
<a name="l00078"></a><a class="code" href="classgbxiceutilacfr_1_1Notify.html#a1f1a2d13cff007d8176bb70f8169285a">00078</a> <a class="code" href="classgbxiceutilacfr_1_1NotifyHandler.html" title="The object which implements the callback function.">NotifyHandler<Type></a>* <a class="code" href="classgbxiceutilacfr_1_1Notify.html#a1f1a2d13cff007d8176bb70f8169285a" title="Interface to the object which is notified of incoming data.">handler_</a>;
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="keyword">private</span>:
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keywordtype">bool</span> hasNotifyHandler_;
<a name="l00083"></a>00083 };
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keyword">template</span><<span class="keyword">class</span> Type>
<a name="l00086"></a><a class="code" href="classgbxiceutilacfr_1_1Notify.html#af3ad1117862e4583f041b39c048f7afa">00086</a> <span class="keywordtype">void</span> <a class="code" href="classgbxiceutilacfr_1_1Notify.html#af3ad1117862e4583f041b39c048f7afa">Notify<Type>::setNotifyHandler</a>( <a class="code" href="classgbxiceutilacfr_1_1NotifyHandler.html" title="The object which implements the callback function.">NotifyHandler<Type></a>* handler )
<a name="l00087"></a>00087 {
<a name="l00088"></a>00088 <span class="keywordflow">if</span> ( handler == 0 ) {
<a name="l00089"></a>00089 std::cout<<<span class="stringliteral">"TRACE(notify.h): no handler set. Ignoring data."</span> << std::endl;
<a name="l00090"></a>00090 <span class="keywordflow">return</span>;
<a name="l00091"></a>00091 }
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <a class="code" href="classgbxiceutilacfr_1_1Notify.html#a1f1a2d13cff007d8176bb70f8169285a" title="Interface to the object which is notified of incoming data.">handler_</a> = handler;
<a name="l00094"></a>00094 hasNotifyHandler_ = <span class="keyword">true</span>;
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keyword">template</span><<span class="keyword">class</span> Type>
<a name="l00098"></a><a class="code" href="classgbxiceutilacfr_1_1Notify.html#a5832de18053b77107f43c030f76a64ef">00098</a> <span class="keywordtype">void</span> <a class="code" href="classgbxiceutilacfr_1_1Notify.html#a5832de18053b77107f43c030f76a64ef">Notify<Type>::set</a>( <span class="keyword">const</span> Type & obj )
<a name="l00099"></a>00099 {
<a name="l00100"></a>00100 <span class="keywordflow">if</span> ( !hasNotifyHandler_ ) {
<a name="l00101"></a>00101 <span class="keywordflow">throw</span> <a class="code" href="classgbxutilacfr_1_1Exception.html" title="Base class for all GbxUtilAcfr exceptions.">gbxutilacfr::Exception</a>( ERROR_INFO, <span class="stringliteral">"setting data when data handler has not been set"</span> );
<a name="l00102"></a>00102 }
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <a class="code" href="classgbxiceutilacfr_1_1Notify.html#ab981375176460f005b759e89db31f187" title="Reimplement this function for non-standard types.">internalSet</a>( obj );
<a name="l00105"></a>00105 }
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keyword">template</span><<span class="keyword">class</span> Type>
<a name="l00108"></a><a class="code" href="classgbxiceutilacfr_1_1Notify.html#ab981375176460f005b759e89db31f187">00108</a> <span class="keywordtype">void</span> <a class="code" href="classgbxiceutilacfr_1_1Notify.html#ab981375176460f005b759e89db31f187" title="Reimplement this function for non-standard types.">Notify<Type>::internalSet</a>( <span class="keyword">const</span> Type & obj )
<a name="l00109"></a>00109 {
<a name="l00110"></a>00110 <a class="code" href="classgbxiceutilacfr_1_1Notify.html#a1f1a2d13cff007d8176bb70f8169285a" title="Interface to the object which is notified of incoming data.">handler_</a>->handleData( obj );
<a name="l00111"></a>00111 }
<a name="l00112"></a>00112
<a name="l00113"></a>00113 } <span class="comment">// end namespace</span>
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="preprocessor">#endif</span>
</pre></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>
