root/doc/html/classbdm_1_1dirfilelog.html @ 269

Revision 269, 14.4 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::dirfilelog 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_1dirfilelog.html">dirfilelog</a>
[259]28  </div>
29</div>
30<div class="contents">
31<h1>bdm::dirfilelog Class Reference</h1><!-- doxytag: class="bdm::dirfilelog" --><!-- doxytag: inherits="bdm::memlog" -->Logging into dirfile with buffer in memory. 
32<a href="#_details">More...</a>
33<p>
34<code>#include &lt;<a class="el" href="loggers_8h-source.html">loggers.h</a>&gt;</code>
35<p>
36<div class="dynheader">
37Inheritance diagram for bdm::dirfilelog:</div>
38<div class="dynsection">
39<p><center><img src="classbdm_1_1dirfilelog__inherit__graph.png" border="0" usemap="#bdm_1_1dirfilelog__inherit__map" alt="Inheritance graph"></center>
40<map name="bdm_1_1dirfilelog__inherit__map">
[269]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_1logger.html" title="Class for storing results (and semi&#45;results) of an experiment." alt="" coords="12,84,111,111"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
[259]42<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
43<div class="dynheader">
44Collaboration diagram for bdm::dirfilelog:</div>
45<div class="dynsection">
46<p><center><img src="classbdm_1_1dirfilelog__coll__graph.png" border="0" usemap="#bdm_1_1dirfilelog__coll__map" alt="Collaboration graph"></center>
47<map name="bdm_1_1dirfilelog__coll__map">
[269]48<area shape="rect" href="classbdm_1_1memlog.html" title="Logging into matrices in data format in memory." alt="" coords="5,167,117,193"><area shape="rect" href="classbdm_1_1logger.html" title="Class for storing results (and semi&#45;results) of an experiment." alt="" coords="12,87,111,113"><area shape="rect" href="classbdm_1_1bdmroot.html" title="Root class of BDM objects." alt="" coords="5,7,117,33"></map>
[259]49<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
50
51<p>
52<a href="classbdm_1_1dirfilelog-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#534cdc903068764f1f243ae8fc0316a3">dirfilelog</a> (std::string dirname0, int maxlen0)</td></tr>
56
57<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#534cdc903068764f1f243ae8fc0316a3"></a><br></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78a3bd8a83cbd6299e279544bc81493d"></a><!-- doxytag: member="bdm::dirfilelog::init" ref="78a3bd8a83cbd6299e279544bc81493d" args="()" -->
59void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#78a3bd8a83cbd6299e279544bc81493d">init</a> ()</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize storage. <br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f79660645d09aa2d8bdd18923a721662"></a><!-- doxytag: member="bdm::dirfilelog::step" ref="f79660645d09aa2d8bdd18923a721662" args="()" -->
63void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#f79660645d09aa2d8bdd18923a721662">step</a> ()</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shifts storage position for another time step. <br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="521d7ba159f97a0182392df27953804f"></a><!-- doxytag: member="bdm::dirfilelog::finalize" ref="521d7ba159f97a0182392df27953804f" args="()" -->
67void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#521d7ba159f97a0182392df27953804f">finalize</a> ()</td></tr>
68
69<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize storing information. <br></td></tr>
70<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#f595c0df25f5fa5d8c27ea1e375d9c51">write_buffers</a> (int Len)</td></tr>
71
72<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write memory storage to disk.  <a href="#f595c0df25f5fa5d8c27ea1e375d9c51"></a><br></td></tr>
73<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="364e58c5d7058776c2a9cfa7d58dad6d"></a><!-- doxytag: member="bdm::dirfilelog::logit" ref="364e58c5d7058776c2a9cfa7d58dad6d" args="(int id, const vec &amp;v)" -->
74void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#364e58c5d7058776c2a9cfa7d58dad6d">logit</a> (int id, const vec &amp;v)</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6a74b7a3d889607391594279112aef1f"></a><!-- doxytag: member="bdm::dirfilelog::itsave" ref="6a74b7a3d889607391594279112aef1f" args="(const char *fname)" -->
78void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#6a74b7a3d889607391594279112aef1f">itsave</a> (const char *fname)</td></tr>
79
80<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save values into an itfile named after <code>fname</code>. <br></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfb4807e20b3d00f3d33e55ada528dc1"></a><!-- doxytag: member="bdm::dirfilelog::add" ref="cfb4807e20b3d00f3d33e55ada528dc1" args="(const RV &amp;rv, string name=&quot;&quot;)" -->
82virtual 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>
83
84<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>
85<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="985eb02770f01e25cdceff32ff53a9c5"></a><!-- doxytag: member="bdm::dirfilelog::dirname" ref="985eb02770f01e25cdceff32ff53a9c5" args="" -->
87string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#985eb02770f01e25cdceff32ff53a9c5">dirname</a></td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of the directory <br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7805040fe1ffa2a048c33980bc995793"></a><!-- doxytag: member="bdm::dirfilelog::scalarnames" ref="7805040fe1ffa2a048c33980bc995793" args="" -->
91Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#7805040fe1ffa2a048c33980bc995793">scalarnames</a></td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Automatically generated. <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a690ebd91430b5973855c9b4c9cf1b1d"></a><!-- doxytag: member="bdm::dirfilelog::maxlen" ref="a690ebd91430b5973855c9b4c9cf1b1d" args="" -->
95int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a690ebd91430b5973855c9b4c9cf1b1d">maxlen</a></td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum length of vectors stored in memory. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70cec1d3549a82796ad7b6f0d07a4570"></a><!-- doxytag: member="bdm::dirfilelog::ind" ref="70cec1d3549a82796ad7b6f0d07a4570" args="" -->
99int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#70cec1d3549a82796ad7b6f0d07a4570">ind</a></td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Currect record to be written. <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1fed143162f2de6ef1c1b6557964f24e"></a><!-- doxytag: member="bdm::dirfilelog::vectors" ref="1fed143162f2de6ef1c1b6557964f24e" args="" -->
103Array&lt; mat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#1fed143162f2de6ef1c1b6557964f24e">vectors</a></td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Storage. <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::dirfilelog::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" -->
107Array&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>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::dirfilelog::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" -->
111Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr>
114</table>
115<hr><a name="_details"></a><h2>Detailed Description</h2>
116Logging into dirfile with buffer in memory.
117<p>
118Dirfile is a special format used by the kst program. See documentation of kst for description.<p>
119This format is used to store scalars, hence multivariate RVs must be separated. <hr><h2>Constructor &amp; Destructor Documentation</h2>
120<a class="anchor" name="534cdc903068764f1f243ae8fc0316a3"></a><!-- doxytag: member="bdm::dirfilelog::dirfilelog" ref="534cdc903068764f1f243ae8fc0316a3" args="(std::string dirname0, int maxlen0)" -->
121<div class="memitem">
122<div class="memproto">
123      <table class="memname">
124        <tr>
125          <td class="memname">bdm::dirfilelog::dirfilelog           </td>
126          <td>(</td>
127          <td class="paramtype">std::string&nbsp;</td>
128          <td class="paramname"> <em>dirname0</em>, </td>
129        </tr>
130        <tr>
131          <td class="paramkey"></td>
132          <td></td>
133          <td class="paramtype">int&nbsp;</td>
134          <td class="paramname"> <em>maxlen0</em></td><td>&nbsp;</td>
135        </tr>
136        <tr>
137          <td></td>
138          <td>)</td>
139          <td></td><td></td><td><code> [inline]</code></td>
140        </tr>
141      </table>
142</div>
143<div class="memdoc">
144
145<p>
146Default constructor.
147<p>
148<dl compact><dt><b>Parameters:</b></dt><dd>
149  <table border="0" cellspacing="2" cellpadding="0">
150    <tr><td valign="top"></td><td valign="top"><em>dirname0</em>&nbsp;</td><td>name of the directory in which to store the results </td></tr>
151    <tr><td valign="top"></td><td valign="top"><em>maxlen0</em>&nbsp;</td><td>length of the memory buffers, when full the buffers will be dumped to HDD and returned to the beginning. </td></tr>
152  </table>
153</dl>
154
155</div>
156</div><p>
157<hr><h2>Member Function Documentation</h2>
158<a class="anchor" name="f595c0df25f5fa5d8c27ea1e375d9c51"></a><!-- doxytag: member="bdm::dirfilelog::write_buffers" ref="f595c0df25f5fa5d8c27ea1e375d9c51" args="(int Len)" -->
159<div class="memitem">
160<div class="memproto">
161      <table class="memname">
162        <tr>
163          <td class="memname">void bdm::dirfilelog::write_buffers           </td>
164          <td>(</td>
165          <td class="paramtype">int&nbsp;</td>
166          <td class="paramname"> <em>Len</em>          </td>
167          <td>&nbsp;)&nbsp;</td>
168          <td></td>
169        </tr>
170      </table>
171</div>
172<div class="memdoc">
173
174<p>
175Write memory storage to disk.
176<p>
177<dl compact><dt><b>Parameters:</b></dt><dd>
178  <table border="0" cellspacing="2" cellpadding="0">
179    <tr><td valign="top"></td><td valign="top"><em>Len</em>&nbsp;</td><td>length of buffer to be written, if 0 the file is truncated at 0. </td></tr>
180  </table>
181</dl>
182
[269]183<p>References <a class="el" href="loggers_8h-source.html#l00067">dirname</a>, <a class="el" href="libBM_8h-source.html#l00389">bdm::logger::entries</a>, <a class="el" href="loggers_8h-source.html#l00031">bdm::memlog::maxlen</a>, <a class="el" href="loggers_8h-source.html#l00069">scalarnames</a>, and <a class="el" href="loggers_8h-source.html#l00035">bdm::memlog::vectors</a>.</p>
[259]184
185<p>Referenced by <a class="el" href="loggers_8cpp-source.html#l00134">finalize()</a>, <a class="el" href="loggers_8cpp-source.html#l00026">init()</a>, and <a class="el" href="loggers_8cpp-source.html#l00123">step()</a>.</p>
186
187</div>
188</div><p>
189<hr>The documentation for this class was generated from the following files:<ul>
[261]190<li><a class="el" href="loggers_8h-source.html">loggers.h</a><li>loggers.cpp</ul>
[259]191</div>
[269]192<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 11 10:21:12 2009 for mixpp by&nbsp;
[259]193<a href="http://www.doxygen.org/index.html">
194<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
195</body>
196</html>
Note: See TracBrowser for help on using the browser.