root/doc/latex/classbdm_1_1dirfilelog.tex @ 261

Revision 261, 7.3 kB (checked in by smidl, 16 years ago)

doc

Line 
1\hypertarget{classbdm_1_1dirfilelog}{
2\section{bdm::dirfilelog Class Reference}
3\label{classbdm_1_1dirfilelog}\index{bdm::dirfilelog@{bdm::dirfilelog}}
4}
5Logging into dirfile with buffer in memory. 
6
7
8{\tt \#include $<$loggers.h$>$}
9
10Inheritance diagram for bdm::dirfilelog:\nopagebreak
11\begin{figure}[H]
12\begin{center}
13\leavevmode
14\includegraphics[width=64pt]{classbdm_1_1dirfilelog__inherit__graph}
15\end{center}
16\end{figure}
17Collaboration diagram for bdm::dirfilelog:\nopagebreak
18\begin{figure}[H]
19\begin{center}
20\leavevmode
21\includegraphics[width=99pt]{classbdm_1_1dirfilelog__coll__graph}
22\end{center}
23\end{figure}
24\subsection*{Public Member Functions}
25\begin{CompactItemize}
26\item 
27\hyperlink{classbdm_1_1dirfilelog_534cdc903068764f1f243ae8fc0316a3}{dirfilelog} (std::string dirname0, int maxlen0)
28\begin{CompactList}\small\item\em Default constructor. \item\end{CompactList}\item 
29\hypertarget{classbdm_1_1dirfilelog_78a3bd8a83cbd6299e279544bc81493d}{
30void \hyperlink{classbdm_1_1dirfilelog_78a3bd8a83cbd6299e279544bc81493d}{init} ()}
31\label{classbdm_1_1dirfilelog_78a3bd8a83cbd6299e279544bc81493d}
32
33\begin{CompactList}\small\item\em Initialize storage. \item\end{CompactList}\item 
34\hypertarget{classbdm_1_1dirfilelog_f79660645d09aa2d8bdd18923a721662}{
35void \hyperlink{classbdm_1_1dirfilelog_f79660645d09aa2d8bdd18923a721662}{step} ()}
36\label{classbdm_1_1dirfilelog_f79660645d09aa2d8bdd18923a721662}
37
38\begin{CompactList}\small\item\em Shifts storage position for another time step. \item\end{CompactList}\item 
39\hypertarget{classbdm_1_1dirfilelog_521d7ba159f97a0182392df27953804f}{
40void \hyperlink{classbdm_1_1dirfilelog_521d7ba159f97a0182392df27953804f}{finalize} ()}
41\label{classbdm_1_1dirfilelog_521d7ba159f97a0182392df27953804f}
42
43\begin{CompactList}\small\item\em Finalize storing information. \item\end{CompactList}\item 
44void \hyperlink{classbdm_1_1dirfilelog_f595c0df25f5fa5d8c27ea1e375d9c51}{write\_\-buffers} (int Len)
45\begin{CompactList}\small\item\em Write memory storage to disk. \item\end{CompactList}\item 
46\hypertarget{classbdm_1_1memlog_364e58c5d7058776c2a9cfa7d58dad6d}{
47void \hyperlink{classbdm_1_1memlog_364e58c5d7058776c2a9cfa7d58dad6d}{logit} (int id, const vec \&v)}
48\label{classbdm_1_1memlog_364e58c5d7058776c2a9cfa7d58dad6d}
49
50\begin{CompactList}\small\item\em log this vector \item\end{CompactList}\item 
51\hypertarget{classbdm_1_1memlog_6a74b7a3d889607391594279112aef1f}{
52void \hyperlink{classbdm_1_1memlog_6a74b7a3d889607391594279112aef1f}{itsave} (const char $\ast$fname)}
53\label{classbdm_1_1memlog_6a74b7a3d889607391594279112aef1f}
54
55\begin{CompactList}\small\item\em Save values into an itfile named after {\tt fname}. \item\end{CompactList}\item 
56\hypertarget{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}{
57virtual int \hyperlink{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}{add} (const \hyperlink{classbdm_1_1RV}{RV} \&rv, string name=\char`\"{}\char`\"{})}
58\label{classbdm_1_1logger_cfb4807e20b3d00f3d33e55ada528dc1}
59
60\begin{CompactList}\small\item\em returns an identifier which will be later needed for calling the log() function \item\end{CompactList}\end{CompactItemize}
61\subsection*{Protected Attributes}
62\begin{CompactItemize}
63\item 
64\hypertarget{classbdm_1_1dirfilelog_985eb02770f01e25cdceff32ff53a9c5}{
65string \hyperlink{classbdm_1_1dirfilelog_985eb02770f01e25cdceff32ff53a9c5}{dirname}}
66\label{classbdm_1_1dirfilelog_985eb02770f01e25cdceff32ff53a9c5}
67
68\begin{CompactList}\small\item\em name of the directory \item\end{CompactList}\item 
69\hypertarget{classbdm_1_1dirfilelog_7805040fe1ffa2a048c33980bc995793}{
70Array$<$ string $>$ \hyperlink{classbdm_1_1dirfilelog_7805040fe1ffa2a048c33980bc995793}{scalarnames}}
71\label{classbdm_1_1dirfilelog_7805040fe1ffa2a048c33980bc995793}
72
73\begin{CompactList}\small\item\em Automatically generated. \item\end{CompactList}\item 
74\hypertarget{classbdm_1_1memlog_a690ebd91430b5973855c9b4c9cf1b1d}{
75int \hyperlink{classbdm_1_1memlog_a690ebd91430b5973855c9b4c9cf1b1d}{maxlen}}
76\label{classbdm_1_1memlog_a690ebd91430b5973855c9b4c9cf1b1d}
77
78\begin{CompactList}\small\item\em Maximum length of vectors stored in memory. \item\end{CompactList}\item 
79\hypertarget{classbdm_1_1memlog_70cec1d3549a82796ad7b6f0d07a4570}{
80int \hyperlink{classbdm_1_1memlog_70cec1d3549a82796ad7b6f0d07a4570}{ind}}
81\label{classbdm_1_1memlog_70cec1d3549a82796ad7b6f0d07a4570}
82
83\begin{CompactList}\small\item\em Currect record to be written. \item\end{CompactList}\item 
84\hypertarget{classbdm_1_1memlog_1fed143162f2de6ef1c1b6557964f24e}{
85Array$<$ mat $>$ \hyperlink{classbdm_1_1memlog_1fed143162f2de6ef1c1b6557964f24e}{vectors}}
86\label{classbdm_1_1memlog_1fed143162f2de6ef1c1b6557964f24e}
87
88\begin{CompactList}\small\item\em Storage. \item\end{CompactList}\item 
89\hypertarget{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}{
90Array$<$ \hyperlink{classbdm_1_1RV}{RV} $>$ \hyperlink{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}{entries}}
91\label{classbdm_1_1logger_c54566a4554089443a20b2a49ed1a61f}
92
93\begin{CompactList}\small\item\em RVs of all logged variables. \item\end{CompactList}\item 
94\hypertarget{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}{
95Array$<$ string $>$ \hyperlink{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}{names}}
96\label{classbdm_1_1logger_68ca1f05cf3d414ba0f39211977b8d02}
97
98\begin{CompactList}\small\item\em Names of logged quantities, e.g. names of algorithm variants. \item\end{CompactList}\end{CompactItemize}
99
100
101\subsection{Detailed Description}
102Logging into dirfile with buffer in memory.
103
104Dirfile is a special format used by the kst program. See documentation of kst for description.
105
106This format is used to store scalars, hence multivariate RVs must be separated.
107
108\subsection{Constructor \& Destructor Documentation}
109\hypertarget{classbdm_1_1dirfilelog_534cdc903068764f1f243ae8fc0316a3}{
110\index{bdm::dirfilelog@{bdm::dirfilelog}!dirfilelog@{dirfilelog}}
111\index{dirfilelog@{dirfilelog}!bdm::dirfilelog@{bdm::dirfilelog}}
112\subsubsection[dirfilelog]{\setlength{\rightskip}{0pt plus 5cm}bdm::dirfilelog::dirfilelog (std::string {\em dirname0}, \/  int {\em maxlen0})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
113\label{classbdm_1_1dirfilelog_534cdc903068764f1f243ae8fc0316a3}
114
115
116Default constructor.
117
118\begin{Desc}
119\item[Parameters:]
120\begin{description}
121\item[{\em dirname0}]name of the directory in which to store the results \item[{\em maxlen0}]length of the memory buffers, when full the buffers will be dumped to HDD and returned to the beginning. \end{description}
122\end{Desc}
123
124
125\subsection{Member Function Documentation}
126\hypertarget{classbdm_1_1dirfilelog_f595c0df25f5fa5d8c27ea1e375d9c51}{
127\index{bdm::dirfilelog@{bdm::dirfilelog}!write\_\-buffers@{write\_\-buffers}}
128\index{write\_\-buffers@{write\_\-buffers}!bdm::dirfilelog@{bdm::dirfilelog}}
129\subsubsection[write\_\-buffers]{\setlength{\rightskip}{0pt plus 5cm}void bdm::dirfilelog::write\_\-buffers (int {\em Len})}}
130\label{classbdm_1_1dirfilelog_f595c0df25f5fa5d8c27ea1e375d9c51}
131
132
133Write memory storage to disk.
134
135\begin{Desc}
136\item[Parameters:]
137\begin{description}
138\item[{\em Len}]length of buffer to be written, if 0 the file is truncated at 0. \end{description}
139\end{Desc}
140
141
142References dirname, bdm::logger::entries, bdm::memlog::maxlen, scalarnames, and bdm::memlog::vectors.
143
144Referenced by finalize(), init(), and step().
145
146The documentation for this class was generated from the following files:\begin{CompactItemize}
147\item 
148\hyperlink{loggers_8h}{loggers.h}\item 
149loggers.cpp\end{CompactItemize}
Note: See TracBrowser for help on using the browser.