root/library/doc/html/classbdm_1_1mexlog.html @ 570

Revision 538, 16.4 kB (checked in by smidl, 15 years ago)

Documentation regenerated

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: bdm::mexlog Class Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
55      <li><a href="files.html"><span>Files</span></a></li>
56    </ul>
57  </div>
58  <div class="tabs">
59    <ul>
60      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
61      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
62      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
63      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
64    </ul>
65  </div>
66  <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1mexlog.html">mexlog</a>
67  </div>
68</div>
69<div class="contents">
70<h1>bdm::mexlog Class Reference</h1><!-- doxytag: class="bdm::mexlog" --><!-- doxytag: inherits="bdm::memlog" -->Logger storing results into an mxArray. 
71<a href="#_details">More...</a>
72<p>
73<code>#include &lt;<a class="el" href="mex__logger_8h-source.html">mex_logger.h</a>&gt;</code>
74<p>
75
76<p>
77<a href="classbdm_1_1mexlog-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
78<tr><td></td></tr>
79<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c458d92bb26518c908521a8c9460a2c1"></a><!-- doxytag: member="bdm::mexlog::mexlog" ref="c458d92bb26518c908521a8c9460a2c1" args="()" -->
81&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexlog.html#c458d92bb26518c908521a8c9460a2c1">mexlog</a> ()</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">constructor <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="178cb899ae5158c0be059cd0196a83d3"></a><!-- doxytag: member="bdm::mexlog::toCell" ref="178cb899ae5158c0be059cd0196a83d3" args="()" -->
85mxArray *&nbsp;</td><td class="memItemRight" valign="bottom"><b>toCell</b> ()</td></tr>
86
87<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1mexlog.html#39c44b30f201091ab3d287fe5741113e">from_setting</a> (const Setting &amp;<a class="el" href="classbdm_1_1root.html">root</a>)</td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> for <a class="el" href="classbdm_1_1memlog.html">memlog</a>.  <a href="#39c44b30f201091ab3d287fe5741113e"></a><br></td></tr>
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d3a8b007f3540523ff3f9910d9089391"></a><!-- doxytag: member="bdm::mexlog::init" ref="d3a8b007f3540523ff3f9910d9089391" args="()" -->
91void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#d3a8b007f3540523ff3f9910d9089391">init</a> ()</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize storage. <br></td></tr>
94<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="69964f0472e53098528ee41507bdfc77"></a><!-- doxytag: member="bdm::mexlog::step" ref="69964f0472e53098528ee41507bdfc77" args="()" -->
95void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#69964f0472e53098528ee41507bdfc77">step</a> ()</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shifts storage position for another time step. <br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="364e58c5d7058776c2a9cfa7d58dad6d"></a><!-- doxytag: member="bdm::mexlog::logit" ref="364e58c5d7058776c2a9cfa7d58dad6d" args="(int id, const vec &amp;v)" -->
99void&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>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this vector <br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b57dbd3dff49a98c6ce8fccccb170af"></a><!-- doxytag: member="bdm::mexlog::logit" ref="2b57dbd3dff49a98c6ce8fccccb170af" args="(int id, const double &amp;d)" -->
103void&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>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">log this double <br></td></tr>
106<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6a74b7a3d889607391594279112aef1f"></a><!-- doxytag: member="bdm::mexlog::itsave" ref="6a74b7a3d889607391594279112aef1f" args="(const char *fname)" -->
107void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#6a74b7a3d889607391594279112aef1f">itsave</a> (const char *fname)</td></tr>
108
109<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save values into an itfile named after <code>fname</code>. <br></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="39e32f671414c71304e316976ccc37f3"></a><!-- doxytag: member="bdm::mexlog::finalize" ref="39e32f671414c71304e316976ccc37f3" args="()" -->
111void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#39e32f671414c71304e316976ccc37f3">finalize</a> ()</td></tr>
112
113<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize storing information. <br></td></tr>
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>
115
116<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::mexlog::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" -->
117virtual string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr>
118
119<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr>
120<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::mexlog::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &amp;set) const " -->
121virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &amp;set) const </td></tr>
122
123<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr>
124<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::mexlog::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" -->
125virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr>
126
127<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method TODO. <br></td></tr>
128<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
129<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a690ebd91430b5973855c9b4c9cf1b1d"></a><!-- doxytag: member="bdm::mexlog::maxlen" ref="a690ebd91430b5973855c9b4c9cf1b1d" args="" -->
130int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#a690ebd91430b5973855c9b4c9cf1b1d">maxlen</a></td></tr>
131
132<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum length of vectors stored in memory. <br></td></tr>
133<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="70cec1d3549a82796ad7b6f0d07a4570"></a><!-- doxytag: member="bdm::mexlog::ind" ref="70cec1d3549a82796ad7b6f0d07a4570" args="" -->
134int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#70cec1d3549a82796ad7b6f0d07a4570">ind</a></td></tr>
135
136<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Currect record to be written. <br></td></tr>
137<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1fed143162f2de6ef1c1b6557964f24e"></a><!-- doxytag: member="bdm::mexlog::vectors" ref="1fed143162f2de6ef1c1b6557964f24e" args="" -->
138Array&lt; mat &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#1fed143162f2de6ef1c1b6557964f24e">vectors</a></td></tr>
139
140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Storage. <br></td></tr>
141<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="11fdf8ffca0f509ff637b0c3ac161c1f"></a><!-- doxytag: member="bdm::mexlog::itfilename" ref="11fdf8ffca0f509ff637b0c3ac161c1f" args="" -->
142string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1memlog.html#11fdf8ffca0f509ff637b0c3ac161c1f">itfilename</a></td></tr>
143
144<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">name of it file to save results <br></td></tr>
145<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::mexlog::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" -->
146Array&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>
147
148<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">RVs of all logged variables. <br></td></tr>
149<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::mexlog::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" -->
150Array&lt; string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr>
151
152<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr>
153</table>
154<hr><a name="_details"></a><h2>Detailed Description</h2>
155Logger storing results into an mxArray. <hr><h2>Member Function Documentation</h2>
156<a class="anchor" name="47aa3b098a81d02a8ffaea2c9fa09ac7"></a><!-- doxytag: member="bdm::mexlog::add" ref="47aa3b098a81d02a8ffaea2c9fa09ac7" args="(const RV &amp;rv, string prefix=&quot;&quot;)" -->
157<div class="memitem">
158<div class="memproto">
159      <table class="memname">
160        <tr>
161          <td class="memname">virtual int bdm::logger::add           </td>
162          <td>(</td>
163          <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> &amp;&nbsp;</td>
164          <td class="paramname"> <em>rv</em>, </td>
165        </tr>
166        <tr>
167          <td class="paramkey"></td>
168          <td></td>
169          <td class="paramtype">string&nbsp;</td>
170          <td class="paramname"> <em>prefix</em> = <code>&quot;&quot;</code></td><td>&nbsp;</td>
171        </tr>
172        <tr>
173          <td></td>
174          <td>)</td>
175          <td></td><td></td><td><code> [inline, virtual, inherited]</code></td>
176        </tr>
177      </table>
178</div>
179<div class="memdoc">
180
181<p>
182returns 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>.
183<p>References <a class="el" href="bdmbase_8h-source.html#l00676">bdm::logger::entries</a>, and <a class="el" href="bdmbase_8h-source.html#l00678">bdm::logger::names</a>.</p>
184
185<p>Referenced by <a class="el" href="datasources_8h-source.html#l00199">bdm::ArxDS::log_add()</a>, <a class="el" href="bdmbase_8h-source.html#l00967">bdm::BM::log_add()</a>, and <a class="el" href="bdmbase_8h-source.html#l00792">bdm::DS::log_add()</a>.</p>
186
187</div>
188</div><p>
189<a class="anchor" name="39c44b30f201091ab3d287fe5741113e"></a><!-- doxytag: member="bdm::mexlog::from_setting" ref="39c44b30f201091ab3d287fe5741113e" args="(const Setting &amp;root)" -->
190<div class="memitem">
191<div class="memproto">
192      <table class="memname">
193        <tr>
194          <td class="memname">void bdm::mexlog::from_setting           </td>
195          <td>(</td>
196          <td class="paramtype">const Setting &amp;&nbsp;</td>
197          <td class="paramname"> <em>set</em>          </td>
198          <td>&nbsp;)&nbsp;</td>
199          <td><code> [inline, virtual]</code></td>
200        </tr>
201      </table>
202</div>
203<div class="memdoc">
204
205<p>
206<a class="el" href="classbdm_1_1UI.html" title="UI is an abstract class which collects all the auxiliary functions useful to prepare...">UI</a> for <a class="el" href="classbdm_1_1memlog.html">memlog</a>.
207<p>
208TODO dat tam kam patri, a to celej blok<p>
209<div class="fragment"><pre class="fragment">        <a class="code" href="classbdm_1_1logger.html#f9c2fe7db5ddbda0098a4a5bd2c29fbf" title="Default constructor.">logger</a> = {
210                <span class="keyword">class </span>= "<a class="code" href="classbdm_1_1memlog.html#611dda03b3050de2eaa448a59cee9c27" title="Default constructor.">memlog</a>";
211                filename = <span class="stringliteral">"file_name.it"</span>; <span class="comment">// resulting filename with results in it format</span>
212                <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</span>
213        }
214</pre></div> 
215<p>Reimplemented from <a class="el" href="classbdm_1_1memlog.html#7352b474bc54c35ab7c9297c5b958629">bdm::memlog</a>.</p>
216
217<p>References <a class="el" href="loggers_8h-source.html#l00029">bdm::memlog::maxlen</a>.</p>
218
219</div>
220</div><p>
221<hr>The documentation for this class was generated from the following file:<ul>
222<li><a class="el" href="mex__logger_8h-source.html">mex_logger.h</a></ul>
223</div>
224<hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 16 17:58:19 2009 for mixpp by&nbsp;
225<a href="http://www.doxygen.org/index.html">
226<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
227</body>
228</html>
Note: See TracBrowser for help on using the browser.