<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>C++ API frePPLe: frepple::utils::Functor Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="../styles.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="container">
<div id="menubar">
<div id="logo" align="center">
<br/><img src='../frepple.bmp' alt="frepple" /><br/>
<a href='http://www.frepple.com/'>
<strong>a Free<br/>Production Planning<br/>Library</strong>
</a>
</div>
<div id="menu">
<br/>
<h3><a href='../Main/HomePage.html'>Main</a></h3>
<h3><a href='../UI/Main.html'>User Manual</a></h3>
<h3><a href='../Tutorial/Main.html'>Tutorial</a></h3>
<h3><a href='../Frepple/Main.html'>Reference Manual</a></h3>
<h3><a href='../Main/FAQ.html'>FAQ</a></h3>
<h3><a href='index.html'>C++ API</a></h3>
<br/>
</div>
</div>
<div id="content">
<br/>
<!-- Generated by Doxygen 1.6.1 -->
<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="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="classes.html"><span>Class Index</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="a00256.html">frepple</a>::<a class="el" href="a00257.html">utils</a>::<a class="el" href="a00079.html">Functor</a>
</div>
</div>
<div class="contents">
<h1>frepple::utils::Functor Class Reference</h1><!-- doxytag: class="frepple::utils::Functor" --><!-- doxytag: inherits="frepple::utils::NonCopyable" -->
<p>This abstract class is the base class used for callbacks.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00252_source.html">utils.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for frepple::utils::Functor:</div>
<div class="dynsection">
<div class="center"><img src="a00581.png" border="0" usemap="#frepple_1_1utils_1_1_functor_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1utils_1_1_functor_inherit__map" id="frepple_1_1utils_1_1_functor_inherit__map">
<area shape="rect" id="node5" href="a00080.html" title="This class represents an object subscribing to a signal." alt="" coords="5,161,245,189"/>
<area shape="rect" id="node7" href="a00081.html" title="This class represents a static subscription to a signal." alt="" coords="269,161,493,189"/>
<area shape="rect" id="node2" href="a00119.html" title="Class NonCopyable is a base class. Derive your own class from it when you want to..." alt="" coords="165,6,341,34"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00582.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">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#a751c6299c594fbfdbaf281315568656e">callback</a> (<a class="el" href="a00120.html">Object</a> *v, const <a class="el" href="a00257.html#aec6d4a238b0cd9ffc8be8f10fd9b652f">Signal</a> a) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00079.html#a508efa0f9e0407c48c27bb26505f8f57">~Functor</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This abstract class is the base class used for callbacks. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>MetaClass::callback </dd>
<dd>
<a class="el" href="a00081.html" title="This class represents a static subscription to a signal.">FunctorStatic</a> </dd>
<dd>
<a class="el" href="a00080.html" title="This class represents an object subscribing to a signal.">FunctorInstance</a> </dd></dl>
<p>Definition at line <a class="el" href="a00252_source.html#l00962">962</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a508efa0f9e0407c48c27bb26505f8f57"></a><!-- doxytag: member="frepple::utils::Functor::~Functor" ref="a508efa0f9e0407c48c27bb26505f8f57" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual frepple::utils::Functor::~Functor </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l00975">975</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a751c6299c594fbfdbaf281315568656e"></a><!-- doxytag: member="frepple::utils::Functor::callback" ref="a751c6299c594fbfdbaf281315568656e" args="(Object *v, const Signal a) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool frepple::utils::Functor::callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00120.html">Object</a> * </td>
<td class="paramname"> <em>v</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00257.html#aec6d4a238b0cd9ffc8be8f10fd9b652f">Signal</a> </td>
<td class="paramname"> <em>a</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is the callback method.<br/>
The return value should be true in case the action is allowed to happen. In case a subscriber disapproves the action false is returned.<br/>
It is important that the callback methods are implemented in a thread-safe and re-entrant way!!! </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00252_source.html">utils.h</a></li>
</ul>
</div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"/></a></small></address>
</div>
</div>
</body>
</html>
