root/doc/html/classbdm_1_1logger.html @ 353

Revision 353, 12.4 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="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
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="annotated.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="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</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" -->Class for storing results (and semi-results) of an experiment. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classbdm_1_1logger-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f9c2fe7db5ddbda0098a4a5bd2c29fbf"></a><!-- doxytag: member="bdm::logger::logger" ref="f9c2fe7db5ddbda0098a4a5bd2c29fbf" args="()" -->
82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#f9c2fe7db5ddbda0098a4a5bd2c29fbf">logger</a> ()</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
85<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#47aa3b098a81d02a8ffaea2c9fa09ac7">add</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv, string prefix=&quot;&quot;)</td></tr>
86
87<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" -->
88virtual 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>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br></td></tr>
91<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3f1697214a9281b80f0914f08d4246c"></a><!-- doxytag: member="bdm::logger::logit" ref="a3f1697214a9281b80f0914f08d4246c" args="(int id, const double &amp;d)=0" -->
92virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#a3f1697214a9281b80f0914f08d4246c">logit</a> (int id, const double &amp;d)=0</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this double <br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f31c03578a7b9b30d8b1f8c338a37e8"></a><!-- doxytag: member="bdm::logger::step" ref="4f31c03578a7b9b30d8b1f8c338a37e8" args="()=0" -->
96virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#4f31c03578a7b9b30d8b1f8c338a37e8">step</a> ()=0</td></tr>
97
98<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shifts storage position for another time step. <br></td></tr>
99<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0e3fc7d13e23a8f71fc7c8a5ea68559d"></a><!-- doxytag: member="bdm::logger::finalize" ref="0e3fc7d13e23a8f71fc7c8a5ea68559d" args="()" -->
100virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#0e3fc7d13e23a8f71fc7c8a5ea68559d">finalize</a> ()</td></tr>
101
102<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize storing information. <br></td></tr>
103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd6291a73491f755dc7bc88d022eb2fc"></a><!-- doxytag: member="bdm::logger::init" ref="cd6291a73491f755dc7bc88d022eb2fc" args="()" -->
104virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#cd6291a73491f755dc7bc88d022eb2fc">init</a> ()</td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the storage. <br></td></tr>
107<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d95e9de79ca1d52b06f1b8f80660f09"></a><!-- doxytag: member="bdm::logger::ToString" ref="3d95e9de79ca1d52b06f1b8f80660f09" args="()" -->
108virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#3d95e9de79ca1d52b06f1b8f80660f09">ToString</a> ()</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
111<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::logger::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" -->
112virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d4602efd3ad9fb9e4532426e4f488df8">from_setting</a> (const Setting &amp;root)</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr>
115<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a80210bbe266bf26f100f342460a313f"></a><!-- doxytag: member="bdm::logger::to_setting" ref="a80210bbe266bf26f100f342460a313f" args="(Setting &amp;root)" -->
116virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#a80210bbe266bf26f100f342460a313f">to_setting</a> (Setting &amp;root)</td></tr>
117
118<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
119<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::logger::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" -->
121<a class="el" href="classitpp_1_1Array.html">Array</a>&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>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::logger::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" -->
125<a class="el" href="classitpp_1_1Array.html">Array</a>&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr>
128</table>
129<hr><a name="_details"></a><h2>Detailed Description</h2>
130Class for storing results (and semi-results) of an experiment.
131<p>
132This 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. <hr><h2>Member Function Documentation</h2>
133<a class="anchor" name="47aa3b098a81d02a8ffaea2c9fa09ac7"></a><!-- doxytag: member="bdm::logger::add" ref="47aa3b098a81d02a8ffaea2c9fa09ac7" args="(const RV &amp;rv, string prefix=&quot;&quot;)" -->
134<div class="memitem">
135<div class="memproto">
136      <table class="memname">
137        <tr>
138          <td class="memname">virtual int bdm::logger::add           </td>
139          <td>(</td>
140          <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
141          <td class="paramname"> <em>rv</em>, </td>
142        </tr>
143        <tr>
144          <td class="paramkey"></td>
145          <td></td>
146          <td class="paramtype">string&nbsp;</td>
147          <td class="paramname"> <em>prefix</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td>
148        </tr>
149        <tr>
150          <td></td>
151          <td>)</td>
152          <td></td><td></td><td><code> [inline, virtual]</code></td>
153        </tr>
154      </table>
155</div>
156<div class="memdoc">
157
158<p>
159returns 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>.
160<p>References <a class="el" href="libBM_8h-source.html#l00145">bdm::RV::_dsize()</a>, <a class="el" href="libBM_8h-source.html#l00515">entries</a>, <a class="el" href="array_8h-source.html#l00157">itpp::Array&lt; T &gt;::length()</a>, <a class="el" href="libBM_8h-source.html#l00517">names</a>, and <a class="el" href="array_8h-source.html#l00161">itpp::Array&lt; T &gt;::set_length()</a>.</p>
161
162<p>Referenced by <a class="el" href="pmsmDS_8h-source.html#l00201">pmsmCRBMz::log_add()</a>, <a class="el" href="pmsmDS_8h-source.html#l00169">pmsmCRB::log_add()</a>, <a class="el" href="pmsmDS_8h-source.html#l00093">pmsmDS::log_add()</a>, <a class="el" href="libDS_8h-source.html#l00181">bdm::ArxDS::log_add()</a>, <a class="el" href="libBM_8h-source.html#l00741">bdm::BM::log_add()</a>, and <a class="el" href="libBM_8h-source.html#l00612">bdm::DS::log_add()</a>.</p>
163
164</div>
165</div><p>
166<hr>The documentation for this class was generated from the following file:<ul>
167<li><a class="el" href="libBM_8h-source.html">libBM.h</a></ul>
168</div>
169<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:18 2009 for mixpp by&nbsp;
170<a href="http://www.doxygen.org/index.html">
171<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
172</body>
173</html>
Note: See TracBrowser for help on using the browser.