classfv_1_1Value.html 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  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::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.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_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="#pro-attribs">Protected Attributes</a> &#124;
  67. <a href="classfv_1_1Value-members.html">List of all members</a> </div>
  68. <div class="headertitle">
  69. <div class="title">fv::Value&lt; T &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  70. </div><!--header-->
  71. <div class="contents">
  72. <p>A templated value.
  73. <a href="classfv_1_1Value.html#details">More...</a></p>
  74. <p><code>#include &lt;<a class="el" href="value_8hpp_source.html">value.hpp</a>&gt;</code></p>
  75. <div class="dynheader">
  76. Inheritance diagram for fv::Value&lt; T &gt;:</div>
  77. <div class="dyncontent">
  78. <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>
  79. <map name="fv_1_1Value_3_01T_01_4_inherit__map" id="fv_1_1Value_3_01T_01_4_inherit__map">
  80. <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="191,80,358,107"/>
  81. <area shape="rect" id="node11" href="classfv_1_1ObservedValue.html" title="A value supplied by the dataset, not derived. " alt="" coords="383,80,561,107"/>
  82. <area shape="rect" id="node3" href="classfv_1_1BoundValue.html" title="A generic value owning only a function object. " alt="" coords="5,155,163,181"/>
  83. <area shape="rect" id="node4" href="classfv_1_1ConstantValue.html" title="A Value which always returns the same value, supplied in the constructor. " alt="" coords="187,155,362,181"/>
  84. <area shape="rect" id="node5" href="classfv_1_1Reduce.html" title="Reduce a Value of type vector&lt;T&gt; to just a T. " alt="" coords="386,155,513,181"/>
  85. <area shape="rect" id="node6" href="classfv_1_1ElementOf.html" title="Extract the element at a specific index from a vector. " alt="" coords="88,229,237,256"/>
  86. <area shape="rect" id="node7" href="classfv_1_1Max.html" title="Find and return the maximum value of a vector. " alt="" coords="261,229,368,256"/>
  87. <area shape="rect" id="node8" href="classfv_1_1Mean.html" title="Calculate the mean value of a vector. " alt="" coords="392,229,507,256"/>
  88. <area shape="rect" id="node9" href="classfv_1_1Min.html" title="Find and return the minimum value of a vector. " alt="" coords="531,229,634,256"/>
  89. <area shape="rect" id="node10" href="classfv_1_1Range.html" title="Calculate the range of the values in a vector. " alt="" coords="658,229,779,256"/>
  90. </map>
  91. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  92. <table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  94. Public Member Functions</h2></td></tr>
  95. <tr class="memitem:afded92c24f946c1551c1f1b005f31091"><td class="memItemLeft" align="right" valign="top"><a id="afded92c24f946c1551c1f1b005f31091"></a>
  96. &#160;</td><td class="memItemRight" valign="bottom"><b>Value</b> (const std::string &amp;name, const std::string &amp;alias=&quot;&quot;)</td></tr>
  97. <tr class="separator:afded92c24f946c1551c1f1b005f31091"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a4cc70444ceaf5d7651922adf9b7beeff"><td class="memItemLeft" align="right" valign="top"><a id="a4cc70444ceaf5d7651922adf9b7beeff"></a>
  99. 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>
  100. <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>
  101. <tr class="separator:a4cc70444ceaf5d7651922adf9b7beeff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a477ab6275568b0c5afbcf92901cc3a6e"><td class="memItemLeft" align="right" valign="top"><a id="a477ab6275568b0c5afbcf92901cc3a6e"></a>
  103. void&#160;</td><td class="memItemRight" valign="bottom"><b>enable_logging</b> (const std::function&lt; std::string(T)&gt; &amp;value_to_string=[](T){return &quot;&quot;;})</td></tr>
  104. <tr class="separator:a477ab6275568b0c5afbcf92901cc3a6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a8a3517fdba15dcb2c141dbd58fc232b1"><td class="memItemLeft" align="right" valign="top"><a id="a8a3517fdba15dcb2c141dbd58fc232b1"></a>
  106. void&#160;</td><td class="memItemRight" valign="bottom"><b>disable_logging</b> ()</td></tr>
  107. <tr class="separator:a8a3517fdba15dcb2c141dbd58fc232b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. </table><table class="memberdecls">
  109. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  110. Protected Attributes</h2></td></tr>
  111. <tr class="memitem:aa0269699348665b8e978c1e848e74abe"><td class="memItemLeft" align="right" valign="top"><a id="aa0269699348665b8e978c1e848e74abe"></a>
  112. std::function&lt; std::string(T)&gt;&#160;</td><td class="memItemRight" valign="bottom"><b>value_to_string</b></td></tr>
  113. <tr class="separator:aa0269699348665b8e978c1e848e74abe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table>
  115. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  116. <div class="textblock"><h3>template&lt;typename T&gt;<br />
  117. class fv::Value&lt; T &gt;</h3>
  118. <p>A templated value. </p>
  119. <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 value supplied by the dataset, not derived. ">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 Value derived from some other Values, not directly from the dataset. ">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>
  120. <p class="definition">Definition at line <a class="el" href="value_8hpp_source.html#l00265">265</a> of file <a class="el" href="value_8hpp_source.html">value.hpp</a>.</p>
  121. </div><hr/>The documentation for this class was generated from the following file:<ul>
  122. <li>/home/caleb/Sources/TTTT/filval/<a class="el" href="value_8hpp_source.html">value.hpp</a></li>
  123. </ul>
  124. </div><!-- contents -->
  125. <!-- start footer part -->
  126. <hr class="footer"/><address class="footer"><small>
  127. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  128. <img class="footer" src="doxygen.png" alt="doxygen"/>
  129. </a> 1.8.13
  130. </small></address>
  131. </body>
  132. </html>