| [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="tabs.css" rel="stylesheet" type="text/css"> |
|---|
| [290] | 5 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
|---|
| [259] | 6 | </head><body> |
|---|
| [538] | 7 | <!-- Generated by Doxygen 1.5.8 --> |
|---|
| [271] | 8 | <script type="text/javascript"> |
|---|
| 9 | <!-- |
|---|
| 10 | function 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 | } |
|---|
| 22 | function 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 | } |
|---|
| 46 | window.onload = initDynSections; |
|---|
| 47 | --> |
|---|
| 48 | </script> |
|---|
| [259] | 49 | <div class="navigation" id="top"> |
|---|
| 50 | <div class="tabs"> |
|---|
| 51 | <ul> |
|---|
| [271] | 52 | <li><a href="main.html"><span>Main Page</span></a></li> |
|---|
| [259] | 53 | <li><a href="pages.html"><span>Related Pages</span></a></li> |
|---|
| [290] | 54 | <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
|---|
| [259] | 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 List</span></a></li> |
|---|
| [290] | 61 | <li><a href="classes.html"><span>Class Index</span></a></li> |
|---|
| [259] | 62 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
|---|
| 63 | <li><a href="functions.html"><span>Class Members</span></a></li> |
|---|
| 64 | </ul> |
|---|
| 65 | </div> |
|---|
| [271] | 66 | <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1logger.html">logger</a> |
|---|
| [259] | 67 | </div> |
|---|
| 68 | </div> |
|---|
| 69 | <div class="contents"> |
|---|
| [396] | 70 | <h1>bdm::logger Class Reference</h1><!-- doxytag: class="bdm::logger" --><!-- doxytag: inherits="bdm::root" -->Class for storing results (and semi-results) of an experiment. |
|---|
| [290] | 71 | <a href="#_details">More...</a> |
|---|
| [259] | 72 | <p> |
|---|
| [538] | 73 | <code>#include <<a class="el" href="bdmbase_8h-source.html">bdmbase.h</a>></code> |
|---|
| [290] | 74 | <p> |
|---|
| [259] | 75 | |
|---|
| 76 | <p> |
|---|
| [290] | 77 | <a href="classbdm_1_1logger-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
|---|
| [259] | 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="f9c2fe7db5ddbda0098a4a5bd2c29fbf"></a><!-- doxytag: member="bdm::logger::logger" ref="f9c2fe7db5ddbda0098a4a5bd2c29fbf" args="()" --> |
|---|
| 81 | </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#f9c2fe7db5ddbda0098a4a5bd2c29fbf">logger</a> ()</td></tr> |
|---|
| 82 | |
|---|
| 83 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr> |
|---|
| [353] | 84 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </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> &rv, string prefix="")</td></tr> |
|---|
| [259] | 85 | |
|---|
| 86 | <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 &v)=0" --> |
|---|
| 87 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#397c014b0aaf3581516e2a105d26a5c9">logit</a> (int id, const vec &v)=0</td></tr> |
|---|
| 88 | |
|---|
| 89 | <tr><td class="mdescLeft"> </td><td class="mdescRight">log this vector <br></td></tr> |
|---|
| [353] | 90 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3f1697214a9281b80f0914f08d4246c"></a><!-- doxytag: member="bdm::logger::logit" ref="a3f1697214a9281b80f0914f08d4246c" args="(int id, const double &d)=0" --> |
|---|
| 91 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#a3f1697214a9281b80f0914f08d4246c">logit</a> (int id, const double &d)=0</td></tr> |
|---|
| 92 | |
|---|
| 93 | <tr><td class="mdescLeft"> </td><td class="mdescRight">log this double <br></td></tr> |
|---|
| [259] | 94 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f31c03578a7b9b30d8b1f8c338a37e8"></a><!-- doxytag: member="bdm::logger::step" ref="4f31c03578a7b9b30d8b1f8c338a37e8" args="()=0" --> |
|---|
| 95 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#4f31c03578a7b9b30d8b1f8c338a37e8">step</a> ()=0</td></tr> |
|---|
| 96 | |
|---|
| 97 | <tr><td class="mdescLeft"> </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="0e3fc7d13e23a8f71fc7c8a5ea68559d"></a><!-- doxytag: member="bdm::logger::finalize" ref="0e3fc7d13e23a8f71fc7c8a5ea68559d" args="()" --> |
|---|
| 99 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#0e3fc7d13e23a8f71fc7c8a5ea68559d">finalize</a> ()</td></tr> |
|---|
| 100 | |
|---|
| 101 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Finalize storing information. <br></td></tr> |
|---|
| 102 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd6291a73491f755dc7bc88d022eb2fc"></a><!-- doxytag: member="bdm::logger::init" ref="cd6291a73491f755dc7bc88d022eb2fc" args="()" --> |
|---|
| 103 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#cd6291a73491f755dc7bc88d022eb2fc">init</a> ()</td></tr> |
|---|
| 104 | |
|---|
| 105 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the storage. <br></td></tr> |
|---|
| [396] | 106 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="af0e6941ba5919cae1bc530e2181b109"></a><!-- doxytag: member="bdm::logger::to_string" ref="af0e6941ba5919cae1bc530e2181b109" args="()" --> |
|---|
| 107 | virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#af0e6941ba5919cae1bc530e2181b109">to_string</a> ()</td></tr> |
|---|
| [353] | 108 | |
|---|
| 109 | <tr><td class="mdescLeft"> </td><td class="mdescRight">This method returns a basic info about the current instance. <br></td></tr> |
|---|
| [396] | 110 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0551e3121091c5199bf4413b50522176"></a><!-- doxytag: member="bdm::logger::from_setting" ref="0551e3121091c5199bf4413b50522176" args="(const Setting &set)" --> |
|---|
| 111 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#0551e3121091c5199bf4413b50522176">from_setting</a> (const Setting &set)</td></tr> |
|---|
| [353] | 112 | |
|---|
| 113 | <tr><td class="mdescLeft"> </td><td class="mdescRight">This method arrange instance properties according the data stored in the Setting structure. <br></td></tr> |
|---|
| [396] | 114 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67d954d255ede776eade7334d4895790"></a><!-- doxytag: member="bdm::logger::to_setting" ref="67d954d255ede776eade7334d4895790" args="(Setting &set) const " --> |
|---|
| 115 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#67d954d255ede776eade7334d4895790">to_setting</a> (Setting &set) const </td></tr> |
|---|
| [353] | 116 | |
|---|
| 117 | <tr><td class="mdescLeft"> </td><td class="mdescRight">This method save all the instance properties into the Setting structure. <br></td></tr> |
|---|
| [396] | 118 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c314bd6d6dacb8ba78ea5eb88fd9516"></a><!-- doxytag: member="bdm::logger::validate" ref="1c314bd6d6dacb8ba78ea5eb88fd9516" args="()" --> |
|---|
| 119 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1root.html#1c314bd6d6dacb8ba78ea5eb88fd9516">validate</a> ()</td></tr> |
|---|
| [368] | 120 | |
|---|
| 121 | <tr><td class="mdescLeft"> </td><td class="mdescRight">This method TODO. <br></td></tr> |
|---|
| [259] | 122 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> |
|---|
| 123 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::logger::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" --> |
|---|
| [354] | 124 | Array< <a class="el" href="classbdm_1_1RV.html">RV</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#c54566a4554089443a20b2a49ed1a61f">entries</a></td></tr> |
|---|
| [259] | 125 | |
|---|
| 126 | <tr><td class="mdescLeft"> </td><td class="mdescRight">RVs of all logged variables. <br></td></tr> |
|---|
| 127 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::logger::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" --> |
|---|
| [354] | 128 | Array< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr> |
|---|
| [259] | 129 | |
|---|
| 130 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr> |
|---|
| 131 | </table> |
|---|
| [290] | 132 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
|---|
| 133 | Class for storing results (and semi-results) of an experiment. |
|---|
| 134 | <p> |
|---|
| 135 | 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="Class for storing results (and semi-results) of an experiment.">logger</a>. Specializations of this abstract class for specific storage method are designed. <hr><h2>Member Function Documentation</h2> |
|---|
| [353] | 136 | <a class="anchor" name="47aa3b098a81d02a8ffaea2c9fa09ac7"></a><!-- doxytag: member="bdm::logger::add" ref="47aa3b098a81d02a8ffaea2c9fa09ac7" args="(const RV &rv, string prefix="")" --> |
|---|
| [271] | 137 | <div class="memitem"> |
|---|
| 138 | <div class="memproto"> |
|---|
| 139 | <table class="memname"> |
|---|
| 140 | <tr> |
|---|
| 141 | <td class="memname">virtual int bdm::logger::add </td> |
|---|
| 142 | <td>(</td> |
|---|
| 143 | <td class="paramtype">const <a class="el" href="classbdm_1_1RV.html">RV</a> & </td> |
|---|
| 144 | <td class="paramname"> <em>rv</em>, </td> |
|---|
| 145 | </tr> |
|---|
| 146 | <tr> |
|---|
| 147 | <td class="paramkey"></td> |
|---|
| 148 | <td></td> |
|---|
| 149 | <td class="paramtype">string </td> |
|---|
| [353] | 150 | <td class="paramname"> <em>prefix</em> = <code>""</code></td><td> </td> |
|---|
| [271] | 151 | </tr> |
|---|
| 152 | <tr> |
|---|
| 153 | <td></td> |
|---|
| 154 | <td>)</td> |
|---|
| 155 | <td></td><td></td><td><code> [inline, virtual]</code></td> |
|---|
| 156 | </tr> |
|---|
| 157 | </table> |
|---|
| 158 | </div> |
|---|
| 159 | <div class="memdoc"> |
|---|
| 160 | |
|---|
| 161 | <p> |
|---|
| 162 | 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>. |
|---|
| [538] | 163 | <p>References <a class="el" href="bdmbase_8h-source.html#l00676">entries</a>, and <a class="el" href="bdmbase_8h-source.html#l00678">names</a>.</p> |
|---|
| [271] | 164 | |
|---|
| [538] | 165 | <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> |
|---|
| [397] | 166 | |
|---|
| [271] | 167 | </div> |
|---|
| 168 | </div><p> |
|---|
| [270] | 169 | <hr>The documentation for this class was generated from the following file:<ul> |
|---|
| [538] | 170 | <li><a class="el" href="bdmbase_8h-source.html">bdmbase.h</a></ul> |
|---|
| [397] | 171 | </div> |
|---|
| [538] | 172 | <hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 16 17:58:19 2009 for mixpp by |
|---|
| [259] | 173 | <a href="http://www.doxygen.org/index.html"> |
|---|
| [538] | 174 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> |
|---|
| [259] | 175 | </body> |
|---|
| 176 | </html> |
|---|
