c3aec878e5
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@40 331e1502-861f-0410-8da2-ba01fb791d7f
66 lines
2.3 KiB
TeX
66 lines
2.3 KiB
TeX
\section{eo\-Monitor Class Reference}
|
|
\label{classeo_monitor}\index{eoMonitor@{eoMonitor}}
|
|
The abstract monitor class is a std::vector of parameter pointers.
|
|
|
|
|
|
{\tt \#include $<$eo\-Monitor.h$>$}
|
|
|
|
Inheritance diagram for eo\-Monitor::\begin{figure}[H]
|
|
\begin{center}
|
|
\leavevmode
|
|
\includegraphics[height=2.5641cm]{classeo_monitor}
|
|
\end{center}
|
|
\end{figure}
|
|
\subsection*{Public Member Functions}
|
|
\begin{CompactItemize}
|
|
\item
|
|
virtual void {\bf last\-Call} ()\label{classeo_monitor_a0}
|
|
|
|
\item
|
|
virtual void {\bf add} (const {\bf eo\-Param} \&\_\-param)
|
|
\begin{CompactList}\small\item\em Adds a parameter to the monitor. \item\end{CompactList}\item
|
|
virtual std::string {\bf class\-Name} (void) const \label{classeo_monitor_a2}
|
|
|
|
\end{CompactItemize}
|
|
\subsection*{Protected Types}
|
|
\begin{CompactItemize}
|
|
\item
|
|
typedef std::vector$<$ const {\bf eo\-Param} $\ast$ $>$::iterator {\bf iterator}\label{classeo_monitor_x0}
|
|
|
|
\end{CompactItemize}
|
|
\subsection*{Protected Attributes}
|
|
\begin{CompactItemize}
|
|
\item
|
|
std::vector$<$ const {\bf eo\-Param} $\ast$ $>$ {\bf vec}\label{classeo_monitor_p0}
|
|
|
|
\end{CompactItemize}
|
|
|
|
|
|
\subsection{Detailed Description}
|
|
The abstract monitor class is a std::vector of parameter pointers.
|
|
|
|
Use either push\_\-back a pointer or add a reference to a parameter. Derived classes will then implement the {\bf operator()(void)}{\rm (p.\,\pageref{classeo_f_a1})} which will stream or pipe the current values of the parameters to wherever you want it streamed or piped to.
|
|
|
|
|
|
|
|
Definition at line 46 of file eo\-Monitor.h.
|
|
|
|
\subsection{Member Function Documentation}
|
|
\index{eoMonitor@{eo\-Monitor}!add@{add}}
|
|
\index{add@{add}!eoMonitor@{eo\-Monitor}}
|
|
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void eo\-Monitor::add (const {\bf eo\-Param} \& {\em \_\-param})\hspace{0.3cm}{\tt [inline, virtual]}}\label{classeo_monitor_a1}
|
|
|
|
|
|
Adds a parameter to the monitor.
|
|
|
|
It is virtual so you can do some type checking in derived classes if you must.
|
|
|
|
Reimplemented in {\bf eo\-FDCFile\-Snapshot$<$ EOT $>$} {\rm (p.\,\pageref{classeo_f_d_c_file_snapshot_a1})}, and {\bf eo\-File\-Snapshot} {\rm (p.\,\pageref{classeo_file_snapshot_a9})}.
|
|
|
|
Definition at line 56 of file eo\-Monitor.h.
|
|
|
|
Referenced by eo\-File\-Snapshot::add().
|
|
|
|
The documentation for this class was generated from the following file:\begin{CompactItemize}
|
|
\item
|
|
eo\-Monitor.h\end{CompactItemize}
|