<!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::FunctorInstance< T, U > Class Template 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="a00080.html">FunctorInstance</a> </div> </div> <div class="contents"> <h1>frepple::utils::FunctorInstance< T, U > Class Template Reference</h1><!-- doxytag: class="frepple::utils::FunctorInstance" --><!-- doxytag: inherits="frepple::utils::Functor" --> <p>This class represents an object subscribing to a signal. <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::FunctorInstance< T, U >:</div> <div class="dynsection"> <div class="center"><img src="a00583.png" border="0" usemap="#frepple_1_1utils_1_1_functor_instance_3_01_t_00_01_u_01_4_inherit__map" alt="Inheritance graph"/></div> <map name="frepple_1_1utils_1_1_functor_instance_3_01_t_00_01_u_01_4_inherit__map" id="frepple_1_1utils_1_1_functor_instance_3_01_t_00_01_u_01_4_inherit__map"> <area shape="rect" id="node2" href="a00079.html" title="This abstract class is the base class used for callbacks." alt="" coords="53,83,197,111"/> <area shape="rect" id="node4" href="a00119.html" title="Class NonCopyable is a base class. Derive your own class from it when you want to..." alt="" coords="37,6,213,34"/> </map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="a00584.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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#a76b27dec70e6d0f04576f247a661c2d7">FunctorInstance</a> (U *u)</td></tr> <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#a4f1e9bd8724b0aa9675fe64cc1f36925">connect</a> (U *u, const <a class="el" href="a00257.html#aec6d4a238b0cd9ffc8be8f10fd9b652f">Signal</a> a)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00080.html#a3df3c2eb6f89bfd3f7563948436535e7">disconnect</a> (U *u, const <a class="el" href="a00257.html#aec6d4a238b0cd9ffc8be8f10fd9b652f">Signal</a> a)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <h3>template<class T, class U><br/> class frepple::utils::FunctorInstance< T, U ></h3> <p>This class represents an object subscribing to a signal. </p> <p>When the signal callback is triggered the method callback() on the instance object will be called. </p> <p>Definition at line <a class="el" href="a00252_source.html#l01523">1523</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a76b27dec70e6d0f04576f247a661c2d7"></a><!-- doxytag: member="frepple::utils::FunctorInstance::FunctorInstance" ref="a76b27dec70e6d0f04576f247a661c2d7" args="(U *u)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T , class U > </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00080.html">frepple::utils::FunctorInstance</a>< T, U >::<a class="el" href="a00080.html">FunctorInstance</a> </td> <td>(</td> <td class="paramtype">U * </td> <td class="paramname"> <em>u</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor. </p> <p>Definition at line <a class="el" href="a00252_source.html#l01558">1558</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="a4f1e9bd8724b0aa9675fe64cc1f36925"></a><!-- doxytag: member="frepple::utils::FunctorInstance::connect" ref="a4f1e9bd8724b0aa9675fe64cc1f36925" args="(U *u, const Signal a)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T , class U > </div> <table class="memname"> <tr> <td class="memname">static void <a class="el" href="a00080.html">frepple::utils::FunctorInstance</a>< T, U >::connect </td> <td>(</td> <td class="paramtype">U * </td> <td class="paramname"> <em>u</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><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Connect a new subscriber to a signal.<br/> It is the users' responsibility to call the disconnect method when the subscriber is being deleted. Otherwise the application will crash. </p> <p>Definition at line <a class="el" href="a00252_source.html#l01531">1531</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p> </div> </div> <a class="anchor" id="a3df3c2eb6f89bfd3f7563948436535e7"></a><!-- doxytag: member="frepple::utils::FunctorInstance::disconnect" ref="a3df3c2eb6f89bfd3f7563948436535e7" args="(U *u, const Signal a)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class T , class U > </div> <table class="memname"> <tr> <td class="memname">static void <a class="el" href="a00080.html">frepple::utils::FunctorInstance</a>< T, U >::disconnect </td> <td>(</td> <td class="paramtype">U * </td> <td class="paramname"> <em>u</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><code> [inline, static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Disconnect from a signal. </p> <p>Definition at line <a class="el" href="a00252_source.html#l01535">1535</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</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>