root/doc/html/classbdm_1_1logger.html @ 264

Revision 264, 8.9 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[259]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<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><a href="modules.html"><span>Modules</span></a></li>
[261]14      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
15      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
[259]16      <li><a href="files.html"><span>Files</span></a></li>
17    </ul>
18  </div>
19  <div class="tabs">
20    <ul>
[261]21      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
[259]22      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
23      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
24      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
25    </ul>
26  </div>
[261]27  <div class="navpath"><a class="el" href="namespacebdm.html">bdm</a>::<a class="el" href="classbdm_1_1logger.html">logger</a>
[259]28  </div>
29</div>
30<div class="contents">
[264]31<h1>bdm::logger Class Reference</h1><!-- doxytag: class="bdm::logger" --><!-- doxytag: inherits="bdm::bdmroot" -->DataLink is a connection between two data vectors Up and Down. 
[259]32<a href="#_details">More...</a>
33<p>
[264]34<code>#include &lt;<a class="el" href="libBM_8h-source.html">libBM.h</a>&gt;</code>
[259]35<p>
36<div class="dynheader">
37Inheritance diagram for bdm::logger:</div>
38<div class="dynsection">
39<p><center><img src="classbdm_1_1logger__inherit__graph.png" border="0" usemap="#bdm_1_1logger__inherit__map" alt="Inheritance graph"></center>
40<map name="bdm_1_1logger__inherit__map">
[261]41<area shape="rect" href="classbdm_1_1memlog.html" title="Logging into matrices in data format in memory." alt="" coords="5,161,117,188"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"><area shape="rect" href="classbdm_1_1dirfilelog.html" title="Logging into dirfile with buffer in memory." alt="" coords="5,239,117,265"></map>
[259]42<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
[261]43<div class="dynheader">
44Collaboration diagram for bdm::logger:</div>
45<div class="dynsection">
46<p><center><img src="classbdm_1_1logger__coll__graph.png" border="0" usemap="#bdm_1_1logger__coll__map" alt="Collaboration graph"></center>
47<map name="bdm_1_1logger__coll__map">
48<area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
49<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
[259]50
51<p>
52<a href="classbdm_1_1logger-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
53<tr><td></td></tr>
54<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
55<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f9c2fe7db5ddbda0098a4a5bd2c29fbf"></a><!-- doxytag: member="bdm::logger::logger" ref="f9c2fe7db5ddbda0098a4a5bd2c29fbf" args="()" -->
56&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#f9c2fe7db5ddbda0098a4a5bd2c29fbf">logger</a> ()</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfb4807e20b3d00f3d33e55ada528dc1"></a><!-- doxytag: member="bdm::logger::add" ref="cfb4807e20b3d00f3d33e55ada528dc1" args="(const RV &amp;rv, string name=&quot;&quot;)" -->
60virtual 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>
61
62<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>
63<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" -->
64virtual 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>
65
66<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br></td></tr>
67<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f31c03578a7b9b30d8b1f8c338a37e8"></a><!-- doxytag: member="bdm::logger::step" ref="4f31c03578a7b9b30d8b1f8c338a37e8" args="()=0" -->
68virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#4f31c03578a7b9b30d8b1f8c338a37e8">step</a> ()=0</td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shifts storage position for another time step. <br></td></tr>
71<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0e3fc7d13e23a8f71fc7c8a5ea68559d"></a><!-- doxytag: member="bdm::logger::finalize" ref="0e3fc7d13e23a8f71fc7c8a5ea68559d" args="()" -->
72virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#0e3fc7d13e23a8f71fc7c8a5ea68559d">finalize</a> ()</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize storing information. <br></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd6291a73491f755dc7bc88d022eb2fc"></a><!-- doxytag: member="bdm::logger::init" ref="cd6291a73491f755dc7bc88d022eb2fc" args="()" -->
76virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#cd6291a73491f755dc7bc88d022eb2fc">init</a> ()</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the storage. <br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2ade56238a5d408e65a77c53f516448"></a><!-- doxytag: member="bdm::logger::~logger" ref="f2ade56238a5d408e65a77c53f516448" args="()" -->
80virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#f2ade56238a5d408e65a77c53f516448">~logger</a> ()</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">for future use <br></td></tr>
83<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::logger::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" -->
85Array&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>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::logger::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" -->
89Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr>
92</table>
93<hr><a name="_details"></a><h2>Detailed Description</h2>
[264]94DataLink is a connection between two data vectors Up and Down.
[259]95<p>
[264]96Up can be longer than Down. Down must be fully present in Up (TODO optional) See chart: <div align="center">
97<img src="inline_dotgraph_1.dot.png" alt="inline_dotgraph_1.dot" border="0" usemap="#inline_dotgraph_1.dot.map">
98<map name="inline_dotgraph_1.dot.map"></map>
[259]99</div>
[264]100<p>
101Class for storing results (and semi-results) of an experiment This 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="DataLink is a connection between two data vectors Up and Down.">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>
102<li><a class="el" href="libBM_8h-source.html">libBM.h</a></ul>
103</div>
104<hr size="1"><address style="text-align: right;"><small>Generated on Fri Feb 6 19:50:08 2009 for mixpp by&nbsp;
[259]105<a href="http://www.doxygen.org/index.html">
106<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
107</body>
108</html>
Note: See TracBrowser for help on using the browser.