caleb
/
TTTT


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TTTT Analysis: filval::ObservedValue&lt; T &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">TTTT Analysis
   &#160;<span id="projectnumber">0.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacefilval.html">filval</a></li><li class="navelem"><a class="el" href="classfilval_1_1ObservedValue.html">ObservedValue</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classfilval_1_1ObservedValue-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">filval::ObservedValue&lt; T &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A generic, observed, value.  
 <a href="classfilval_1_1ObservedValue.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="value_8hpp_source.html">value.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for filval::ObservedValue&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classfilval_1_1ObservedValue__inherit__graph.png" border="0" usemap="#filval_1_1ObservedValue_3_01T_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="filval_1_1ObservedValue_3_01T_01_4_inherit__map" id="filval_1_1ObservedValue_3_01T_01_4_inherit__map">
<area shape="rect" id="node2" href="classfilval_1_1Value.html" title="A generic value. " alt="" coords="37,80,173,107"/>
<area shape="rect" id="node3" href="classfilval_1_1GenValue.html" title="A type&#45;agnostic value. " alt="" coords="43,5,167,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for filval::ObservedValue&lt; T &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classfilval_1_1ObservedValue__coll__graph.png" border="0" usemap="#filval_1_1ObservedValue_3_01T_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="filval_1_1ObservedValue_3_01T_01_4_coll__map" id="filval_1_1ObservedValue_3_01T_01_4_coll__map">
<area shape="rect" id="node2" href="classfilval_1_1Value.html" title="A generic value. " alt="" coords="37,80,173,107"/>
<area shape="rect" id="node3" href="classfilval_1_1GenValue.html" title="A type&#45;agnostic value. " alt="" coords="43,5,167,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0bce29e7d100187548c7ba3ef80f9c89"><td class="memItemLeft" align="right" valign="top"><a id="a0bce29e7d100187548c7ba3ef80f9c89"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ObservedValue</b> (const std::string &amp;<a class="el" href="classfilval_1_1GenValue.html#a007e38c03ee041c2a657afa3d6e91ab1">name</a>, T *val_ref)</td></tr>
<tr class="separator:a0bce29e7d100187548c7ba3ef80f9c89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af38ebd68326b8282a9f769f89021e46a"><td class="memItemLeft" align="right" valign="top"><a id="af38ebd68326b8282a9f769f89021e46a"></a>
T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfilval_1_1ObservedValue.html#af38ebd68326b8282a9f769f89021e46a">get_value</a> ()</td></tr>
<tr class="memdesc:af38ebd68326b8282a9f769f89021e46a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate, if necessary, and return the value held by this object. <br /></td></tr>
<tr class="separator:af38ebd68326b8282a9f769f89021e46a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memitem:acf84b59c04243cffee5c0f361465c83c inherit pub_methods_classfilval_1_1Value"><td class="memItemLeft" align="right" valign="top"><a id="acf84b59c04243cffee5c0f361465c83c"></a>
&#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>
<tr class="separator:acf84b59c04243cffee5c0f361465c83c inherit pub_methods_classfilval_1_1Value"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memitem:a8e966db95add619c6d85defcb4c866d7 inherit pub_methods_classfilval_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a8e966db95add619c6d85defcb4c866d7"></a>
&#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>
<tr class="separator:a8e966db95add619c6d85defcb4c866d7 inherit pub_methods_classfilval_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38cdc9588f97cb1c5f4ae1c2f8fa326a inherit pub_methods_classfilval_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a38cdc9588f97cb1c5f4ae1c2f8fa326a"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>get_name</b> ()</td></tr>
<tr class="separator:a38cdc9588f97cb1c5f4ae1c2f8fa326a inherit pub_methods_classfilval_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a68c4fc1eb89682c7b16d2d46874f5421"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfilval_1_1ObservedValue.html#a68c4fc1eb89682c7b16d2d46874f5421">_reset</a> ()</td></tr>
<tr class="memdesc:a68c4fc1eb89682c7b16d2d46874f5421"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mark the internal value as invalid.  <a href="#a68c4fc1eb89682c7b16d2d46874f5421">More...</a><br /></td></tr>
<tr class="separator:a68c4fc1eb89682c7b16d2d46874f5421"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ad943ba7c4ff0d7d601d961c563f01826"><td class="memItemLeft" align="right" valign="top"><a id="ad943ba7c4ff0d7d601d961c563f01826"></a>
T *&#160;</td><td class="memItemRight" valign="bottom"><b>val_ref</b></td></tr>
<tr class="separator:ad943ba7c4ff0d7d601d961c563f01826"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<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>
<tr class="memitem:a6a12aa2c8b6a99573e0fa996f37dd13a inherit pub_static_methods_classfilval_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a6a12aa2c8b6a99573e0fa996f37dd13a"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>reset</b> ()</td></tr>
<tr class="separator:a6a12aa2c8b6a99573e0fa996f37dd13a inherit pub_static_methods_classfilval_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14659bc5b321f5b914cd911b229f40ef inherit pub_static_methods_classfilval_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a14659bc5b321f5b914cd911b229f40ef"></a>
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>
<tr class="separator:a14659bc5b321f5b914cd911b229f40ef inherit pub_static_methods_classfilval_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fc8de3214f885848f2f5761dc0800b7 inherit pub_static_methods_classfilval_1_1GenValue"><td class="memItemLeft" align="right" valign="top"><a id="a0fc8de3214f885848f2f5761dc0800b7"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>summary</b> ()</td></tr>
<tr class="separator:a0fc8de3214f885848f2f5761dc0800b7 inherit pub_static_methods_classfilval_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<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>
<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>
<tr class="separator:aa94f38a80f5a127bf3df33ad53198e57 inherit pro_static_attribs_classfilval_1_1GenValue"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br />
class filval::ObservedValue&lt; T &gt;</h3>

<p>A generic, observed, value. </p>
<p>An <a class="el" href="classfilval_1_1ObservedValue.html" title="A generic, observed, value. ">ObservedValue</a> is the interface to your dataset. Upon creation, an <a class="el" href="classfilval_1_1ObservedValue.html" title="A generic, observed, value. ">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 <a class="el" href="classfilval_1_1DataSet.html">DataSet</a> implementation is being used. This object then will read that data and return it when requested. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a68c4fc1eb89682c7b16d2d46874f5421"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68c4fc1eb89682c7b16d2d46874f5421">&sect;&nbsp;</a></span>_reset()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classfilval_1_1ObservedValue.html">filval::ObservedValue</a>&lt; T &gt;::_reset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Mark the internal value as invalid. </p>
<p>This is needed for <a class="el" href="classfilval_1_1DerivedValue.html" title="A generic, derived, value. ">DerivedValue</a> to force a recalculation of the internal value when a new observation is loaded into memory. It is called automatically for all <a class="el" href="classfilval_1_1GenValue.html" title="A type-agnostic value. ">GenValue</a> objects when reset is called. </p>

<p>Implements <a class="el" href="classfilval_1_1GenValue.html#ae9d5bd9fde2d04f6cd05d5b901a8c78a">filval::GenValue</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/caleb/Sources/TTTT/filval/<a class="el" href="value_8hpp_source.html">value.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>