<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title>OpenVRML: openvrml::field_value_emitter< FieldValue > Class Template Reference</title> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <link rel="icon" href="../vrml-16"> <link rel="start" href="http://openvrml.org/index" title="OpenVRML Home"> <link rel="prev" href="http://openvrml.org/discussion" title="Discussion"> <link rel="contents" href="index" title="Documentation Main Page"> <link rel="index" href="functions" title="OpenVRML Compound Members"> <link rel="appendix" href="conformance" title="Conformance Test Results"> <style type="text/css"> @import url("tabs.css"); @import url("http://openvrml.org/openvrml.css"); table { width: 100%; } h2 { border-bottom-style: solid; border-bottom-width: 1px; } /* * Doxygen as of 1.5.4-20071217 uses the class "navpath" instead of "nav". * For now, we'll do both. */ div.nav, div.navpath { background-color: transparent; text-align: left; margin-top: 1em; margin-bottom: 1em; border-color: black; border-left: none; border-right: none; padding-top: 0.5em; padding-bottom: 0.5em; } div.nav :link, div.nav :visited, div.navpath :link, div.navpath :visited { border-width: 1px; border-style: solid; border-color: silver; padding: 2px; } div.nav :link:hover, div.nav :visited:hover, div.navpath :link:hover, div.navpath :visited:hover { border-style: outset; border-color: gray; } div.nav :active, div.navpath :active { border-style: inset; border-color: gray; } .body td { background-color: transparent; } .el { text-decoration: inherit; font-weight: inherit } .elRef { font-weight: inherit } .code:link, .code:visited { text-decoration: inherit; font-weight: inherit; color: inherit; } .codeRef:link { font-weight: normal; color: inherit; } :visited { color: silver; } :link:hover { color: inherit; text-decoration: inherit; background-color: transparent; } h1 { line-height: 1.2em; } td.memItemLeft, td.memItemRight, td.memTemplParams, td.memTemplItemLeft, td.memTemplItemRight, .memtemplate, .memname td { font-family: Consolas, "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Lucida Console", LucidaTypewriter, monospace; } td.memItemLeft, td.memItemRight, td.mdescLeft, td.mdescRight { background-color: rgb(95%, 95%, 95%); border-color: rgb(65%, 65%, 65%); border-width: 1px; font-size: smaller; } .memItemLeft { margin-top: 0.5em; border-top-style: solid; } .mdescLeft { border-bottom-style: solid; } .memItemRight { border-top-style: solid; margin-top: 0.5em; } .mdescRight { border-bottom-style: solid; } .mdescRight { font-style: italic; } .mdTable { background-color: rgb(95%, 95%, 95%); } .memproto td code { font-family: inherit; font-style: italic; } td.pass { background-color: rgb(50%, 100%, 50%); } td.fail { background-color: rgb(100%, 50%, 50%); } td.invalid { background-color: rgb(75%, 75%, 75%); } .memitem { padding: 0; } .memitem table { width: auto; } .memproto, .memdoc { border-width: 1px; border-color: rgb(65%, 65%, 65%); } .memproto { background-color: rgb(90%, 90%, 90%); font-weight: inherit; font-size: smaller; border-top-style: solid; border-left-style: solid; border-right-style: solid; -webkit-border-top-left-radius: 0.6em; -webkit-border-top-right-radius: 0.6em; -moz-border-radius-topleft: 0.6em; -moz-border-radius-topright: 0.6em; } .memdoc { background-color: rgb(95%, 95%, 95%); padding: 2px 5px; border-style: solid; -webkit-border-bottom-left-radius: 0.6em; -webkit-border-bottom-right-radius: 0.6em; -moz-border-radius-bottomleft: 0.6em; -moz-border-radius-bottomright: 0.6em; } .memname { font-weight: inherit; } div.tabs { background-image: url("tab_b-openvrml.png"); } div.tabs span { background-image: url("tab_l-openvrml.png"); } div.tabs a { background-image: url("tab_r-openvrml.png"); border-bottom: 1px solid #a5a5a5; } div.tabs a:link, div.tabs a:visited, div.tabs a:active, div.tabs a:hover { color: black; } table { border-collapse: collapse; border-spacing: 0; } .note { border: 1px solid rgb(65%, 65%, 65%); background-color: rgb(95%, 95%, 95%); margin-left: 10%; margin-right: 10%; } </style> </head> <body> <table class="sitenav"> <tr> <th><a href="http://openvrml.org/index" title="Home">Home</a></th> <th><a href="http://openvrml.org/download" title="Download">Download</a></th> <th><a href="http://openvrml.org/screenshots/index" title="Screen shots">Screen shots</a></th> <th><a href="http://openvrml.org/discussion" title="Mailing lists and IRC">Discussion</a></th> <th>Documentation</th> </tr> </table> <div class="body"> <!-- Generated by Doxygen 1.5.8 --> <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="examples.html"><span>Examples</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="namespaceopenvrml.html">openvrml</a>::<a class="el" href="classopenvrml_1_1field__value__emitter.html">field_value_emitter</a> </div> </div> <div class="contents"> <h1>openvrml::field_value_emitter< FieldValue > Class Template Reference</h1><!-- doxytag: class="openvrml::field_value_emitter" --><!-- doxytag: inherits="openvrml::event_emitter" -->Concrete event emitter template. <a href="#_details">More...</a> <p> <code>#include <openvrml/event.h></code> <p> <div class="dynheader"> Inheritance diagram for openvrml::field_value_emitter< FieldValue >:</div> <div class="dynsection"> <p><center><img src="classopenvrml_1_1field__value__emitter__inherit__graph.png" border="0" usemap="#openvrml_1_1field__value__emitter_3_01FieldValue_01_4__inherit__map" alt="Inheritance graph"></center> <map name="openvrml_1_1field__value__emitter_3_01FieldValue_01_4__inherit__map"> <area shape="rect" href="classopenvrml_1_1script__node_1_1url__changed__emitter.html" title="url_changed event emitter." alt="" coords="627,37,979,67"><area shape="rect" href="classopenvrml_1_1field__value__emitter.html" title="openvrml::field_value_emitter\< mfstring \>" alt="" coords="669,91,936,120"><area shape="rect" href="classopenvrml_1_1field__value__emitter.html" title="openvrml::field_value_emitter\< sfnode \>" alt="" coords="672,144,933,173"><area shape="rect" href="classopenvrml_1_1event__emitter.html" title="Abstract base class of event emitters." alt="" coords="7,91,169,120"><area shape="rect" href="classopenvrml_1_1exposedfield.html" title="openvrml::exposedfield\< sfnode \>" alt="" coords="1117,117,1344,147"><area shape="rect" href="classopenvrml_1_1script__node_1_1metadata__changed__emitter.html" title="metadata_changed event emitter." alt="" coords="1029,171,1432,200"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="classopenvrml_1_1field__value__emitter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1field__value__emitter.html#da63dbd07612814122824d638ff1b824">field_value_emitter</a> (const FieldValue &value) throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct. <a href="#da63dbd07612814122824d638ff1b824"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1field__value__emitter.html#696a59ae6beddbafdb34ad39146b4c3d">~field_value_emitter</a> ()=0 throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy. <a href="#696a59ae6beddbafdb34ad39146b4c3d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1field__value__emitter.html#4e76ebfd4060c24734881ca8ca6726af">add</a> (<a class="el" href="classopenvrml_1_1field__value__listener.html">field_value_listener</a>< FieldValue > &listener) throw ( std::bad_alloc )</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add an event listener. <a href="#4e76ebfd4060c24734881ca8ca6726af"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1field__value__emitter.html#596539e838dbbd15b695feda21956320">remove</a> (<a class="el" href="classopenvrml_1_1field__value__listener.html">field_value_listener</a>< FieldValue > &listener) throw ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove an event listener. <a href="#596539e838dbbd15b695feda21956320"></a><br></td></tr> <tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenvrml_1_1field__value__emitter.html#9218fb63430b6837873b9c78a55ea24e">emit_event</a> (double timestamp) throw ( std::bad_alloc )</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Emit an event. <a href="#9218fb63430b6837873b9c78a55ea24e"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <h3>template<typename FieldValue><br> class openvrml::field_value_emitter< FieldValue ></h3> Concrete event emitter template. <p> <dl compact><dt><b>Template Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>FieldValue</em> </td><td>a <a class="el" href="structopenvrml_1_1FieldValueConcept.html">Field Value</a>. </td></tr> </table> </dl> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="da63dbd07612814122824d638ff1b824"></a><!-- doxytag: member="openvrml::field_value_emitter::field_value_emitter" ref="da63dbd07612814122824d638ff1b824" args="(const FieldValue &value)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename FieldValue> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classopenvrml_1_1field__value__emitter.html">openvrml::field_value_emitter</a>< FieldValue >::<a class="el" href="classopenvrml_1_1field__value__emitter.html">field_value_emitter</a> </td> <td>(</td> <td class="paramtype">const FieldValue & </td> <td class="paramname"> <em>value</em> </td> <td> ) </td> <td> throw ()<code> [inline, explicit]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Construct. <p> <dl compact><dt><b>Template Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>FieldValue</em> </td><td>a <a class="el" href="structopenvrml_1_1FieldValueConcept.html">Field Value</a>.</td></tr> </table> </dl> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>value</em> </td><td><code><a class="el" href="classopenvrml_1_1field__value.html" title="Abstract base class for the VRML field types.">field_value</a></code> associated with this emitter. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="696a59ae6beddbafdb34ad39146b4c3d"></a><!-- doxytag: member="openvrml::field_value_emitter::~field_value_emitter" ref="696a59ae6beddbafdb34ad39146b4c3d" args="()=0" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename FieldValue > </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classopenvrml_1_1field__value__emitter.html">openvrml::field_value_emitter</a>< FieldValue >::~<a class="el" href="classopenvrml_1_1field__value__emitter.html">field_value_emitter</a> </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> throw ()<code> [inline, pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Destroy. <p> <dl compact><dt><b>Template Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>FieldValue</em> </td><td>a <a class="el" href="structopenvrml_1_1FieldValueConcept.html">Field Value</a>. </td></tr> </table> </dl> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="4e76ebfd4060c24734881ca8ca6726af"></a><!-- doxytag: member="openvrml::field_value_emitter::add" ref="4e76ebfd4060c24734881ca8ca6726af" args="(field_value_listener< FieldValue > &listener)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename FieldValue> </div> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="classopenvrml_1_1field__value__emitter.html">openvrml::field_value_emitter</a>< FieldValue >::add </td> <td>(</td> <td class="paramtype"><a class="el" href="classopenvrml_1_1field__value__listener.html">field_value_listener</a>< FieldValue > & </td> <td class="paramname"> <em>listener</em> </td> <td> ) </td> <td> throw ( std::bad_alloc )<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Add an event listener. <p> <dl compact><dt><b>Template Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>FieldValue</em> </td><td>a <a class="el" href="structopenvrml_1_1FieldValueConcept.html">Field Value</a>.</td></tr> </table> </dl> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>listener</em> </td><td>the listener to add.</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if <code>listener</code> was added; <code>false</code> if <code>listener</code> was not added (if it was already registered for the emitter).</dd></dl> <dl compact><dt><b>Exceptions:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>std::bad_alloc</em> </td><td>if memory allocation fails. </td></tr> </table> </dl> <p>Reimplemented from <a class="el" href="classopenvrml_1_1event__emitter.html#2ba7b0e817caebf1be81c6840660fabe">openvrml::event_emitter</a>.</p> </div> </div><p> <a class="anchor" name="596539e838dbbd15b695feda21956320"></a><!-- doxytag: member="openvrml::field_value_emitter::remove" ref="596539e838dbbd15b695feda21956320" args="(field_value_listener< FieldValue > &listener)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename FieldValue> </div> <table class="memname"> <tr> <td class="memname">bool <a class="el" href="classopenvrml_1_1field__value__emitter.html">openvrml::field_value_emitter</a>< FieldValue >::remove </td> <td>(</td> <td class="paramtype"><a class="el" href="classopenvrml_1_1field__value__listener.html">field_value_listener</a>< FieldValue > & </td> <td class="paramname"> <em>listener</em> </td> <td> ) </td> <td> throw ()<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Remove an event listener. <p> <dl compact><dt><b>Template Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>FieldValue</em> </td><td>a <a class="el" href="structopenvrml_1_1FieldValueConcept.html">Field Value</a>.</td></tr> </table> </dl> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>listener</em> </td><td>the listener to remove.</td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if <code>listener</code> was removed; <code>false</code> if <code>listener</code> was not removed (if it was not registered for the emitter). </dd></dl> <p>Reimplemented from <a class="el" href="classopenvrml_1_1event__emitter.html#3d5158b7dfc98b73cc4aa29652daf7f4">openvrml::event_emitter</a>.</p> </div> </div><p> <a class="anchor" name="9218fb63430b6837873b9c78a55ea24e"></a><!-- doxytag: member="openvrml::field_value_emitter::emit_event" ref="9218fb63430b6837873b9c78a55ea24e" args="(double timestamp)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename FieldValue > </div> <table class="memname"> <tr> <td class="memname">void <a class="el" href="classopenvrml_1_1field__value__emitter.html">openvrml::field_value_emitter</a>< FieldValue >::emit_event </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"> <em>timestamp</em> </td> <td> ) </td> <td> throw ( std::bad_alloc )<code> [inline, private, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Emit an event. <p> <dl compact><dt><b>Template Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>FieldValue</em> </td><td>a <a class="el" href="structopenvrml_1_1FieldValueConcept.html">Field Value</a>.</td></tr> </table> </dl> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>timestamp</em> </td><td>the current time.</td></tr> </table> </dl> <dl compact><dt><b>Exceptions:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>std::bad_alloc</em> </td><td>if memory allocation fails. </td></tr> </table> </dl> <p>Reimplemented from <a class="el" href="classopenvrml_1_1event__emitter.html#69c5f700e175b68943ad1be508780e01">openvrml::event_emitter</a>.</p> </div> </div><p> </div> </div> <address class="footer"><span class="images"><a href="http://web3d.org/x3d/"><img src="x3d-white-on-black.png" width="43" height="32" border="0" alt="X3D"></a><a href="http://opengl.org"><img src="OGL_sm_wht.png" width="68" height="32" border="0" alt="OpenGL"></a><a href="http://sourceforge.net/projects/openvrml"><img src="http://sourceforge.net/sflogo.php?group_id=7151&type=11" width="120" height="30" border="0" alt="SourceForge.net"></a></span><a href="https://sourceforge.net/apps/trac/openvrml/newticket">Report error</a><br>Generated Thu Aug 13 02:49:18 2009 by Doxygen 1.5.8</address> <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> <script type="text/javascript">_uacct = "UA-446379-2"; urchinTracker();</script> <!-- Piwik --> <script type="text/javascript"> var pkBaseURL = (("https:" == document.location.protocol) ? "https://sourceforge.net/apps/piwik/openvrml/" : "http://sourceforge.net/apps/piwik/openvrml/"); document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E")); </script><script type="text/javascript"> piwik_action_name = ''; piwik_idsite = 1; piwik_url = pkBaseURL + "piwik.php"; piwik_log(piwik_action_name, piwik_idsite, piwik_url); </script> <object><noscript><p><img src="http://sourceforge.net/apps/piwik/openvrml/piwik.php?idsite=1" alt="piwik"/></p></noscript></object> <!-- End Piwik Tag --> </body> </html>