Changeset 368 for doc/html/classbdm_1_1dirfilelog.html

Timestamp:

06/08/09 18:02:55 (16 years ago)

Author:

smidl

Message:

doc

Files:

• doc/html/classbdm_1_1dirfilelog.html (modified) (8 diffs)

doc/html/classbdm_1_1dirfilelog.html

@@ -79 +79 @@
 <tr><td></td></tr>
 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
-<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>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#534cdc903068764f1f243ae8fc0316a3"></a><br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#15e1c0228c8ecefb372b364742748dff">dirfilelog</a> (string dirname0, int maxlen0)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#15e1c0228c8ecefb372b364742748dff"></a><br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78a3bd8a83cbd6299e279544bc81493d"></a><!-- doxytag: member="bdm::dirfilelog::init" ref="78a3bd8a83cbd6299e279544bc81493d" args="()" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#78a3bd8a83cbd6299e279544bc81493d">init</a> ()</td></tr>
@@ -97 +97 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write memory storage to disk.  <a href="#f595c0df25f5fa5d8c27ea1e375d9c51"></a><br></td></tr>
+<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#bb489fa9f63697b0a9e9fd80e0c45ee1">from_setting</a> (const Setting &amp;root)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classbdm_1_1UI.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">UI</a> for <a class="el" href="classbdm_1_1dirfilelog.html" title="Logging into dirfile with buffer in memory.">dirfilelog</a> (Kst file format).  <a href="#bb489fa9f63697b0a9e9fd80e0c45ee1"></a><br></td></tr>
 <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)" -->
 void&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>
@@ -111 +114 @@
 <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>
 
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3d95e9de79ca1d52b06f1b8f80660f09"></a><!-- doxytag: member="bdm::dirfilelog::ToString" ref="3d95e9de79ca1d52b06f1b8f80660f09" args="()" -->
-virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#3d95e9de79ca1d52b06f1b8f80660f09">ToString</a> ()</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e47a8bd9337478fa4e46d5a2a4336f9a"></a><!-- doxytag: member="bdm::dirfilelog::to_string" ref="e47a8bd9337478fa4e46d5a2a4336f9a" args="()" -->
+virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#e47a8bd9337478fa4e46d5a2a4336f9a">to_string</a> ()</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4602efd3ad9fb9e4532426e4f488df8"></a><!-- doxytag: member="bdm::dirfilelog::from_setting" ref="d4602efd3ad9fb9e4532426e4f488df8" args="(const Setting &amp;root)" -->
-virtual 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>
-
-<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>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd74cb898b22b95b7ee528e040a07618"></a><!-- doxytag: member="bdm::dirfilelog::to_setting" ref="dd74cb898b22b95b7ee528e040a07618" args="(Setting &amp;root) const " -->
 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#dd74cb898b22b95b7ee528e040a07618">to_setting</a> (Setting &amp;root) const </td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8cc21ea15fc723065eed5f3100757a5"></a><!-- doxytag: member="bdm::dirfilelog::validate" ref="d8cc21ea15fc723065eed5f3100757a5" args="()" -->
+virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1bdmroot.html#d8cc21ea15fc723065eed5f3100757a5">validate</a> ()</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
 <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="985eb02770f01e25cdceff32ff53a9c5"></a><!-- doxytag: member="bdm::dirfilelog::dirname" ref="985eb02770f01e25cdceff32ff53a9c5" args="" -->
@@ -162 +165 @@
 Dirfile is a special format used by the kst program. See documentation of kst for description.<p>
 This format is used to store scalars, hence multivariate RVs must be separated. <hr><h2>Constructor &amp; Destructor Documentation</h2>
-<a class="anchor" name="534cdc903068764f1f243ae8fc0316a3"></a><!-- doxytag: member="bdm::dirfilelog::dirfilelog" ref="534cdc903068764f1f243ae8fc0316a3" args="(std::string dirname0, int maxlen0)" -->
+<a class="anchor" name="15e1c0228c8ecefb372b364742748dff"></a><!-- doxytag: member="bdm::dirfilelog::dirfilelog" ref="15e1c0228c8ecefb372b364742748dff" args="(string dirname0, int maxlen0)" -->
 <div class="memitem">
 <div class="memproto">
@@ -169 +172 @@
           <td class="memname">bdm::dirfilelog::dirfilelog           </td>
           <td>(</td>
-          <td class="paramtype">std::string&nbsp;</td>
+          <td class="paramtype">string&nbsp;</td>
           <td class="paramname"> <em>dirname0</em>, </td>
         </tr>
@@ -227 +230 @@
 <p>
 returns 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>. 
-<p>References <a class="el" href="libBM_8h-source.html#l00146">bdm::RV::_dsize()</a>, <a class="el" href="libBM_8h-source.html#l00516">bdm::logger::entries</a>, and <a class="el" href="libBM_8h-source.html#l00518">bdm::logger::names</a>.</p>
-
-<p>Referenced by <a class="el" href="libDS_8h-source.html#l00181">bdm::ArxDS::log_add()</a>, <a class="el" href="libBM_8h-source.html#l00742">bdm::BM::log_add()</a>, and <a class="el" href="libBM_8h-source.html#l00613">bdm::DS::log_add()</a>.</p>
+<p>References <a class="el" href="libBM_8h-source.html#l00120">bdm::RV::_dsize()</a>, <a class="el" href="libBM_8h-source.html#l00508">bdm::logger::entries</a>, and <a class="el" href="libBM_8h-source.html#l00510">bdm::logger::names</a>.</p>
+
+<p>Referenced by <a class="el" href="libDS_8h-source.html#l00191">bdm::ArxDS::log_add()</a>, <a class="el" href="libBM_8h-source.html#l00734">bdm::BM::log_add()</a>, and <a class="el" href="libBM_8h-source.html#l00605">bdm::DS::log_add()</a>.</p>
+
+</div>
+</div><p>
+<a class="anchor" name="bb489fa9f63697b0a9e9fd80e0c45ee1"></a><!-- doxytag: member="bdm::dirfilelog::from_setting" ref="bb489fa9f63697b0a9e9fd80e0c45ee1" args="(const Setting &amp;root)" -->
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void bdm::dirfilelog::from_setting           </td>
+          <td>(</td>
+          <td class="paramtype">const Setting &amp;&nbsp;</td>
+          <td class="paramname"> <em>root</em>          </td>
+          <td>&nbsp;)&nbsp;</td>
+          <td><code> [virtual]</code></td>
+        </tr>
+      </table>
+</div>
+<div class="memdoc">
+
+<p>
+<a class="el" href="classbdm_1_1UI.html" title="This class serves to load and/or save DOMElements into/from files stored on a hard-disk...">UI</a> for <a class="el" href="classbdm_1_1dirfilelog.html" title="Logging into dirfile with buffer in memory.">dirfilelog</a> (Kst file format). 
+<p>
+<div class="fragment"><pre class="fragment">        <a class="code" href="classbdm_1_1logger.html#f9c2fe7db5ddbda0098a4a5bd2c29fbf" title="Default constructor.">logger</a> = {
+                type = <span class="stringliteral">"dirfilelog"</span>;
+                dirmane = <span class="stringliteral">"directory_for_files"</span>; <span class="comment">// resulting files will be stored there</span>
+                <a class="code" href="classbdm_1_1memlog.html#a690ebd91430b5973855c9b4c9cf1b1d" title="Maximum length of vectors stored in memory.">maxlen</a> = 100;                    <span class="comment">// size of memory buffer, when full results are written to disk</span>
+        }
+</pre></div> 
+<p>Reimplemented from <a class="el" href="classbdm_1_1memlog.html#43ece9603339302556865682138eb58a">bdm::memlog</a>.</p>
+
+<p>References <a class="el" href="loggers_8h-source.html#l00097">dirname</a>, <a class="el" href="loggers_8h-source.html#l00032">bdm::memlog::maxlen</a>, and <a class="el" href="loggers_8h-source.html#l00099">scalarnames</a>.</p>
 
 </div>
@@ -258 +292 @@
 </dl>
 
-<p>References <a class="el" href="loggers_8h-source.html#l00076">dirname</a>, <a class="el" href="libBM_8h-source.html#l00516">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#l00078">scalarnames</a>, and <a class="el" href="loggers_8h-source.html#l00035">bdm::memlog::vectors</a>.</p>
-
-<p>Referenced by <a class="el" href="loggers_8cpp-source.html#l00137">finalize()</a>, <a class="el" href="loggers_8cpp-source.html#l00029">init()</a>, and <a class="el" href="loggers_8cpp-source.html#l00126">step()</a>.</p>
+<p>References <a class="el" href="loggers_8h-source.html#l00097">dirname</a>, <a class="el" href="libBM_8h-source.html#l00508">bdm::logger::entries</a>, <a class="el" href="loggers_8h-source.html#l00032">bdm::memlog::maxlen</a>, <a class="el" href="loggers_8h-source.html#l00099">scalarnames</a>, and <a class="el" href="loggers_8h-source.html#l00036">bdm::memlog::vectors</a>.</p>
+
+<p>Referenced by <a class="el" href="loggers_8cpp-source.html#l00155">finalize()</a>, <a class="el" href="loggers_8cpp-source.html#l00046">init()</a>, and <a class="el" href="loggers_8cpp-source.html#l00144">step()</a>.</p>
 
 </div>
@@ -267 +301 @@
 <li><a class="el" href="loggers_8h-source.html">loggers.h</a><li>loggers.cpp</ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:11:01 2009 for mixpp by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 8 18:02:35 2009 for mixpp by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>