root/doc/html/classbdm_1_1logger.html @ 275

Revision 275, 9.9 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: bdm::logger Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.6 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
62      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1logger.html">logger</a>
68  </div>
69</div>
70<div class="contents">
71<h1>bdm::logger Class Reference</h1><!-- doxytag: class="bdm::logger" --><!-- doxytag: inherits="bdm::bdmroot" --><code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
72<p>
73<div class="dynheader">
74Inheritance diagram for bdm::logger:</div>
75<div class="dynsection">
76
77<p><center><img src="classbdm_1_1logger.png" usemap="#bdm::logger_map" border="0" alt=""></center>
78<map name="bdm::logger_map">
79<area href="classbdm_1_1bdmroot.html" alt="bdm::bdmroot" shape="rect" coords="0,0,90,24">
80<area href="classbdm_1_1memlog.html" alt="bdm::memlog" shape="rect" coords="0,112,90,136">
81<area href="classbdm_1_1dirfilelog.html" alt="bdm::dirfilelog" shape="rect" coords="0,168,90,192">
82</map>
83</div>
84
85<p>
86<a href="classbdm_1_1logger-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
87Class for storing results (and semi-results) of an experiment.
88<p>
89This class abstracts logging of results from implementation. This class replaces direct logging of results (e.g. to files or to global variables) by calling methods of a <a class="el" href="classbdm_1_1logger.html" title="Class for storing results (and semi-results) of an experiment.">logger</a>. Specializations of this abstract class for specific storage method are designed. <table border="0" cellpadding="0" cellspacing="0">
90<tr><td></td></tr>
91<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f9c2fe7db5ddbda0098a4a5bd2c29fbf"></a><!-- doxytag: member="bdm::logger::logger" ref="f9c2fe7db5ddbda0098a4a5bd2c29fbf" args="()" -->
93&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#f9c2fe7db5ddbda0098a4a5bd2c29fbf">logger</a> ()</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
96<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#cfb4807e20b3d00f3d33e55ada528dc1">add</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv, string name=&quot;&quot;)</td></tr>
97
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="397c014b0aaf3581516e2a105d26a5c9"></a><!-- doxytag: member="bdm::logger::logit" ref="397c014b0aaf3581516e2a105d26a5c9" args="(int id, const vec &amp;v)=0" -->
99virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#397c014b0aaf3581516e2a105d26a5c9">logit</a> (int id, const vec &amp;v)=0</td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f31c03578a7b9b30d8b1f8c338a37e8"></a><!-- doxytag: member="bdm::logger::step" ref="4f31c03578a7b9b30d8b1f8c338a37e8" args="()=0" -->
103virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#4f31c03578a7b9b30d8b1f8c338a37e8">step</a> ()=0</td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shifts storage position for another time step. <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0e3fc7d13e23a8f71fc7c8a5ea68559d"></a><!-- doxytag: member="bdm::logger::finalize" ref="0e3fc7d13e23a8f71fc7c8a5ea68559d" args="()" -->
107virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#0e3fc7d13e23a8f71fc7c8a5ea68559d">finalize</a> ()</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize storing information. <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd6291a73491f755dc7bc88d022eb2fc"></a><!-- doxytag: member="bdm::logger::init" ref="cd6291a73491f755dc7bc88d022eb2fc" args="()" -->
111virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#cd6291a73491f755dc7bc88d022eb2fc">init</a> ()</td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the storage. <br></td></tr>
114<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::logger::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" -->
116Array&lt; <a class="el" href="classbdm_1_1RV.html">RV</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#c54566a4554089443a20b2a49ed1a61f">entries</a></td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr>
119<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::logger::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" -->
120Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr>
121
122<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr>
123</table>
124<hr><h2>Member Function Documentation</h2>
125<a class="anchor" name="cfb4807e20b3d00f3d33e55ada528dc1"></a><!-- doxytag: member="bdm::logger::add" ref="cfb4807e20b3d00f3d33e55ada528dc1" args="(const RV &amp;rv, string name=&quot;&quot;)" -->
126<div class="memitem">
127<div class="memproto">
128      <table class="memname">
129        <tr>
130          <td class="memname">virtual int bdm::logger::add           </td>
131          <td>(</td>
132          <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
133          <td class="paramname"> <em>rv</em>, </td>
134        </tr>
135        <tr>
136          <td class="paramkey"></td>
137          <td></td>
138          <td class="paramtype">string&nbsp;</td>
139          <td class="paramname"> <em>name</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td>
140        </tr>
141        <tr>
142          <td></td>
143          <td>)</td>
144          <td></td><td></td><td><code> [inline, virtual]</code></td>
145        </tr>
146      </table>
147</div>
148<div class="memdoc">
149
150<p>
151returns an identifier which will be later needed for calling the <code><a class="el" href="classbdm_1_1logger.html#397c014b0aaf3581516e2a105d26a5c9" title="log this vector">logit()</a></code> function For empty <a class="el" href="classbdm_1_1RV.html" title="Class representing variables, most often random variables.">RV</a> it returns -1, this entry will be ignored by <code><a class="el" href="classbdm_1_1logger.html#397c014b0aaf3581516e2a105d26a5c9" title="log this vector">logit()</a></code>.
152<p>References <a class="el" href="libBM_8h-source.html#l00476">entries</a>, and <a class="el" href="libBM_8h-source.html#l00478">names</a>.</p>
153
154<p>Referenced by <a class="el" href="libDS_8h-source.html#l00121">bdm::ArxDS::log_add()</a>, and <a class="el" href="libBM_8h-source.html#l00570">bdm::DS::log_add()</a>.</p>
155
156</div>
157</div><p>
158<hr>The documentation for this class was generated from the following file:<ul>
159<li><a class="el" href="libBM_8h-source.html">libBM.h</a></ul>
160</div>
161<hr size="1"><address style="text-align: right;"><small>Generated on Mon Feb 16 10:06:40 2009 for mixpp by&nbsp;
162<a href="http://www.doxygen.org/index.html">
163<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
164</body>
165</html>
Note: See TracBrowser for help on using the browser.