Changeset 353 for doc/html/classbdm_1_1dirfilelog.html

Timestamp:

06/02/09 10:08:06 (16 years ago)

Author:

smidl

Message:

doc

Files:

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

doc/html/classbdm_1_1dirfilelog.html

@@ -101 +101 @@
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b57dbd3dff49a98c6ce8fccccb170af"></a><!-- doxytag: member="bdm::dirfilelog::logit" ref="2b57dbd3dff49a98c6ce8fccccb170af" args="(int id, const double &amp;d)" -->
+void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#2b57dbd3dff49a98c6ce8fccccb170af">logit</a> (int id, const double &amp;d)</td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this double <br></td></tr>
 <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)" -->
 void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#6a74b7a3d889607391594279112aef1f">itsave</a> (const char *fname)</td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save values into an itfile named after <code>fname</code>. <br></td></tr>
-<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#cfb4807e20b3d00f3d33e55ada528dc1">add</a> (const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;rv, string name=&quot;&quot;)</td></tr>
-
+<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="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="a80210bbe266bf26f100f342460a313f"></a><!-- doxytag: member="bdm::dirfilelog::to_setting" ref="a80210bbe266bf26f100f342460a313f" args="(Setting &amp;root)" -->
+virtual 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>
+
+<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 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="" -->
@@ -113 +129 @@
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of the directory <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7805040fe1ffa2a048c33980bc995793"></a><!-- doxytag: member="bdm::dirfilelog::scalarnames" ref="7805040fe1ffa2a048c33980bc995793" args="" -->
-Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1dirfilelog.html#7805040fe1ffa2a048c33980bc995793">scalarnames</a></td></tr>
+<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_1dirfilelog.html#7805040fe1ffa2a048c33980bc995793">scalarnames</a></td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Automatically generated. <br></td></tr>
@@ -125 +141 @@
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Currect record to be written. <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1fed143162f2de6ef1c1b6557964f24e"></a><!-- doxytag: member="bdm::dirfilelog::vectors" ref="1fed143162f2de6ef1c1b6557964f24e" args="" -->
-Array&lt; mat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#1fed143162f2de6ef1c1b6557964f24e">vectors</a></td></tr>
+<a class="el" href="classitpp_1_1Array.html">Array</a>&lt; mat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#1fed143162f2de6ef1c1b6557964f24e">vectors</a></td></tr>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Storage. <br></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11fdf8ffca0f509ff637b0c3ac161c1f"></a><!-- doxytag: member="bdm::dirfilelog::itfilename" ref="11fdf8ffca0f509ff637b0c3ac161c1f" args="" -->
+string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#11fdf8ffca0f509ff637b0c3ac161c1f">itfilename</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of it file to save results <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::dirfilelog::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" -->
-Array&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>
+<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>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr>
 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::dirfilelog::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" -->
-Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr>
+<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>
 
 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr>
@@ -180 +200 @@
 </div><p>
 <hr><h2>Member Function Documentation</h2>
-<a class="anchor" name="cfb4807e20b3d00f3d33e55ada528dc1"></a><!-- doxytag: member="bdm::dirfilelog::add" ref="cfb4807e20b3d00f3d33e55ada528dc1" args="(const RV &amp;rv, string name=&quot;&quot;)" -->
+<a class="anchor" name="47aa3b098a81d02a8ffaea2c9fa09ac7"></a><!-- doxytag: member="bdm::dirfilelog::add" ref="47aa3b098a81d02a8ffaea2c9fa09ac7" args="(const RV &amp;rv, string prefix=&quot;&quot;)" -->
 <div class="memitem">
 <div class="memproto">
@@ -194 +214 @@
           <td></td>
           <td class="paramtype">string&nbsp;</td>
-          <td class="paramname"> <em>name</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td>
+          <td class="paramname"> <em>prefix</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td>
         </tr>
         <tr>
@@ -207 +227 @@
 <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#l00122">bdm::RV::_dsize()</a>, <a class="el" href="libBM_8h-source.html#l00492">bdm::logger::entries</a>, and <a class="el" href="libBM_8h-source.html#l00494">bdm::logger::names</a>.</p>
-
-<p>Referenced by <a class="el" href="pmsmDS_8h-source.html#l00153">pmsmCRB::log_add()</a>, <a class="el" href="pmsmDS_8h-source.html#l00083">pmsmDS::log_add()</a>, <a class="el" href="libDS_8h-source.html#l00177">bdm::ArxDS::log_add()</a>, <a class="el" href="libBM_8h-source.html#l00711">bdm::BM::log_add()</a>, and <a class="el" href="libBM_8h-source.html#l00587">bdm::DS::log_add()</a>.</p>
+<p>References <a class="el" href="libBM_8h-source.html#l00145">bdm::RV::_dsize()</a>, <a class="el" href="libBM_8h-source.html#l00515">bdm::logger::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">bdm::logger::names</a>, and <a class="el" href="array_8h-source.html#l00161">itpp::Array&lt; T &gt;::set_length()</a>.</p>
+
+<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>
 
 </div>
@@ -238 +258 @@
 </dl>
 
-<p>References <a class="el" href="loggers_8h-source.html#l00068">dirname</a>, <a class="el" href="libBM_8h-source.html#l00492">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#l00070">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#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>
+<p>References <a class="el" href="loggers_8h-source.html#l00076">dirname</a>, <a class="el" href="libBM_8h-source.html#l00515">bdm::logger::entries</a>, <a class="el" href="itassert_8h-source.html#l00107">it_assert_debug</a>, <a class="el" href="array_8h-source.html#l00157">itpp::Array&lt; T &gt;::length()</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>, <a class="el" href="array_8h-source.html#l00155">itpp::Array&lt; T &gt;::size()</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>
 
 </div>
@@ -247 +267 @@
 <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 Thu Apr 23 21:06:46 2009 for mixpp by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:18 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>