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="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 Page</span></a></li> |
---|
12 | <li><a href="pages.html"><span>Related Pages</span></a></li> |
---|
13 | <li><a href="modules.html"><span>Modules</span></a></li> |
---|
14 | <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
---|
15 | <li><a href="files.html"><span>Files</span></a></li> |
---|
16 | </ul> |
---|
17 | </div> |
---|
18 | <div class="tabs"> |
---|
19 | <ul> |
---|
20 | <li><a href="annotated.html"><span>Class List</span></a></li> |
---|
21 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
22 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
23 | </ul> |
---|
24 | </div> |
---|
25 | <div class="navpath"><b>bdm</b>::<a class="el" href="classbdm_1_1logger.html">logger</a> |
---|
26 | </div> |
---|
27 | </div> |
---|
28 | <div class="contents"> |
---|
29 | <h1>bdm::logger Class Reference</h1><!-- doxytag: class="bdm::logger" -->Class for storing results (and semi-results) of an experiment. |
---|
30 | <a href="#_details">More...</a> |
---|
31 | <p> |
---|
32 | <code>#include <<a class="el" href="loggers_8h-source.html">loggers.h</a>></code> |
---|
33 | <p> |
---|
34 | <div class="dynheader"> |
---|
35 | Inheritance diagram for bdm::logger:</div> |
---|
36 | <div class="dynsection"> |
---|
37 | <p><center><img src="classbdm_1_1logger__inherit__graph.png" border="0" usemap="#bdm_1_1logger__inherit__map" alt="Inheritance graph"></center> |
---|
38 | <map name="bdm_1_1logger__inherit__map"> |
---|
39 | <area shape="rect" href="classbdm_1_1memlog.html" title="Logging into matrices in data format in memory." alt="" coords="5,84,117,111"><area shape="rect" href="classbdm_1_1dirfilelog.html" title="Logging into dirfile with buffer in memory." alt="" coords="5,161,117,188"></map> |
---|
40 | <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> |
---|
41 | |
---|
42 | <p> |
---|
43 | <a href="classbdm_1_1logger-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
44 | <tr><td></td></tr> |
---|
45 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
46 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f9c2fe7db5ddbda0098a4a5bd2c29fbf"></a><!-- doxytag: member="bdm::logger::logger" ref="f9c2fe7db5ddbda0098a4a5bd2c29fbf" args="()" --> |
---|
47 | </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#f9c2fe7db5ddbda0098a4a5bd2c29fbf">logger</a> ()</td></tr> |
---|
48 | |
---|
49 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr> |
---|
50 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cfb4807e20b3d00f3d33e55ada528dc1"></a><!-- doxytag: member="bdm::logger::add" ref="cfb4807e20b3d00f3d33e55ada528dc1" args="(const RV &rv, string name="")" --> |
---|
51 | virtual int </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> &rv, string name="")</td></tr> |
---|
52 | |
---|
53 | <tr><td class="mdescLeft"> </td><td class="mdescRight">returns an identifier which will be later needed for calling the log() function <br></td></tr> |
---|
54 | <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" --> |
---|
55 | 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> |
---|
56 | |
---|
57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">log this vector <br></td></tr> |
---|
58 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f31c03578a7b9b30d8b1f8c338a37e8"></a><!-- doxytag: member="bdm::logger::step" ref="4f31c03578a7b9b30d8b1f8c338a37e8" args="()=0" --> |
---|
59 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#4f31c03578a7b9b30d8b1f8c338a37e8">step</a> ()=0</td></tr> |
---|
60 | |
---|
61 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Shifts storage position for another time step. <br></td></tr> |
---|
62 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0e3fc7d13e23a8f71fc7c8a5ea68559d"></a><!-- doxytag: member="bdm::logger::finalize" ref="0e3fc7d13e23a8f71fc7c8a5ea68559d" args="()" --> |
---|
63 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#0e3fc7d13e23a8f71fc7c8a5ea68559d">finalize</a> ()</td></tr> |
---|
64 | |
---|
65 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Finalize storing information. <br></td></tr> |
---|
66 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd6291a73491f755dc7bc88d022eb2fc"></a><!-- doxytag: member="bdm::logger::init" ref="cd6291a73491f755dc7bc88d022eb2fc" args="()" --> |
---|
67 | virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#cd6291a73491f755dc7bc88d022eb2fc">init</a> ()</td></tr> |
---|
68 | |
---|
69 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the storage. <br></td></tr> |
---|
70 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2ade56238a5d408e65a77c53f516448"></a><!-- doxytag: member="bdm::logger::~logger" ref="f2ade56238a5d408e65a77c53f516448" args="()" --> |
---|
71 | virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#f2ade56238a5d408e65a77c53f516448">~logger</a> ()</td></tr> |
---|
72 | |
---|
73 | <tr><td class="mdescLeft"> </td><td class="mdescRight">for future use <br></td></tr> |
---|
74 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> |
---|
75 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c54566a4554089443a20b2a49ed1a61f"></a><!-- doxytag: member="bdm::logger::entries" ref="c54566a4554089443a20b2a49ed1a61f" args="" --> |
---|
76 | 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> |
---|
77 | |
---|
78 | <tr><td class="mdescLeft"> </td><td class="mdescRight">RVs of all logged variables. <br></td></tr> |
---|
79 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68ca1f05cf3d414ba0f39211977b8d02"></a><!-- doxytag: member="bdm::logger::names" ref="68ca1f05cf3d414ba0f39211977b8d02" args="" --> |
---|
80 | Array< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classbdm_1_1logger.html#68ca1f05cf3d414ba0f39211977b8d02">names</a></td></tr> |
---|
81 | |
---|
82 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Names of logged quantities, e.g. names of algorithm variants. <br></td></tr> |
---|
83 | </table> |
---|
84 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
85 | Class for storing results (and semi-results) of an experiment. |
---|
86 | <p> |
---|
87 | 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>The documentation for this class was generated from the following file:<ul> |
---|
88 | <li>work/git/mixpp/bdm/stat/<a class="el" href="loggers_8h-source.html">loggers.h</a></ul> |
---|
89 | </div> |
---|
90 | <hr size="1"><address style="text-align: right;"><small>Generated on Tue Jan 27 16:31:55 2009 for mixpp by |
---|
91 | <a href="http://www.doxygen.org/index.html"> |
---|
92 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> |
---|
93 | </body> |
---|
94 | </html> |
---|