\hypertarget{ESX_8h}{
\section{ESX.h File Reference}
\label{ESX_8h}\index{ESX.h@{ESX.h}}
}
Event Stream Extract tools. 



This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=84pt]{ESX_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{ESX_8h_a0}{
typedef \hyperlink{struct__ESX__ctl}{\_\-ESX\_\-ctl} \hyperlink{ESX_8h_a0}{ESX\_\-ctl}}
\label{ESX_8h_a0}

\begin{CompactList}\small\item\em Typedef for struct \hyperlink{struct__ESX__ctl}{\_\-ESX\_\-ctl}. \item\end{CompactList}\item 
\hypertarget{ESX_8h_a1}{
typedef \hyperlink{struct__EBF__dir}{\_\-EBF\_\-dir} {\bf EBF\_\-dir}}
\label{ESX_8h_a1}

\item 
\hypertarget{ESX_8h_a2}{
typedef \hyperlink{struct__EBF__stream}{\_\-EBF\_\-stream} {\bf EBF\_\-stream}}
\label{ESX_8h_a2}

\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
\hypertarget{ESX_8h_a3}{
unsigned int {\bf ESX\_\-sizeof} (void)}
\label{ESX_8h_a3}

\item 
\hypertarget{ESX_8h_a4}{
void {\bf ESX\_\-construct} (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$esx)}
\label{ESX_8h_a4}

\item 
\hypertarget{ESX_8h_a5}{
unsigned int {\bf ESX\_\-establish} (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$esx)}
\label{ESX_8h_a5}

\item 
\hypertarget{ESX_8h_a6}{
unsigned int {\bf ESX\_\-set\_\-verbose} (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$esx, unsigned int verbose)}
\label{ESX_8h_a6}

\item 
\hypertarget{ESX_8h_a7}{
void {\bf ESX\_\-parse\_\-oname} (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$esx, const char $\ast$s)}
\label{ESX_8h_a7}

\item 
\hypertarget{ESX_8h_a8}{
void {\bf ESX\_\-parse\_\-ochunk} (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$esx, const char $\ast$s)}
\label{ESX_8h_a8}

\item 
\hypertarget{ESX_8h_a9}{
void {\bf ESX\_\-parse\_\-ichunk} (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$esx, const char $\ast$s)}
\label{ESX_8h_a9}

\item 
\hypertarget{ESX_8h_a10}{
void {\bf ESX\_\-parse\_\-bsize} (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$esx, const char $\ast$s)}
\label{ESX_8h_a10}

\item 
\hypertarget{ESX_8h_a11}{
void {\bf ESX\_\-parse\_\-osize} (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$esx, const char $\ast$s)}
\label{ESX_8h_a11}

\item 
int \hyperlink{ESX_8h_a12}{ESX\_\-evt\_\-declare} (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$esx)
\begin{CompactList}\small\item\em Declares an input event has been seen. This information is used to determine whether to trigger the creation of a new output file. \item\end{CompactList}\item 
int \hyperlink{ESX_8h_a13}{ESX\_\-dir\_\-write} (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$esx, \hyperlink{struct__EBF__dir}{EBF\_\-dir} $\ast$dir)
\begin{CompactList}\small\item\em Writes the event. \item\end{CompactList}\item 
void \hyperlink{ESX_8h_a14}{ESX\_\-close} (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$esx)
\begin{CompactList}\small\item\em Closes the output stream. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Event Stream Extract tools. 

\begin{Desc}
\item[Author:]JJRussell - \href{mailto:russell@slac.stanford.edu}{\tt russell@slac.stanford.edu}\end{Desc}


\footnotesize\begin{verbatim}   CVS $Id: ESX.h,v 1.1 2007/02/14 01:06:38 russell Exp $
\end{verbatim}
\normalsize


\subsection{Function Documentation}
\hypertarget{ESX_8h_a14}{
\index{ESX.h@{ESX.h}!ESX_close@{ESX\_\-close}}
\index{ESX_close@{ESX\_\-close}!ESX.h@{ESX.h}}
\subsubsection[ESX\_\-close]{\setlength{\rightskip}{0pt plus 5cm}void ESX\_\-close (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$ {\em esx})}}
\label{ESX_8h_a14}


Closes the output stream. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em esx}]The control block\end{description}
\end{Desc}
\hypertarget{ESX_8h_a13}{
\index{ESX.h@{ESX.h}!ESX_dir_write@{ESX\_\-dir\_\-write}}
\index{ESX_dir_write@{ESX\_\-dir\_\-write}!ESX.h@{ESX.h}}
\subsubsection[ESX\_\-dir\_\-write]{\setlength{\rightskip}{0pt plus 5cm}int ESX\_\-dir\_\-write (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$ {\em esx}, \hyperlink{struct__EBF__dir}{EBF\_\-dir} $\ast$ {\em dir})}}
\label{ESX_8h_a13}


Writes the event. 

\begin{Desc}
\item[Returns:]Status\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em esx}]The control structure \item[{\em dir}]The directory of the event to write out\end{description}
\end{Desc}
\hypertarget{ESX_8h_a12}{
\index{ESX.h@{ESX.h}!ESX_evt_declare@{ESX\_\-evt\_\-declare}}
\index{ESX_evt_declare@{ESX\_\-evt\_\-declare}!ESX.h@{ESX.h}}
\subsubsection[ESX\_\-evt\_\-declare]{\setlength{\rightskip}{0pt plus 5cm}int ESX\_\-evt\_\-declare (\hyperlink{struct__ESX__ctl}{ESX\_\-ctl} $\ast$ {\em esx})}}
\label{ESX_8h_a12}


Declares an input event has been seen. This information is used to determine whether to trigger the creation of a new output file. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em esx}]The control structure\end{description}
\end{Desc}
