classfv_1_1ObservedValue.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  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::ObservedValue&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_1ObservedValue.html">ObservedValue</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="#pub-static-methods">Static Public Member Functions</a> &#124;
  67. <a href="#pri-attribs">Private Attributes</a> &#124;
  68. <a href="classfv_1_1ObservedValue-members.html">List of all members</a> </div>
  69. <div class="headertitle">
  70. <div class="title">fv::ObservedValue&lt; T &gt; Class Template Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>A value supplied by the dataset, not derived.
  74. <a href="classfv_1_1ObservedValue.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::ObservedValue&lt; T &gt;:</div>
  78. <div class="dyncontent">
  79. <div class="center"><img src="classfv_1_1ObservedValue__inherit__graph.png" border="0" usemap="#fv_1_1ObservedValue_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
  80. <map name="fv_1_1ObservedValue_3_01T_01_4_inherit__map" id="fv_1_1ObservedValue_3_01T_01_4_inherit__map">
  81. <area shape="rect" id="node2" href="classfv_1_1Value.html" title="A templated value. " alt="" coords="37,5,153,32"/>
  82. </map>
  83. <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  84. <div class="dynheader">
  85. Collaboration diagram for fv::ObservedValue&lt; T &gt;:</div>
  86. <div class="dyncontent">
  87. <div class="center"><img src="classfv_1_1ObservedValue__coll__graph.png" border="0" usemap="#fv_1_1ObservedValue_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
  88. <map name="fv_1_1ObservedValue_3_01T_01_4_coll__map" id="fv_1_1ObservedValue_3_01T_01_4_coll__map">
  89. <area shape="rect" id="node2" href="classfv_1_1Value.html" title="A templated value. " alt="" coords="37,5,153,32"/>
  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:a4530da20550883f9e956403cb1cfced4"><td class="memItemLeft" align="right" valign="top"><a id="a4530da20550883f9e956403cb1cfced4"></a>
  96. &#160;</td><td class="memItemRight" valign="bottom"><b>ObservedValue</b> (const std::string &amp;name, T *val_ref, const std::string &amp;alias=&quot;&quot;)</td></tr>
  97. <tr class="separator:a4530da20550883f9e956403cb1cfced4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a4f2d7034cdefb68fec70dd6f58b2e5bc"><td class="memItemLeft" align="right" valign="top"><a id="a4f2d7034cdefb68fec70dd6f58b2e5bc"></a>
  99. void&#160;</td><td class="memItemRight" valign="bottom"><b>log</b> ()</td></tr>
  100. <tr class="separator:a4f2d7034cdefb68fec70dd6f58b2e5bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a10419313294471ba9da25e55d23956ba"><td class="memItemLeft" align="right" valign="top"><a id="a10419313294471ba9da25e55d23956ba"></a>
  102. T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfv_1_1ObservedValue.html#a10419313294471ba9da25e55d23956ba">get_value</a> ()</td></tr>
  103. <tr class="memdesc:a10419313294471ba9da25e55d23956ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate, if necessary, and return the value held by this object. <br /></td></tr>
  104. <tr class="separator:a10419313294471ba9da25e55d23956ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <tr class="memitem:afded92c24f946c1551c1f1b005f31091 inherit pub_methods_classfv_1_1Value"><td class="memItemLeft" align="right" valign="top"><a id="afded92c24f946c1551c1f1b005f31091"></a>
  107. &#160;</td><td class="memItemRight" valign="bottom"><b>Value</b> (const std::string &amp;name, const std::string &amp;alias=&quot;&quot;)</td></tr>
  108. <tr class="separator:afded92c24f946c1551c1f1b005f31091 inherit pub_methods_classfv_1_1Value"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a477ab6275568b0c5afbcf92901cc3a6e inherit pub_methods_classfv_1_1Value"><td class="memItemLeft" align="right" valign="top"><a id="a477ab6275568b0c5afbcf92901cc3a6e"></a>
  110. 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>
  111. <tr class="separator:a477ab6275568b0c5afbcf92901cc3a6e inherit pub_methods_classfv_1_1Value"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a8a3517fdba15dcb2c141dbd58fc232b1 inherit pub_methods_classfv_1_1Value"><td class="memItemLeft" align="right" valign="top"><a id="a8a3517fdba15dcb2c141dbd58fc232b1"></a>
  113. void&#160;</td><td class="memItemRight" valign="bottom"><b>disable_logging</b> ()</td></tr>
  114. <tr class="separator:a8a3517fdba15dcb2c141dbd58fc232b1 inherit pub_methods_classfv_1_1Value"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. </table><table class="memberdecls">
  116. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  117. Static Public Member Functions</h2></td></tr>
  118. <tr class="memitem:a70fa3d061e587f31437aeee3a417c93c"><td class="memItemLeft" align="right" valign="top"><a id="a70fa3d061e587f31437aeee3a417c93c"></a>
  119. static std::string&#160;</td><td class="memItemRight" valign="bottom"><b>fmt_name</b> (const std::string &amp;name)</td></tr>
  120. <tr class="separator:a70fa3d061e587f31437aeee3a417c93c"><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="pri-attribs"></a>
  123. Private Attributes</h2></td></tr>
  124. <tr class="memitem:a18aeb656fc14e2161c7b7710ab944829"><td class="memItemLeft" align="right" valign="top"><a id="a18aeb656fc14e2161c7b7710ab944829"></a>
  125. T *&#160;</td><td class="memItemRight" valign="bottom"><b>val_ref</b></td></tr>
  126. <tr class="separator:a18aeb656fc14e2161c7b7710ab944829"><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="inherited"></a>
  129. Additional Inherited Members</h2></td></tr>
  130. <tr class="inherit_header pro_attribs_classfv_1_1Value"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classfv_1_1Value')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classfv_1_1Value.html">fv::Value&lt; T &gt;</a></td></tr>
  131. <tr class="memitem:aa0269699348665b8e978c1e848e74abe inherit pro_attribs_classfv_1_1Value"><td class="memItemLeft" align="right" valign="top"><a id="aa0269699348665b8e978c1e848e74abe"></a>
  132. std::function&lt; std::string(T)&gt;&#160;</td><td class="memItemRight" valign="bottom"><b>value_to_string</b></td></tr>
  133. <tr class="separator:aa0269699348665b8e978c1e848e74abe inherit pro_attribs_classfv_1_1Value"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table>
  135. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  136. <div class="textblock"><h3>template&lt;typename T&gt;<br />
  137. class fv::ObservedValue&lt; T &gt;</h3>
  138. <p>A value supplied by the dataset, not derived. </p>
  139. <p>An <a class="el" href="classfv_1_1ObservedValue.html" title="A value supplied by the dataset, not derived. ">ObservedValue</a> is the interface to your dataset. Upon creation, an <a class="el" href="classfv_1_1ObservedValue.html" title="A value supplied by the dataset, not derived. ">ObservedValue</a> is given a pointer to an object of type T. When an observation is loaded into memory, the value at the location referenced by that pointer must be updated with the associated data from that observation. This is the responsibility of whatever DataSet implementation is being used. This object then will read that data and return it when requested. </p>
  140. </div><hr/>The documentation for this class was generated from the following file:<ul>
  141. <li>/home/caleb/Sources/TTTT/filval/<a class="el" href="value_8hpp_source.html">value.hpp</a></li>
  142. </ul>
  143. </div><!-- contents -->
  144. <!-- start footer part -->
  145. <hr class="footer"/><address class="footer"><small>
  146. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  147. <img class="footer" src="doxygen.png" alt="doxygen"/>
  148. </a> 1.8.13
  149. </small></address>
  150. </body>
  151. </html>