classfv_1_1BoundValue.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  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.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TTTT Analysis: fv::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.13 -->
  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="namespacefv.html">fv</a></li><li class="navelem"><a class="el" href="classfv_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="classfv_1_1BoundValue-members.html">List of all members</a> </div>
  69. <div class="headertitle">
  70. <div class="title">fv::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="classfv_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 fv::BoundValue&lt; T &gt;:</div>
  78. <div class="dyncontent">
  79. <div class="center"><img src="classfv_1_1BoundValue__inherit__graph.png" border="0" usemap="#fv_1_1BoundValue_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
  80. <map name="fv_1_1BoundValue_3_01T_01_4_inherit__map" id="fv_1_1BoundValue_3_01T_01_4_inherit__map">
  81. <area shape="rect" id="node2" href="classfv_1_1DerivedValue.html" title="A Value derived from some other Values, not directly from the dataset. " alt="" coords="5,80,172,107"/>
  82. <area shape="rect" id="node3" href="classfv_1_1Value.html" title="A generic value. " alt="" coords="31,5,147,32"/>
  83. </map>
  84. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  85. <div class="dynheader">
  86. Collaboration diagram for fv::BoundValue&lt; T &gt;:</div>
  87. <div class="dyncontent">
  88. <div class="center"><img src="classfv_1_1BoundValue__coll__graph.png" border="0" usemap="#fv_1_1BoundValue_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
  89. <map name="fv_1_1BoundValue_3_01T_01_4_coll__map" id="fv_1_1BoundValue_3_01T_01_4_coll__map">
  90. <area shape="rect" id="node2" href="classfv_1_1DerivedValue.html" title="A Value derived from some other Values, not directly from the dataset. " alt="" coords="5,80,172,107"/>
  91. <area shape="rect" id="node3" href="classfv_1_1Value.html" title="A generic value. " alt="" coords="31,5,147,32"/>
  92. </map>
  93. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  94. <table class="memberdecls">
  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  96. Public Member Functions</h2></td></tr>
  97. <tr class="memitem:aa5157e0e9ba817cdeaef72f643ba8a79"><td class="memItemLeft" align="right" valign="top"><a id="aa5157e0e9ba817cdeaef72f643ba8a79"></a>
  98. &#160;</td><td class="memItemRight" valign="bottom"><b>BoundValue</b> (Function&lt; T()&gt; &amp;f, const std::string alias=&quot;&quot;)</td></tr>
  99. <tr class="separator:aa5157e0e9ba817cdeaef72f643ba8a79"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="inherit_header pub_methods_classfv_1_1DerivedValue"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classfv_1_1DerivedValue')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classfv_1_1DerivedValue.html">fv::DerivedValue&lt; T &gt;</a></td></tr>
  101. <tr class="memitem:a00219a17112600afdc060d67d6f95b21 inherit pub_methods_classfv_1_1DerivedValue"><td class="memItemLeft" align="right" valign="top"><a id="a00219a17112600afdc060d67d6f95b21"></a>
  102. &#160;</td><td class="memItemRight" valign="bottom"><b>DerivedValue</b> (const std::string &amp;name, const std::string &amp;alias=&quot;&quot;)</td></tr>
  103. <tr class="separator:a00219a17112600afdc060d67d6f95b21 inherit pub_methods_classfv_1_1DerivedValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a39970158aa8f6eb062a28037df6e2128 inherit pub_methods_classfv_1_1DerivedValue"><td class="memItemLeft" align="right" valign="top"><a id="a39970158aa8f6eb062a28037df6e2128"></a>
  105. T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfv_1_1DerivedValue.html#a39970158aa8f6eb062a28037df6e2128">get_value</a> ()</td></tr>
  106. <tr class="memdesc:a39970158aa8f6eb062a28037df6e2128 inherit pub_methods_classfv_1_1DerivedValue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate, if necessary, and return the value held by this object. <br /></td></tr>
  107. <tr class="separator:a39970158aa8f6eb062a28037df6e2128 inherit pub_methods_classfv_1_1DerivedValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="inherit_header pub_methods_classfv_1_1Value"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classfv_1_1Value')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classfv_1_1Value.html">fv::Value&lt; T &gt;</a></td></tr>
  109. <tr class="memitem:afded92c24f946c1551c1f1b005f31091 inherit pub_methods_classfv_1_1Value"><td class="memItemLeft" align="right" valign="top"><a id="afded92c24f946c1551c1f1b005f31091"></a>
  110. &#160;</td><td class="memItemRight" valign="bottom"><b>Value</b> (const std::string &amp;name, const std::string &amp;alias=&quot;&quot;)</td></tr>
  111. <tr class="separator:afded92c24f946c1551c1f1b005f31091 inherit pub_methods_classfv_1_1Value"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. </table><table class="memberdecls">
  113. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  114. Protected Member Functions</h2></td></tr>
  115. <tr class="memitem:a51ba914f1eac694af4264d62785282a1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfv_1_1BoundValue.html#a51ba914f1eac694af4264d62785282a1">update_value</a> ()</td></tr>
  116. <tr class="memdesc:a51ba914f1eac694af4264d62785282a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the internal value. <a href="#a51ba914f1eac694af4264d62785282a1">More...</a><br /></td></tr>
  117. <tr class="separator:a51ba914f1eac694af4264d62785282a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. </table><table class="memberdecls">
  119. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  120. Protected Attributes</h2></td></tr>
  121. <tr class="memitem:a09946c7cd867603db1b66d64a6d43e69"><td class="memItemLeft" align="right" valign="top"><a id="a09946c7cd867603db1b66d64a6d43e69"></a>
  122. Function&lt; T()&gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>f</b></td></tr>
  123. <tr class="separator:a09946c7cd867603db1b66d64a6d43e69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="inherit_header pro_attribs_classfv_1_1DerivedValue"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classfv_1_1DerivedValue')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classfv_1_1DerivedValue.html">fv::DerivedValue&lt; T &gt;</a></td></tr>
  125. <tr class="memitem:aeb7ff5d17ad44b2040fc9930bbcc2c7a inherit pro_attribs_classfv_1_1DerivedValue"><td class="memItemLeft" align="right" valign="top"><a id="aeb7ff5d17ad44b2040fc9930bbcc2c7a"></a>
  126. T&#160;</td><td class="memItemRight" valign="bottom"><b>value</b></td></tr>
  127. <tr class="separator:aeb7ff5d17ad44b2040fc9930bbcc2c7a inherit pro_attribs_classfv_1_1DerivedValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:aafa55adbb38dc7fe210ea15e920515dc inherit pro_attribs_classfv_1_1DerivedValue"><td class="memItemLeft" align="right" valign="top"><a id="aafa55adbb38dc7fe210ea15e920515dc"></a>
  129. bool&#160;</td><td class="memItemRight" valign="bottom"><b>value_valid</b></td></tr>
  130. <tr class="separator:aafa55adbb38dc7fe210ea15e920515dc inherit pro_attribs_classfv_1_1DerivedValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table>
  132. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  133. <div class="textblock"><h3>template&lt;typename T&gt;<br />
  134. class fv::BoundValue&lt; T &gt;</h3>
  135. <p>A generic value owning only a function object. </p>
  136. <p>All necessary values upon which this value depends must be bound to the function object. </p>
  137. </div><h2 class="groupheader">Member Function Documentation</h2>
  138. <a id="a51ba914f1eac694af4264d62785282a1"></a>
  139. <h2 class="memtitle"><span class="permalink"><a href="#a51ba914f1eac694af4264d62785282a1">&#9670;&nbsp;</a></span>update_value()</h2>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <div class="memtemplate">
  143. template&lt;typename T &gt; </div>
  144. <table class="mlabels">
  145. <tr>
  146. <td class="mlabels-left">
  147. <table class="memname">
  148. <tr>
  149. <td class="memname">void <a class="el" href="classfv_1_1BoundValue.html">fv::BoundValue</a>&lt; T &gt;::update_value </td>
  150. <td>(</td>
  151. <td class="paramname"></td><td>)</td>
  152. <td></td>
  153. </tr>
  154. </table>
  155. </td>
  156. <td class="mlabels-right">
  157. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>Updates the internal value. </p>
  162. <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="classfv_1_1Value.html" title="A generic value. ">Value</a> objects, doing some calculation on them, and storing the result in value. </p>
  163. <p>Implements <a class="el" href="classfv_1_1DerivedValue.html#ae59e80a98eb74b95d8961bfe12ee5ec2">fv::DerivedValue&lt; T &gt;</a>.</p>
  164. </div>
  165. </div>
  166. <hr/>The documentation for this class was generated from the following file:<ul>
  167. <li>/home/caleb/Sources/TTTT/filval/<a class="el" href="value_8hpp_source.html">value.hpp</a></li>
  168. </ul>
  169. </div><!-- contents -->
  170. <!-- start footer part -->
  171. <hr class="footer"/><address class="footer"><small>
  172. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  173. <img class="footer" src="doxygen.png" alt="doxygen"/>
  174. </a> 1.8.13
  175. </small></address>
  176. </body>
  177. </html>