root/doc/html/classlogger.html @ 181

Revision 181, 7.0 kB (checked in by smidl, 16 years ago)

Regenerated 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: 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<div class="navigation" id="top">
9  <div class="tabs">
10    <ul>
11      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
14      <li><a href="files.html"><span>Files</span></a></li>
15    </ul>
16  </div>
17  <div class="tabs">
18    <ul>
19      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
20      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
21      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
22    </ul>
23  </div>
24</div>
25<div class="contents">
26<h1>logger Class Reference</h1><!-- doxytag: class="logger" -->Class for storing results (and semi-results) of an experiment. 
27<a href="#_details">More...</a>
28<p>
29<code>#include &lt;<a class="el" href="loggers_8h-source.html">loggers.h</a>&gt;</code>
30<p>
31<div class="dynheader">
32Inheritance diagram for logger:</div>
33<div class="dynsection">
34<p><center><img src="classlogger__inherit__graph.png" border="0" usemap="#logger__inherit__map" alt="Inheritance graph"></center>
35<map name="logger__inherit__map">
36<area shape="rect" href="classmemlog.html" title="Logging into matrices in data format in memory." alt="" coords="7,82,73,106"><area shape="rect" href="classdirfilelog.html" title="Logging into dirfile with buffer in memory." alt="" coords="5,156,75,180"></map>
37<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
38
39<p>
40<a href="classlogger-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
41<tr><td></td></tr>
42<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
43<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f753a510e00c892b38e95c2284363a6"></a><!-- doxytag: member="logger::logger" ref="4f753a510e00c892b38e95c2284363a6" args="()" -->
44&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#4f753a510e00c892b38e95c2284363a6">logger</a> ()</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfb250a559b71e07a1a6aa92f2185c1b"></a><!-- doxytag: member="logger::add" ref="cfb250a559b71e07a1a6aa92f2185c1b" args="(const RV &amp;rv, string name=&quot;&quot;)" -->
48virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#cfb250a559b71e07a1a6aa92f2185c1b">add</a> (const <a class="el" href="classRV.html">RV</a> &amp;rv, string name=&quot;&quot;)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">returns an identifier which will be later needed for calling the log() function <br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="efb5a59cb329f58810b09bd9cc270b78"></a><!-- doxytag: member="logger::logit" ref="efb5a59cb329f58810b09bd9cc270b78" args="(int id, vec v)=0" -->
52virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#efb5a59cb329f58810b09bd9cc270b78">logit</a> (int id, vec v)=0</td></tr>
53
54<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="709b3ebefa0da3ed371aa802b06512a2"></a><!-- doxytag: member="logger::step" ref="709b3ebefa0da3ed371aa802b06512a2" args="()=0" -->
56virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#709b3ebefa0da3ed371aa802b06512a2">step</a> ()=0</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shifts storage position for another time step. <br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="51c1aa8a84a14097b51607a187ae3617"></a><!-- doxytag: member="logger::finalize" ref="51c1aa8a84a14097b51607a187ae3617" args="()" -->
60virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#51c1aa8a84a14097b51607a187ae3617">finalize</a> ()</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize storing information. <br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="92c63a0a87392c62b9ed3c00faa9d5df"></a><!-- doxytag: member="logger::~logger" ref="92c63a0a87392c62b9ed3c00faa9d5df" args="()" -->
64virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#92c63a0a87392c62b9ed3c00faa9d5df">~logger</a> ()</td></tr>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">for future use <br></td></tr>
67<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83eea0cf4fbca59474d015f751f128a7"></a><!-- doxytag: member="logger::entries" ref="83eea0cf4fbca59474d015f751f128a7" args="" -->
69Array&lt; <a class="el" href="classRV.html">RV</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#83eea0cf4fbca59474d015f751f128a7">entries</a></td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="39cb79e839ca8f8bb9dcbc8c5b9c7786"></a><!-- doxytag: member="logger::names" ref="39cb79e839ca8f8bb9dcbc8c5b9c7786" args="" -->
73Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlogger.html#39cb79e839ca8f8bb9dcbc8c5b9c7786">names</a></td></tr>
74
75<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr>
76</table>
77<hr><a name="_details"></a><h2>Detailed Description</h2>
78Class for storing results (and semi-results) of an experiment.
79<p>
80This 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="classlogger.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>The documentation for this class was generated from the following file:<ul>
81<li>work/git/mixpp/bdm/stat/<a class="el" href="loggers_8h-source.html">loggers.h</a></ul>
82</div>
83<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 15 15:57:15 2008 for mixpp by&nbsp;
84<a href="http://www.doxygen.org/index.html">
85<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
86</body>
87</html>
Note: See TracBrowser for help on using the browser.