classfv_1_1Value.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  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: fv::Value&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="namespacefv.html">fv</a></li><li class="navelem"><a class="el" href="classfv_1_1Value.html">Value</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="classfv_1_1Value-members.html">List of all members</a> </div>
  67. <div class="headertitle">
  68. <div class="title">fv::Value&lt; T &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p>A generic value.
  72. <a href="classfv_1_1Value.html#details">More...</a></p>
  73. <p><code>#include &lt;<a class="el" href="value_8hpp_source.html">value.hpp</a>&gt;</code></p>
  74. <div class="dynheader">
  75. Inheritance diagram for fv::Value&lt; T &gt;:</div>
  76. <div class="dyncontent">
  77. <div class="center"><img src="classfv_1_1Value__inherit__graph.png" border="0" usemap="#fv_1_1Value_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
  78. <map name="fv_1_1Value_3_01T_01_4_inherit__map" id="fv_1_1Value_3_01T_01_4_inherit__map">
  79. <area shape="rect" id="node3" href="classfv_1_1DerivedValue.html" title="A generic, derived, value. " alt="" coords="191,155,358,181"/>
  80. <area shape="rect" id="node12" href="classfv_1_1ObservedValue.html" title="A generic, observed, value. " alt="" coords="383,155,561,181"/>
  81. <area shape="rect" id="node2" href="classfv_1_1GenValue.html" title="fv::GenValue" alt="" coords="321,5,425,32"/>
  82. <area shape="rect" id="node4" href="classfv_1_1BoundValue.html" title="A generic value owning only a function object. " alt="" coords="5,229,163,256"/>
  83. <area shape="rect" id="node5" href="classfv_1_1ConstantValue.html" title="A Value which always returns the same value, supplied in the constructor. " alt="" coords="187,229,362,256"/>
  84. <area shape="rect" id="node6" href="classfv_1_1Reduce.html" title="Reduce a Value of type vector&lt;T&gt; to just a T. " alt="" coords="386,229,513,256"/>
  85. <area shape="rect" id="node7" href="classfv_1_1ElementOf.html" title="Extract the element at a specific index from a vector. " alt="" coords="88,304,237,331"/>
  86. <area shape="rect" id="node8" href="classfv_1_1Max.html" title="Find and return the maximum value of a vector. " alt="" coords="261,304,368,331"/>
  87. <area shape="rect" id="node9" href="classfv_1_1Mean.html" title="Calculate the mean value of a vector. " alt="" coords="392,304,507,331"/>
  88. <area shape="rect" id="node10" href="classfv_1_1Min.html" title="Find and return the minimum value of a vector. " alt="" coords="531,304,634,331"/>
  89. <area shape="rect" id="node11" href="classfv_1_1Range.html" title="Calculate the range of the values in a vector. " alt="" coords="658,304,779,331"/>
  90. </map>
  91. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  92. <div class="dynheader">
  93. Collaboration diagram for fv::Value&lt; T &gt;:</div>
  94. <div class="dyncontent">
  95. <div class="center"><img src="classfv_1_1Value__coll__graph.png" border="0" usemap="#fv_1_1Value_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
  96. <map name="fv_1_1Value_3_01T_01_4_coll__map" id="fv_1_1Value_3_01T_01_4_coll__map">
  97. <area shape="rect" id="node2" href="classfv_1_1GenValue.html" title="fv::GenValue" alt="" coords="11,5,115,32"/>
  98. </map>
  99. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  100. <table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  102. Public Member Functions</h2></td></tr>
  103. <tr class="memitem:afded92c24f946c1551c1f1b005f31091"><td class="memItemLeft" align="right" valign="top"><a id="afded92c24f946c1551c1f1b005f31091"></a>
  104. &#160;</td><td class="memItemRight" valign="bottom"><b>Value</b> (const std::string &amp;<a class="el" href="classfv_1_1GenValue.html#a610f89ee441eaad4c9e78f74d6bde93b">name</a>, const std::string &amp;alias=&quot;&quot;)</td></tr>
  105. <tr class="separator:afded92c24f946c1551c1f1b005f31091"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a4cc70444ceaf5d7651922adf9b7beeff"><td class="memItemLeft" align="right" valign="top"><a id="a4cc70444ceaf5d7651922adf9b7beeff"></a>
  107. virtual T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfv_1_1Value.html#a4cc70444ceaf5d7651922adf9b7beeff">get_value</a> ()=0</td></tr>
  108. <tr class="memdesc:a4cc70444ceaf5d7651922adf9b7beeff"><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:a4cc70444ceaf5d7651922adf9b7beeff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="inherit_header pub_methods_classfv_1_1GenValue"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classfv_1_1GenValue')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classfv_1_1GenValue.html">fv::GenValue</a></td></tr>
  111. <tr class="memitem:a6a85db33e2414e7e77735a4706760300 inherit pub_methods_classfv_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a6a85db33e2414e7e77735a4706760300"></a>
  112. &#160;</td><td class="memItemRight" valign="bottom"><b>GenValue</b> (const std::string &amp;<a class="el" href="classfv_1_1GenValue.html#a610f89ee441eaad4c9e78f74d6bde93b">name</a>, const std::string &amp;alias)</td></tr>
  113. <tr class="separator:a6a85db33e2414e7e77735a4706760300 inherit pub_methods_classfv_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a56f7eab1a0043ea73ecf01ec11dafa5c inherit pub_methods_classfv_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a56f7eab1a0043ea73ecf01ec11dafa5c"></a>
  115. const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>get_name</b> ()</td></tr>
  116. <tr class="separator:a56f7eab1a0043ea73ecf01ec11dafa5c inherit pub_methods_classfv_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:aff8a4008b9d449fb05ddc825135ba8a2 inherit pub_methods_classfv_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="aff8a4008b9d449fb05ddc825135ba8a2"></a>
  118. void&#160;</td><td class="memItemRight" valign="bottom"><b>set_name</b> (const std::string &amp;new_name)</td></tr>
  119. <tr class="separator:aff8a4008b9d449fb05ddc825135ba8a2 inherit pub_methods_classfv_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table><table class="memberdecls">
  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  122. Additional Inherited Members</h2></td></tr>
  123. <tr class="inherit_header pub_static_methods_classfv_1_1GenValue"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classfv_1_1GenValue')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classfv_1_1GenValue.html">fv::GenValue</a></td></tr>
  124. <tr class="memitem:a804fa6719404472466896cc191a8123c inherit pub_static_methods_classfv_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a804fa6719404472466896cc191a8123c"></a>
  125. static void&#160;</td><td class="memItemRight" valign="bottom"><b>reset</b> ()</td></tr>
  126. <tr class="separator:a804fa6719404472466896cc191a8123c inherit pub_static_methods_classfv_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a26e4aaa4c26437925dbe895fbb558bc5 inherit pub_static_methods_classfv_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a26e4aaa4c26437925dbe895fbb558bc5"></a>
  128. static <a class="el" href="classfv_1_1GenValue.html">GenValue</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>get_value</b> (const std::string &amp;<a class="el" href="classfv_1_1GenValue.html#a610f89ee441eaad4c9e78f74d6bde93b">name</a>)</td></tr>
  129. <tr class="separator:a26e4aaa4c26437925dbe895fbb558bc5 inherit pub_static_methods_classfv_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a2d4be21b68793e1f02411fe1143396cf inherit pub_static_methods_classfv_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a2d4be21b68793e1f02411fe1143396cf"></a>
  131. static void&#160;</td><td class="memItemRight" valign="bottom"><b>alias</b> (const std::string &amp;<a class="el" href="classfv_1_1GenValue.html#a610f89ee441eaad4c9e78f74d6bde93b">name</a>, <a class="el" href="classfv_1_1GenValue.html">GenValue</a> *value)</td></tr>
  132. <tr class="separator:a2d4be21b68793e1f02411fe1143396cf inherit pub_static_methods_classfv_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a71d887498102aca1c896e956c50bc0fe inherit pub_static_methods_classfv_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a71d887498102aca1c896e956c50bc0fe"></a>
  134. static <a class="el" href="classfv_1_1GenValue.html">GenValue</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>alias</b> (const std::string &amp;<a class="el" href="classfv_1_1GenValue.html#a610f89ee441eaad4c9e78f74d6bde93b">name</a>)</td></tr>
  135. <tr class="separator:a71d887498102aca1c896e956c50bc0fe inherit pub_static_methods_classfv_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a66807a611d5f3e693f538e8430ae9585 inherit pub_static_methods_classfv_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a66807a611d5f3e693f538e8430ae9585"></a>
  137. static std::string&#160;</td><td class="memItemRight" valign="bottom"><b>summary</b> ()</td></tr>
  138. <tr class="separator:a66807a611d5f3e693f538e8430ae9585 inherit pub_static_methods_classfv_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="inherit_header pro_methods_classfv_1_1GenValue"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classfv_1_1GenValue')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classfv_1_1GenValue.html">fv::GenValue</a></td></tr>
  140. <tr class="memitem:a26160e53542b728f9e0c11495dce3c20 inherit pro_methods_classfv_1_1GenValue"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfv_1_1GenValue.html#a26160e53542b728f9e0c11495dce3c20">_reset</a> ()=0</td></tr>
  141. <tr class="memdesc:a26160e53542b728f9e0c11495dce3c20 inherit pro_methods_classfv_1_1GenValue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark the internal value as invalid. <a href="classfv_1_1GenValue.html#a26160e53542b728f9e0c11495dce3c20">More...</a><br /></td></tr>
  142. <tr class="separator:a26160e53542b728f9e0c11495dce3c20 inherit pro_methods_classfv_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="inherit_header pro_static_attribs_classfv_1_1GenValue"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_classfv_1_1GenValue')"><img src="closed.png" alt="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="classfv_1_1GenValue.html">fv::GenValue</a></td></tr>
  144. <tr class="memitem:abbb57abc392c44d1f7ad5e7e74a75297 inherit pro_static_attribs_classfv_1_1GenValue"><td class="memItemLeft" align="right" valign="top">static std::map&lt; const std::string, <a class="el" href="classfv_1_1GenValue.html">GenValue</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfv_1_1GenValue.html#abbb57abc392c44d1f7ad5e7e74a75297">values</a></td></tr>
  145. <tr class="memdesc:abbb57abc392c44d1f7ad5e7e74a75297 inherit pro_static_attribs_classfv_1_1GenValue"><td class="mdescLeft">&#160;</td><td class="mdescRight">A static mapping containing all created <a class="el" href="classfv_1_1Value.html" title="A generic value. ">Value</a> objects. <a href="classfv_1_1GenValue.html#abbb57abc392c44d1f7ad5e7e74a75297">More...</a><br /></td></tr>
  146. <tr class="separator:abbb57abc392c44d1f7ad5e7e74a75297 inherit pro_static_attribs_classfv_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:ab58b81925a05884bbebca0d870da80d0 inherit pro_static_attribs_classfv_1_1GenValue"><td class="memItemLeft" align="right" valign="top">static std::map&lt; const std::string, <a class="el" href="classfv_1_1GenValue.html">GenValue</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfv_1_1GenValue.html#ab58b81925a05884bbebca0d870da80d0">aliases</a></td></tr>
  148. <tr class="memdesc:ab58b81925a05884bbebca0d870da80d0 inherit pro_static_attribs_classfv_1_1GenValue"><td class="mdescLeft">&#160;</td><td class="mdescRight">Composite value names are typically nested. <a href="classfv_1_1GenValue.html#ab58b81925a05884bbebca0d870da80d0">More...</a><br /></td></tr>
  149. <tr class="separator:ab58b81925a05884bbebca0d870da80d0 inherit pro_static_attribs_classfv_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. </table>
  151. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  152. <div class="textblock"><h3>template&lt;typename T&gt;<br />
  153. class fv::Value&lt; T &gt;</h3>
  154. <p>A generic value. </p>
  155. <p>In order to facilitate run-time creation of analysis routines, it is necessary to have some ability to get and store <em>values</em>. Values can either be directly taken from some original data source (i.e. <a class="el" href="classfv_1_1ObservedValue.html" title="A generic, observed, value. ">ObservedValue</a>), or they can be a function of some other set of values (i.e. <a class="el" href="classfv_1_1DerivedValue.html" title="A generic, derived, value. ">DerivedValue</a>). They template class T of Value&lt;T&gt; is the type of thing that is returned upon calling <a class="el" href="classfv_1_1Value.html#a4cc70444ceaf5d7651922adf9b7beeff" title="Calculate, if necessary, and return the value held by this object. ">get_value()</a>. </p>
  156. </div><hr/>The documentation for this class was generated from the following file:<ul>
  157. <li>/home/caleb/Sources/TTTT/filval/<a class="el" href="value_8hpp_source.html">value.hpp</a></li>
  158. </ul>
  159. </div><!-- contents -->
  160. <!-- start footer part -->
  161. <hr class="footer"/><address class="footer"><small>
  162. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  163. <img class="footer" src="doxygen.png" alt="doxygen"/>
  164. </a> 1.8.12
  165. </small></address>
  166. </body>
  167. </html>