classfilval_1_1BoundValue.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.12"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TTTT Analysis: filval::BoundValue&lt; T &gt; Class Template Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">TTTT Analysis
  25. &#160;<span id="projectnumber">0.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.12 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <li class="navelem"><a class="el" href="namespacefilval.html">filval</a></li><li class="navelem"><a class="el" href="classfilval_1_1BoundValue.html">BoundValue</a></li> </ul>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> &#124;
  66. <a href="#pro-methods">Protected Member Functions</a> &#124;
  67. <a href="#pro-attribs">Protected Attributes</a> &#124;
  68. <a href="classfilval_1_1BoundValue-members.html">List of all members</a> </div>
  69. <div class="headertitle">
  70. <div class="title">filval::BoundValue&lt; T &gt; Class Template Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>A generic value owning only a function object.
  74. <a href="classfilval_1_1BoundValue.html#details">More...</a></p>
  75. <p><code>#include &lt;<a class="el" href="value_8hpp_source.html">value.hpp</a>&gt;</code></p>
  76. <div class="dynheader">
  77. Inheritance diagram for filval::BoundValue&lt; T &gt;:</div>
  78. <div class="dyncontent">
  79. <div class="center"><img src="classfilval_1_1BoundValue__inherit__graph.png" border="0" usemap="#filval_1_1BoundValue_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
  80. <map name="filval_1_1BoundValue_3_01T_01_4_inherit__map" id="filval_1_1BoundValue_3_01T_01_4_inherit__map">
  81. <area shape="rect" id="node2" href="classfilval_1_1DerivedValue.html" title="A generic, derived, value. " alt="" coords="5,155,192,181"/>
  82. <area shape="rect" id="node3" href="classfilval_1_1Value.html" title="A generic value. " alt="" coords="31,80,167,107"/>
  83. <area shape="rect" id="node4" href="classfilval_1_1GenValue.html" title="A type&#45;agnostic value. " alt="" coords="37,5,161,32"/>
  84. </map>
  85. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  86. <div class="dynheader">
  87. Collaboration diagram for filval::BoundValue&lt; T &gt;:</div>
  88. <div class="dyncontent">
  89. <div class="center"><img src="classfilval_1_1BoundValue__coll__graph.png" border="0" usemap="#filval_1_1BoundValue_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
  90. <map name="filval_1_1BoundValue_3_01T_01_4_coll__map" id="filval_1_1BoundValue_3_01T_01_4_coll__map">
  91. <area shape="rect" id="node2" href="classfilval_1_1DerivedValue.html" title="A generic, derived, value. " alt="" coords="36,171,223,197"/>
  92. <area shape="rect" id="node3" href="classfilval_1_1Value.html" title="A generic value. " alt="" coords="5,81,141,108"/>
  93. <area shape="rect" id="node4" href="classfilval_1_1GenValue.html" title="A type&#45;agnostic value. " alt="" coords="11,5,135,32"/>
  94. </map>
  95. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  96. <table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  98. Public Member Functions</h2></td></tr>
  99. <tr class="memitem:a83b84653daad6bf91231bbe226d97991"><td class="memItemLeft" align="right" valign="top"><a id="a83b84653daad6bf91231bbe226d97991"></a>
  100. &#160;</td><td class="memItemRight" valign="bottom"><b>BoundValue</b> (const std::string &amp;<a class="el" href="classfilval_1_1GenValue.html#a007e38c03ee041c2a657afa3d6e91ab1">name</a>, std::function&lt; T()&gt; f)</td></tr>
  101. <tr class="separator:a83b84653daad6bf91231bbe226d97991"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="inherit_header pub_methods_classfilval_1_1DerivedValue"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classfilval_1_1DerivedValue')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classfilval_1_1DerivedValue.html">filval::DerivedValue&lt; T &gt;</a></td></tr>
  103. <tr class="memitem:a9725de2e3291d27e51e70cc830e19836 inherit pub_methods_classfilval_1_1DerivedValue"><td class="memItemLeft" align="right" valign="top"><a id="a9725de2e3291d27e51e70cc830e19836"></a>
  104. &#160;</td><td class="memItemRight" valign="bottom"><b>DerivedValue</b> (const std::string &amp;<a class="el" href="classfilval_1_1GenValue.html#a007e38c03ee041c2a657afa3d6e91ab1">name</a>)</td></tr>
  105. <tr class="separator:a9725de2e3291d27e51e70cc830e19836 inherit pub_methods_classfilval_1_1DerivedValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a0c18a631ea057510200906e73198fa0c inherit pub_methods_classfilval_1_1DerivedValue"><td class="memItemLeft" align="right" valign="top"><a id="a0c18a631ea057510200906e73198fa0c"></a>
  107. T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfilval_1_1DerivedValue.html#a0c18a631ea057510200906e73198fa0c">get_value</a> ()</td></tr>
  108. <tr class="memdesc:a0c18a631ea057510200906e73198fa0c inherit pub_methods_classfilval_1_1DerivedValue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate, if necessary, and return the value held by this object. <br /></td></tr>
  109. <tr class="separator:a0c18a631ea057510200906e73198fa0c inherit pub_methods_classfilval_1_1DerivedValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="inherit_header pub_methods_classfilval_1_1Value"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classfilval_1_1Value')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classfilval_1_1Value.html">filval::Value&lt; T &gt;</a></td></tr>
  111. <tr class="memitem:acf84b59c04243cffee5c0f361465c83c inherit pub_methods_classfilval_1_1Value"><td class="memItemLeft" align="right" valign="top"><a id="acf84b59c04243cffee5c0f361465c83c"></a>
  112. &#160;</td><td class="memItemRight" valign="bottom"><b>Value</b> (const std::string &amp;<a class="el" href="classfilval_1_1GenValue.html#a007e38c03ee041c2a657afa3d6e91ab1">name</a>)</td></tr>
  113. <tr class="separator:acf84b59c04243cffee5c0f361465c83c inherit pub_methods_classfilval_1_1Value"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="inherit_header pub_methods_classfilval_1_1GenValue"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classfilval_1_1GenValue')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classfilval_1_1GenValue.html">filval::GenValue</a></td></tr>
  115. <tr class="memitem:a8e966db95add619c6d85defcb4c866d7 inherit pub_methods_classfilval_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a8e966db95add619c6d85defcb4c866d7"></a>
  116. &#160;</td><td class="memItemRight" valign="bottom"><b>GenValue</b> (const std::string &amp;<a class="el" href="classfilval_1_1GenValue.html#a007e38c03ee041c2a657afa3d6e91ab1">name</a>)</td></tr>
  117. <tr class="separator:a8e966db95add619c6d85defcb4c866d7 inherit pub_methods_classfilval_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a38cdc9588f97cb1c5f4ae1c2f8fa326a inherit pub_methods_classfilval_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a38cdc9588f97cb1c5f4ae1c2f8fa326a"></a>
  119. const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>get_name</b> ()</td></tr>
  120. <tr class="separator:a38cdc9588f97cb1c5f4ae1c2f8fa326a inherit pub_methods_classfilval_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table><table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  123. Protected Member Functions</h2></td></tr>
  124. <tr class="memitem:a90be966f85204cac57075e4ee66f2fa9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfilval_1_1BoundValue.html#a90be966f85204cac57075e4ee66f2fa9">update_value</a> ()</td></tr>
  125. <tr class="memdesc:a90be966f85204cac57075e4ee66f2fa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the internal value. <a href="#a90be966f85204cac57075e4ee66f2fa9">More...</a><br /></td></tr>
  126. <tr class="separator:a90be966f85204cac57075e4ee66f2fa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. </table><table class="memberdecls">
  128. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  129. Protected Attributes</h2></td></tr>
  130. <tr class="memitem:ae95f1b20407397dfbf84c18722a01c05"><td class="memItemLeft" align="right" valign="top"><a id="ae95f1b20407397dfbf84c18722a01c05"></a>
  131. std::function&lt; T()&gt;&#160;</td><td class="memItemRight" valign="bottom"><b>f</b></td></tr>
  132. <tr class="separator:ae95f1b20407397dfbf84c18722a01c05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="inherit_header pro_attribs_classfilval_1_1DerivedValue"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classfilval_1_1DerivedValue')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classfilval_1_1DerivedValue.html">filval::DerivedValue&lt; T &gt;</a></td></tr>
  134. <tr class="memitem:a2b010ce280e2e3b06156870ea08804cc inherit pro_attribs_classfilval_1_1DerivedValue"><td class="memItemLeft" align="right" valign="top"><a id="a2b010ce280e2e3b06156870ea08804cc"></a>
  135. T&#160;</td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
  136. <tr class="separator:a2b010ce280e2e3b06156870ea08804cc inherit pro_attribs_classfilval_1_1DerivedValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:ae946e1157648857534b5da312be3edf7 inherit pro_attribs_classfilval_1_1DerivedValue"><td class="memItemLeft" align="right" valign="top"><a id="ae946e1157648857534b5da312be3edf7"></a>
  138. bool&#160;</td><td class="memItemRight" valign="bottom"><b>value_valid</b></td></tr>
  139. <tr class="separator:ae946e1157648857534b5da312be3edf7 inherit pro_attribs_classfilval_1_1DerivedValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. </table><table class="memberdecls">
  141. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  142. Additional Inherited Members</h2></td></tr>
  143. <tr class="inherit_header pub_static_methods_classfilval_1_1GenValue"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classfilval_1_1GenValue')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classfilval_1_1GenValue.html">filval::GenValue</a></td></tr>
  144. <tr class="memitem:a6a12aa2c8b6a99573e0fa996f37dd13a inherit pub_static_methods_classfilval_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a6a12aa2c8b6a99573e0fa996f37dd13a"></a>
  145. static void&#160;</td><td class="memItemRight" valign="bottom"><b>reset</b> ()</td></tr>
  146. <tr class="separator:a6a12aa2c8b6a99573e0fa996f37dd13a inherit pub_static_methods_classfilval_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a14659bc5b321f5b914cd911b229f40ef inherit pub_static_methods_classfilval_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a14659bc5b321f5b914cd911b229f40ef"></a>
  148. static <a class="el" href="classfilval_1_1GenValue.html">GenValue</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>get_value</b> (const std::string &amp;<a class="el" href="classfilval_1_1GenValue.html#a007e38c03ee041c2a657afa3d6e91ab1">name</a>)</td></tr>
  149. <tr class="separator:a14659bc5b321f5b914cd911b229f40ef inherit pub_static_methods_classfilval_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a0fc8de3214f885848f2f5761dc0800b7 inherit pub_static_methods_classfilval_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a0fc8de3214f885848f2f5761dc0800b7"></a>
  151. static void&#160;</td><td class="memItemRight" valign="bottom"><b>summary</b> ()</td></tr>
  152. <tr class="separator:a0fc8de3214f885848f2f5761dc0800b7 inherit pub_static_methods_classfilval_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="inherit_header pro_static_attribs_classfilval_1_1GenValue"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_classfilval_1_1GenValue')"><img src="closed.png" alt="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="classfilval_1_1GenValue.html">filval::GenValue</a></td></tr>
  154. <tr class="memitem:aa94f38a80f5a127bf3df33ad53198e57 inherit pro_static_attribs_classfilval_1_1GenValue"><td class="memItemLeft" align="right" valign="top">static std::map&lt; const std::string, <a class="el" href="classfilval_1_1GenValue.html">GenValue</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfilval_1_1GenValue.html#aa94f38a80f5a127bf3df33ad53198e57">values</a></td></tr>
  155. <tr class="memdesc:aa94f38a80f5a127bf3df33ad53198e57 inherit pro_static_attribs_classfilval_1_1GenValue"><td class="mdescLeft">&#160;</td><td class="mdescRight">A static mapping containing all created <a class="el" href="classfilval_1_1Value.html" title="A generic value. ">Value</a> objects. <a href="classfilval_1_1GenValue.html#aa94f38a80f5a127bf3df33ad53198e57">More...</a><br /></td></tr>
  156. <tr class="separator:aa94f38a80f5a127bf3df33ad53198e57 inherit pro_static_attribs_classfilval_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. </table>
  158. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  159. <div class="textblock"><h3>template&lt;typename T&gt;<br />
  160. class filval::BoundValue&lt; T &gt;</h3>
  161. <p>A generic value owning only a function object. </p>
  162. <p>All necessary values upon which this value depends must be bound to the function object. </p>
  163. </div><h2 class="groupheader">Member Function Documentation</h2>
  164. <a id="a90be966f85204cac57075e4ee66f2fa9"></a>
  165. <h2 class="memtitle"><span class="permalink"><a href="#a90be966f85204cac57075e4ee66f2fa9">&sect;&nbsp;</a></span>update_value()</h2>
  166. <div class="memitem">
  167. <div class="memproto">
  168. <div class="memtemplate">
  169. template&lt;typename T &gt; </div>
  170. <table class="mlabels">
  171. <tr>
  172. <td class="mlabels-left">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">void <a class="el" href="classfilval_1_1BoundValue.html">filval::BoundValue</a>&lt; T &gt;::update_value </td>
  176. <td>(</td>
  177. <td class="paramname"></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </td>
  182. <td class="mlabels-right">
  183. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>Updates the internal value. </p>
  188. <p>This function should be overridden by any child class to do the actual work of updating value based on whatever rules the class chooses. Normally, this consists of geting the values from some associated <a class="el" href="classfilval_1_1Value.html" title="A generic value. ">Value</a> objects, doing some calculation on them, and storing the result in value. </p>
  189. <p>Implements <a class="el" href="classfilval_1_1DerivedValue.html#a74e04450a550454510329a9e6b941304">filval::DerivedValue&lt; T &gt;</a>.</p>
  190. </div>
  191. </div>
  192. <hr/>The documentation for this class was generated from the following file:<ul>
  193. <li>/home/caleb/Sources/TTTT/filval/<a class="el" href="value_8hpp_source.html">value.hpp</a></li>
  194. </ul>
  195. </div><!-- contents -->
  196. <!-- start footer part -->
  197. <hr class="footer"/><address class="footer"><small>
  198. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  199. <img class="footer" src="doxygen.png" alt="doxygen"/>
  200. </a> 1.8.12
  201. </small></address>
  202. </body>
  203. </html>