<!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 class="current"><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="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacegbxiceutilacfr.html">gbxiceutilacfr</a>::<a class="el" href="classgbxiceutilacfr_1_1Notify.html">Notify</a>
</div>
</div>
<div class="contents">
<h1>gbxiceutilacfr::Notify< Type > Class Template Reference</h1><!-- doxytag: class="gbxiceutilacfr::Notify" -->
<p>A data pipe with callback semantics.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="notify_8h_source.html">notify.h</a>></code></p>
<p><a href="classgbxiceutilacfr_1_1Notify-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxiceutilacfr_1_1Notify.html#af3ad1117862e4583f041b39c048f7afa">setNotifyHandler</a> (<a class="el" href="classgbxiceutilacfr_1_1NotifyHandler.html">NotifyHandler</a>< Type > *handler)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75e6af49dbdc257eab723d9c67df5ef5"></a><!-- doxytag: member="gbxiceutilacfr::Notify::hasNotifyHandler" ref="a75e6af49dbdc257eab723d9c67df5ef5" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxiceutilacfr_1_1Notify.html#a75e6af49dbdc257eab723d9c67df5ef5">hasNotifyHandler</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns TRUE is the notify handler has been set and FALSE otherwise. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxiceutilacfr_1_1Notify.html#a5832de18053b77107f43c030f76a64ef">set</a> (const Type &obj)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab981375176460f005b759e89db31f187"></a><!-- doxytag: member="gbxiceutilacfr::Notify::internalSet" ref="ab981375176460f005b759e89db31f187" args="(const Type &obj)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxiceutilacfr_1_1Notify.html#ab981375176460f005b759e89db31f187">internalSet</a> (const Type &obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reimplement this function for non-standard types. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f1a2d13cff007d8176bb70f8169285a"></a><!-- doxytag: member="gbxiceutilacfr::Notify::handler_" ref="a1f1a2d13cff007d8176bb70f8169285a" args="" -->
<a class="el" href="classgbxiceutilacfr_1_1NotifyHandler.html">NotifyHandler</a>< Type > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxiceutilacfr_1_1Notify.html#a1f1a2d13cff007d8176bb70f8169285a">handler_</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Interface to the object which is notified of incoming data. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class Type><br/>
class gbxiceutilacfr::Notify< Type ></h3>
<p>A data pipe with callback semantics. </p>
<p>Write new data with <a class="el" href="classgbxiceutilacfr_1_1Notify.html#a5832de18053b77107f43c030f76a64ef">Notify::set</a>. The data is delivered to the data handler by calling <a class="el" href="classgbxiceutilacfr_1_1NotifyHandler.html#a48ad52ad60714e769bfe36a47a731cf4">NotifyHandler::handleData</a> in the registered <a class="el" href="classgbxiceutilacfr_1_1NotifyHandler.html" title="The object which implements the callback function.">NotifyHandler</a>.</p>
<p>When used with smart pointers (e.g. IceUtil smart pointers), this class will not perform a deep copy.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgbxiceutilacfr_1_1Buffer.html" title="A thread-safe data pipe with buffer semantics.">Buffer</a>, Proxy </dd></dl>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5832de18053b77107f43c030f76a64ef"></a><!-- doxytag: member="gbxiceutilacfr::Notify::set" ref="a5832de18053b77107f43c030f76a64ef" args="(const Type &obj)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Type > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgbxiceutilacfr_1_1Notify.html">gbxiceutilacfr::Notify</a>< Type >::set </td>
<td>(</td>
<td class="paramtype">const Type & </td>
<td class="paramname"> <em>obj</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Forwards the <code>obj</code> to the data handler. Raises <a class="el" href="classgbxutilacfr_1_1Exception.html" title="Base class for all GbxUtilAcfr exceptions.">gbxutilacfr::Exception</a> if the function is called when a notify handler has not been set. </p>
<p>References <a class="el" href="notify_8h_source.html#l00108">gbxiceutilacfr::Notify< Type >::internalSet()</a>.</p>
</div>
</div>
<a class="anchor" id="af3ad1117862e4583f041b39c048f7afa"></a><!-- doxytag: member="gbxiceutilacfr::Notify::setNotifyHandler" ref="af3ad1117862e4583f041b39c048f7afa" args="(NotifyHandler< Type > *handler)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Type > </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classgbxiceutilacfr_1_1Notify.html">gbxiceutilacfr::Notify</a>< Type >::setNotifyHandler </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgbxiceutilacfr_1_1NotifyHandler.html">NotifyHandler</a>< Type > * </td>
<td class="paramname"> <em>handler</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets internal link to the notify handler. If the provided pointer is NULL, the internal link is quietly not set. </p>
<p>References <a class="el" href="notify_8h_source.html#l00078">gbxiceutilacfr::Notify< Type >::handler_</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="notify_8h_source.html">notify.h</a></li>
</ul>
</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>
