\hypertarget{xfc_8h}{
\section{xfc.h File Reference}
\label{xfc_8h}\index{xfc.h@{xfc.h}}
}
Filter interface definitions.  


{\tt \#include $<$EDS/TMR.h$>$}\par
{\tt \#include $<$EDS/EDS\_\-fwServices.h$>$}\par
{\tt \#include $<$EDS/LCBV.h$>$}\par
{\tt \#include $<$EDS/io/EBF\_\-stream.h$>$}\par
{\tt \#include $<$EDS/io/LCBP.h$>$}\par
\subsection*{Classes}
\begin{CompactItemize}
\item 
struct \textbf{\_\-XfcFilterHandle}
\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{xfc_8h_76a1f90c9ac552662ad5a3c7f47f8844}{
typedef void $\ast$($\ast$ \textbf{XfcCfgGetRtn} )(void $\ast$ftx)}
\label{xfc_8h_76a1f90c9ac552662ad5a3c7f47f8844}

\item 
\hypertarget{xfc_8h_8c7ae99013e68cf32488dd06c15261f6}{
typedef int($\ast$ \textbf{XfcResultsPrintRtn} )(unsigned int options, const void $\ast$beg, const void $\ast$end)}
\label{xfc_8h_8c7ae99013e68cf32488dd06c15261f6}

\item 
\hypertarget{xfc_8h_550b345dcaabeb3b56c16dca9a586590}{
typedef void($\ast$ \textbf{XfcStatsAccumulateRtn} )(void $\ast$stats, const void $\ast$beg, const void $\ast$end)}
\label{xfc_8h_550b345dcaabeb3b56c16dca9a586590}

\item 
\hypertarget{xfc_8h_719c71af35f04c53c1cf7d72b55cf3f6}{
typedef void($\ast$ \textbf{XfcStatsPrintRtn} )(void $\ast$cfg, void $\ast$stats, unsigned int vetoes)}
\label{xfc_8h_719c71af35f04c53c1cf7d72b55cf3f6}

\item 
\hypertarget{xfc_8h_639a6f3dc4e9c311bc2d37c88d35e173}{
typedef void($\ast$ \textbf{XfcStatsClearRtn} )(void $\ast$stats)}
\label{xfc_8h_639a6f3dc4e9c311bc2d37c88d35e173}

\item 
\hypertarget{xfc_8h_1a75c5593a726e01224ed1cb37faef2b}{
typedef struct \_\-XfcFilterHandle \textbf{XfcFilterHandle}}
\label{xfc_8h_1a75c5593a726e01224ed1cb37faef2b}

\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
int \hyperlink{xfc_8h_69de20a22e9b4d56a40320357f0112c0}{xfc\_\-initialize} (void)
\begin{CompactList}\small\item\em One time initialization routine. \item\end{CompactList}\item 
int \hyperlink{xfc_8h_a253b27520b8bc2c2cb9afe21a4d686d}{xfc\_\-process} (int id, const \hyperlink{struct__XfcRto}{XfcRto} $\ast$rto, const EDS\_\-DB\_\-HandlerConstructServices $\ast$services)
\begin{CompactList}\small\item\em Common routine to do the processing. \item\end{CompactList}\item 
int \hyperlink{xfc_8h_8c97c3a00c9dd67ab69332f82a16d5c0}{xfc\_\-sizeof} (\hyperlink{struct__XfcConstructCtx}{XfcConstructCtx} $\ast$ctx, const EFC\_\-definition $\ast$def, const EFC\_\-DB\_\-Schema $\ast$schema, int stats\_\-size)
\begin{CompactList}\small\item\em Computes the size needed to hold configuration defined by the specified context, definition block and schema. \item\end{CompactList}\item 
const EDS\_\-fwHandlerServicesX1 $\ast$ \hyperlink{xfc_8h_f43a1124ebf677e0181e9a2f275aa7d6}{xfc\_\-construct} (\hyperlink{struct__XfcConstructCtx}{XfcConstructCtx} $\ast$ctx, EFC $\ast$efc, unsigned int handler\_\-id, const EFC\_\-DB\_\-Schema $\ast$schema, unsigned int schema\_\-key, EDS\_\-fw $\ast$edsFw, unsigned int objects, unsigned int needs, XfcResultsPrintRtn resultsPrint, XfcStatsClearRtn statsClear, XfcStatsAccumulateRtn statsAcc, XfcStatsPrintRtn statsPrint, void $\ast$statsPrintCtx)
\begin{CompactList}\small\item\em Constructs the configuration for the specified set of parameters. \item\end{CompactList}\item 
void \hyperlink{xfc_8h_1425556bcf527a429a96db58b681ad6b}{xfc\_\-display} (\hyperlink{struct__XfcCtx}{XfcCtx} $\ast$ctx, unsigned int pktBytes, EBF\_\-pkt $\ast$pkt, EBF\_\-siv siv, EDS\_\-fwIxb $\ast$ixb)
\begin{CompactList}\small\item\em Displays the requested subsystems. \item\end{CompactList}\item 
int \hyperlink{xfc_8h_658f303a33a1f9bec98dc3ecb1156b7a}{xfc\_\-any\_\-display} (const \hyperlink{struct__XfcCtx}{XfcCtx} $\ast$ctx)
\begin{CompactList}\small\item\em Returns non-zero if there are any subsystems to display that need a directory. \item\end{CompactList}\item 
void \hyperlink{xfc_8h_31ce821780297f71b1376391e98e727f}{xfc\_\-begtick\_\-set} (\hyperlink{struct__XfcCtx}{XfcCtx} $\ast$ctx, TMR\_\-tick tick)
\begin{CompactList}\small\item\em Seeds the beginning tick of this sample. \item\end{CompactList}\item 
void \hyperlink{xfc_8h_0687f715084e4538adfa8c28aa43c282}{xfc\_\-endtick\_\-set} (\hyperlink{struct__XfcCtx}{XfcCtx} $\ast$ctx, TMR\_\-tick tick)
\begin{CompactList}\small\item\em Seeds the ending tick of this sample. \item\end{CompactList}\item 
void $\ast$ \hyperlink{xfc_8h_9e19b50fe2b75198ff66e6046affcbae}{xfc\_\-filterCtx\_\-get} (const \hyperlink{struct__XfcCtx}{XfcCtx} $\ast$ctx)
\begin{CompactList}\small\item\em Returns a pointer to the underlying user filter control structure. \item\end{CompactList}\item 
void $\ast$ \hyperlink{xfc_8h_7b65c2629519c392d3c74e123bc2265e}{xfc\_\-resultsCtx\_\-get} (const \hyperlink{struct__XfcCtx}{XfcCtx} $\ast$ctx)
\begin{CompactList}\small\item\em Returns a pointer to the results control structure. \item\end{CompactList}\item 
void $\ast$ \hyperlink{xfc_8h_e1ae533365bf4444aaef76966312e20a}{xfc\_\-statsCtx\_\-get} (const \hyperlink{struct__XfcCtx}{XfcCtx} $\ast$ctx)
\begin{CompactList}\small\item\em Returns a pointer to the statistics control structure. \item\end{CompactList}\item 
void \hyperlink{xfc_8h_44e4df2d00c6f280bfe0f4a697a42776}{xfc\_\-results\_\-post} (\hyperlink{struct__XfcCtx}{XfcCtx} $\ast$ctx, int reason, const void $\ast$beg, const void $\ast$end, const EFA\_\-span $\ast$span)
\begin{CompactList}\small\item\em Dummy result vector post routine. \item\end{CompactList}\item 
int \hyperlink{xfc_8h_4d12d478b5701f168a377964b7d25cb8}{xfc\_\-results\_\-start} (\hyperlink{struct__XfcCtx}{XfcCtx} $\ast$ctx, int reason, int run\_\-id, int startTime, int mode)
\begin{CompactList}\small\item\em Handles the start run for the result analysis. \item\end{CompactList}\item 
void \hyperlink{xfc_8h_2ade9050b6e50e99744d5d7f3186b15a}{xfc\_\-results\_\-print} (\hyperlink{struct__XfcCtx}{XfcCtx} $\ast$ctx, const void $\ast$beg, const void $\ast$end)
\begin{CompactList}\small\item\em Prints the standard part of the results, then calls the filter specific piece. \item\end{CompactList}\item 
unsigned int \hyperlink{xfc_8h_188060f34cdd46fbe75e337d2e8b5e4a}{xfc\_\-objects\_\-get} (const \hyperlink{struct__XfcCtx}{XfcCtx} $\ast$ctx)
\begin{CompactList}\small\item\em Used to supply any additional EDS\_\-fw objects needed by this filter context. \item\end{CompactList}\item 
unsigned int \hyperlink{xfc_8h_7c1010e6ca101dfb45c9cb75d5ea94e3}{xfc\_\-needs\_\-get} (const \hyperlink{struct__XfcCtx}{XfcCtx} $\ast$ctx)
\begin{CompactList}\small\item\em Used to supply any additional EDS\_\-fw needs for this filter context. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Filter interface definitions. 

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


\footnotesize\begin{verbatim}

   CVS $Id: xfc.h,v 1.2 2011/03/28 20:51:00 russell Exp $
\end{verbatim}
\normalsize
 

\subsection{Function Documentation}
\hypertarget{xfc_8h_658f303a33a1f9bec98dc3ecb1156b7a}{
\index{xfc.h@{xfc.h}!xfc\_\-any\_\-display@{xfc\_\-any\_\-display}}
\index{xfc\_\-any\_\-display@{xfc\_\-any\_\-display}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-any\_\-display}]{\setlength{\rightskip}{0pt plus 5cm}int xfc\_\-any\_\-display (const {\bf XfcCtx} $\ast$ {\em ctx})}}
\label{xfc_8h_658f303a33a1f9bec98dc3ecb1156b7a}


Returns non-zero if there are any subsystems to display that need a directory. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctx}]The filter context parameter \end{description}
\end{Desc}


References \_\-XfcCtx::displayer, and \_\-XfcDisplayerCtx::printCtl.\hypertarget{xfc_8h_31ce821780297f71b1376391e98e727f}{
\index{xfc.h@{xfc.h}!xfc\_\-begtick\_\-set@{xfc\_\-begtick\_\-set}}
\index{xfc\_\-begtick\_\-set@{xfc\_\-begtick\_\-set}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-begtick\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}void xfc\_\-begtick\_\-set ({\bf XfcCtx} $\ast$ {\em ctx}, \/  TMR\_\-tick {\em tick})}}
\label{xfc_8h_31ce821780297f71b1376391e98e727f}


Seeds the beginning tick of this sample. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctx}]The xfc context \item[{\em tick}]The beginning tick value \end{description}
\end{Desc}


References \_\-XfcCtx::tickBeg.

Referenced by xfc\_\-results\_\-post().\hypertarget{xfc_8h_f43a1124ebf677e0181e9a2f275aa7d6}{
\index{xfc.h@{xfc.h}!xfc\_\-construct@{xfc\_\-construct}}
\index{xfc\_\-construct@{xfc\_\-construct}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-construct}]{\setlength{\rightskip}{0pt plus 5cm}const EDS\_\-fwHandlerServices xfc\_\-construct ({\bf XfcConstructCtx} $\ast$ {\em ctxx}, \/  EFC $\ast$ {\em efc}, \/  unsigned int {\em handler\_\-id}, \/  const EFC\_\-DB\_\-Schema $\ast$ {\em schema}, \/  unsigned int {\em schema\_\-key}, \/  EDS\_\-fw $\ast$ {\em edsFw}, \/  unsigned int {\em objects}, \/  unsigned int {\em needs}, \/  XfcResultsPrintRtn {\em resultsPrint}, \/  XfcStatsClearRtn {\em statsClear}, \/  XfcStatsAccumulateRtn {\em statsAcc}, \/  XfcStatsPrintRtn {\em statsPrint}, \/  void $\ast$ {\em statsPrintCtx})}}
\label{xfc_8h_f43a1124ebf677e0181e9a2f275aa7d6}


Constructs the configuration for the specified set of parameters. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctxx}]Holds the run-time modifying context \item[{\em efc}]The controlling Event Filter's handle \item[{\em handler\_\-id}]The handler's identifier \item[{\em schema}]The defining schema. This must be what was passed to xfc\_\-sizeof (). \item[{\em schema\_\-key}]The (likely FMX) key of the schema \item[{\em edsFw}]The controlling EDS framework's handle \item[{\em objects}]The EDS framework objects needed by this filter \item[{\em needs}]The EDS framework service needs of this filter \item[{\em resultsPrint}]The filter specific result print routine \item[{\em statsClear}]The filter specific statistics buffer clear routine \item[{\em statsAcc}]The filter specific statistics accumulation routine \item[{\em statsPrint}]The fitler specific statistics print routine \item[{\em statsPrintCtx}]The filter specific statistics print routine context parameter \end{description}
\end{Desc}


!!!results; 

References \_\-XfcStatsCtx::acc, \_\-XfcStatsCtx::bufs, \_\-XfcSdi::cbp, \_\-XfcStatsCtx::clear, \_\-XfcConstructCtx::ctx, \_\-XfcHandlerCtx::def, \_\-XfcCtx::displayer, \_\-XfcHandlerCtx::efa\_\-post\_\-cnt, \_\-XfcHandlerCtx::efa\_\-size, \_\-XfcHandlerCtx::efc\_\-size, \_\-XfcCtx::efcCtx, \_\-XfcResultsCtx::efs, \_\-XfcHandlerCtx::efs\_\-size, \_\-XfcSdi::file, \_\-XfcEfcCtx::filterCtx, \_\-XfcCtx::handler, \_\-XfcCtx::nevts, \_\-XfcCtx::poster, \_\-XfcResultsCtx::print, \_\-XfcStatsCtx::print, \_\-XfcDisplayerCtx::print\_\-size, \_\-XfcDisplayerCtx::printCtl, \_\-XfcStatsCtx::printCtx, \_\-XfcHandlerCtx::results, \_\-XfcEfcCtx::resultsCtx, \_\-XfcPosterCtx::sdi, \_\-XfcResultsCtx::size, \_\-XfcStatsCtx::size, \_\-XfcDisplayerCtx::ss\_\-to\_\-print, \_\-XfcHandlerCtx::stats, \_\-XfcEfcCtx::statsCtx, xfc\_\-needs\_\-get(), xfc\_\-objects\_\-get(), xfc\_\-results\_\-post(), and xfc\_\-results\_\-start().\hypertarget{xfc_8h_1425556bcf527a429a96db58b681ad6b}{
\index{xfc.h@{xfc.h}!xfc\_\-display@{xfc\_\-display}}
\index{xfc\_\-display@{xfc\_\-display}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-display}]{\setlength{\rightskip}{0pt plus 5cm}void void xfc\_\-display ({\bf XfcCtx} $\ast$ {\em ctx}, \/  unsigned int {\em pktBytes}, \/  EBF\_\-pkt $\ast$ {\em pkt}, \/  EBF\_\-siv {\em siv}, \/  EDS\_\-fwIxb $\ast$ {\em ixb})}}
\label{xfc_8h_1425556bcf527a429a96db58b681ad6b}


Displays the requested subsystems. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctx}]The filter context \item[{\em pktBytes}]The number of bytes in the packet \item[{\em pkt}]The event data packet \item[{\em siv}]The packet state information vector \item[{\em ixb}]The EDS information exchange block \end{description}
\end{Desc}


References \_\-XfcCtx::displayer, \_\-XfcDisplayerCtx::printCtl, \_\-XfcDisplayerCtx::ss\_\-to\_\-display, \_\-XfcDisplayerCtx::ss\_\-to\_\-print, and \_\-XfcDisplayerCtx::to\_\-print.\hypertarget{xfc_8h_0687f715084e4538adfa8c28aa43c282}{
\index{xfc.h@{xfc.h}!xfc\_\-endtick\_\-set@{xfc\_\-endtick\_\-set}}
\index{xfc\_\-endtick\_\-set@{xfc\_\-endtick\_\-set}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-endtick\_\-set}]{\setlength{\rightskip}{0pt plus 5cm}void xfc\_\-endtick\_\-set ({\bf XfcCtx} $\ast$ {\em ctx}, \/  TMR\_\-tick {\em tick})}}
\label{xfc_8h_0687f715084e4538adfa8c28aa43c282}


Seeds the ending tick of this sample. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctx}]The xfc context \item[{\em tick}]The ending tick value \end{description}
\end{Desc}


References \_\-XfcCtx::tickEnd.

Referenced by xfc\_\-results\_\-post().\hypertarget{xfc_8h_9e19b50fe2b75198ff66e6046affcbae}{
\index{xfc.h@{xfc.h}!xfc\_\-filterCtx\_\-get@{xfc\_\-filterCtx\_\-get}}
\index{xfc\_\-filterCtx\_\-get@{xfc\_\-filterCtx\_\-get}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-filterCtx\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}void $\ast$ xfc\_\-filterCtx\_\-get (const {\bf XfcCtx} $\ast$ {\em ctx})}}
\label{xfc_8h_9e19b50fe2b75198ff66e6046affcbae}


Returns a pointer to the underlying user filter control structure. 

\begin{Desc}
\item[Returns:]A pointer to the underlying user filter control structure\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctx}]The filter control context \end{description}
\end{Desc}


References \_\-XfcCtx::efcCtx, and \_\-XfcEfcCtx::filterCtx.\hypertarget{xfc_8h_69de20a22e9b4d56a40320357f0112c0}{
\index{xfc.h@{xfc.h}!xfc\_\-initialize@{xfc\_\-initialize}}
\index{xfc\_\-initialize@{xfc\_\-initialize}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-initialize}]{\setlength{\rightskip}{0pt plus 5cm}int xfc\_\-initialize (void)}}
\label{xfc_8h_69de20a22e9b4d56a40320357f0112c0}


One time initialization routine. 

\begin{Desc}
\item[Returns:]Status \end{Desc}
\hypertarget{xfc_8h_7c1010e6ca101dfb45c9cb75d5ea94e3}{
\index{xfc.h@{xfc.h}!xfc\_\-needs\_\-get@{xfc\_\-needs\_\-get}}
\index{xfc\_\-needs\_\-get@{xfc\_\-needs\_\-get}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-needs\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int xfc\_\-needs\_\-get (const {\bf XfcCtx} $\ast$ {\em ctx})}}
\label{xfc_8h_7c1010e6ca101dfb45c9cb75d5ea94e3}


Used to supply any additional EDS\_\-fw needs for this filter context. 

\begin{Desc}
\item[Returns:]Bit mask of the addition objects\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctx}]The filter context handle \end{description}
\end{Desc}


References \_\-XfcPosterCtx::ctx, \_\-XfcCtx::displayer, \_\-XfcCtx::poster, and \_\-XfcDisplayerCtx::printCtl.

Referenced by xfc\_\-construct().\hypertarget{xfc_8h_188060f34cdd46fbe75e337d2e8b5e4a}{
\index{xfc.h@{xfc.h}!xfc\_\-objects\_\-get@{xfc\_\-objects\_\-get}}
\index{xfc\_\-objects\_\-get@{xfc\_\-objects\_\-get}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-objects\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int xfc\_\-objects\_\-get (const {\bf XfcCtx} $\ast$ {\em ctx})}}
\label{xfc_8h_188060f34cdd46fbe75e337d2e8b5e4a}


Used to supply any additional EDS\_\-fw objects needed by this filter context. 

\begin{Desc}
\item[Returns:]Bit mask of the addition objects\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctx}]The filter context handle \end{description}
\end{Desc}


References \_\-XfcPosterCtx::ctx, \_\-XfcCtx::displayer, \_\-XfcCtx::poster, and \_\-XfcDisplayerCtx::printCtl.

Referenced by xfc\_\-construct().\hypertarget{xfc_8h_a253b27520b8bc2c2cb9afe21a4d686d}{
\index{xfc.h@{xfc.h}!xfc\_\-process@{xfc\_\-process}}
\index{xfc\_\-process@{xfc\_\-process}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-process}]{\setlength{\rightskip}{0pt plus 5cm}int xfc\_\-process (int {\em id}, \/  const {\bf XfcRto} $\ast$ {\em rto}, \/  const EDS\_\-DB\_\-HandlerConstructServices $\ast$ {\em services})}}
\label{xfc_8h_a253b27520b8bc2c2cb9afe21a4d686d}


Common routine to do the processing. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em id}]The EFC\_\-DB\_\-id of this filter \item[{\em rto}]The runtime options structure \item[{\em services}]An alternative set of construction services, may be NULL, in which case the services resolved by the database schema and instance buried in the {\em rto\/} will be used. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]Status \end{Desc}


References \_\-XfcHandlerCtx::construction\_\-services, \_\-XfcCtx::ebf, \_\-XfcCtx::edsFw, \_\-XfcHandlerCtx::efc, \_\-XfcCtx::handler, \_\-XfcHandlerCtx::handler\_\-id, \_\-XfcRto::mode, \_\-XfcCtx::mode, \_\-XfcCtx::poster, \_\-XfcPosterCtx::sdi, xfc\_\-display\_\-build(), xfc\_\-edsFw\_\-build(), xfc\_\-istream\_\-build(), xfc\_\-run\_\-start(), xfc\_\-run\_\-stop(), and xfc\_\-time\_\-initialize().\hypertarget{xfc_8h_44e4df2d00c6f280bfe0f4a697a42776}{
\index{xfc.h@{xfc.h}!xfc\_\-results\_\-post@{xfc\_\-results\_\-post}}
\index{xfc\_\-results\_\-post@{xfc\_\-results\_\-post}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-results\_\-post}]{\setlength{\rightskip}{0pt plus 5cm}void xfc\_\-results\_\-post ({\bf XfcCtx} $\ast$ {\em ctx}, \/  int {\em reason}, \/  const void $\ast$ {\em beg}, \/  const void $\ast$ {\em end}, \/  const EFA\_\-span $\ast$ {\em span})}}
\label{xfc_8h_44e4df2d00c6f280bfe0f4a697a42776}


Dummy result vector post routine. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctx}]The xfc context \item[{\em reason}]The posting reason \item[{\em beg}]The first result vector \item[{\em end}]The last result vector (actually one past the last one) \item[{\em span}]The span of the sample \end{description}
\end{Desc}


References \_\-XfcStatsCtx::acc, \_\-XfcStatsCtx::bufs, \_\-XfcResultsCtx::efs, \_\-XfcCtx::handler, \_\-XfcResultsCtx::options, \_\-XfcStatsCtx::print, \_\-XfcStatsCtx::printCtx, \_\-XfcHandlerCtx::results, \_\-XfcHandlerCtx::stats, \_\-XfcResultsCtx::verbose, \_\-XfcResultsCtx::vetoes, xfc\_\-begtick\_\-set(), xfc\_\-endtick\_\-set(), and xfc\_\-results\_\-print().

Referenced by xfc\_\-construct().\hypertarget{xfc_8h_2ade9050b6e50e99744d5d7f3186b15a}{
\index{xfc.h@{xfc.h}!xfc\_\-results\_\-print@{xfc\_\-results\_\-print}}
\index{xfc\_\-results\_\-print@{xfc\_\-results\_\-print}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-results\_\-print}]{\setlength{\rightskip}{0pt plus 5cm}void xfc\_\-results\_\-print ({\bf XfcCtx} $\ast$ {\em ctx}, \/  const void $\ast$ {\em beg}, \/  const void $\ast$ {\em end})}}
\label{xfc_8h_2ade9050b6e50e99744d5d7f3186b15a}


Prints the standard part of the results, then calls the filter specific piece. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctx}]The xfc context \item[{\em beg}]Pointer to the first filter specific result vector \item[{\em end}]Pointer to the last filter specific result vector \end{description}
\end{Desc}


References \_\-XfcCtx::handler, \_\-XfcResultsCtx::options, \_\-XfcResultsCtx::print, printElapsed(), \_\-XfcHandlerCtx::results, \_\-XfcCtx::tickBeg, and \_\-XfcCtx::tickEnd.

Referenced by xfc\_\-results\_\-post().\hypertarget{xfc_8h_4d12d478b5701f168a377964b7d25cb8}{
\index{xfc.h@{xfc.h}!xfc\_\-results\_\-start@{xfc\_\-results\_\-start}}
\index{xfc\_\-results\_\-start@{xfc\_\-results\_\-start}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-results\_\-start}]{\setlength{\rightskip}{0pt plus 5cm}int xfc\_\-results\_\-start ({\bf XfcCtx} $\ast$ {\em ctx}, \/  int {\em reason}, \/  int {\em run\_\-id}, \/  int {\em startTime}, \/  int {\em mode})}}
\label{xfc_8h_4d12d478b5701f168a377964b7d25cb8}


Handles the start run for the result analysis. 

\begin{Desc}
\item[Return values:]
\begin{description}
\item[{\em ==0,if}]successfully started \item[{\em !=0,if}]not successfully started\end{description}
\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctx}]The callback context parameter \item[{\em reason}]The LSF\_\-REASON\_\-OPEN to indicate why the stream is being started \item[{\em run\_\-id}]Suggested use is to identify the block of events between when EDS\_\-fwHandlerStart is called and EDS\_\-fwHandlerFlush is called with a stop reason \item[{\em startTime}]The run start time rounded to the nearest second \item[{\em mode}]This must be the running mode. \end{description}
\end{Desc}


References \_\-XfcResultsCtx::efs, \_\-XfcCtx::handler, and \_\-XfcHandlerCtx::results.

Referenced by xfc\_\-construct().\hypertarget{xfc_8h_7b65c2629519c392d3c74e123bc2265e}{
\index{xfc.h@{xfc.h}!xfc\_\-resultsCtx\_\-get@{xfc\_\-resultsCtx\_\-get}}
\index{xfc\_\-resultsCtx\_\-get@{xfc\_\-resultsCtx\_\-get}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-resultsCtx\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}void $\ast$ xfc\_\-resultsCtx\_\-get (const {\bf XfcCtx} $\ast$ {\em ctx})}}
\label{xfc_8h_7b65c2629519c392d3c74e123bc2265e}


Returns a pointer to the results control structure. 

\begin{Desc}
\item[Returns:]A pointer to the results control structure\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctx}]The filter control context \end{description}
\end{Desc}


References \_\-XfcCtx::efcCtx, and \_\-XfcEfcCtx::resultsCtx.\hypertarget{xfc_8h_8c97c3a00c9dd67ab69332f82a16d5c0}{
\index{xfc.h@{xfc.h}!xfc\_\-sizeof@{xfc\_\-sizeof}}
\index{xfc\_\-sizeof@{xfc\_\-sizeof}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-sizeof}]{\setlength{\rightskip}{0pt plus 5cm}int xfc\_\-sizeof ({\bf XfcConstructCtx} $\ast$ {\em ctxx}, \/  const EFC\_\-definition $\ast$ {\em def}, \/  const EFC\_\-DB\_\-Schema $\ast$ {\em schema}, \/  int {\em stats\_\-size})}}
\label{xfc_8h_8c97c3a00c9dd67ab69332f82a16d5c0}


Computes the size needed to hold configuration defined by the specified context, definition block and schema. 

\begin{Desc}
\item[Returns:]The size, in bytes,\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctxx}]The filter control construction context \item[{\em def}]The EFC definition block \item[{\em schema}]The defining schema \item[{\em stats\_\-size}]The size, in bytes, of one statistics buffer \end{description}
\end{Desc}


References \_\-XfcConstructCtx::ctx, \_\-XfcHandlerCtx::def, \_\-XfcCtx::displayer, \_\-XfcHandlerCtx::efa\_\-post\_\-cnt, \_\-XfcHandlerCtx::efa\_\-size, \_\-XfcHandlerCtx::efc\_\-size, \_\-XfcHandlerCtx::efs\_\-size, \_\-XfcSdi::file, \_\-XfcCtx::handler, \_\-XfcCtx::poster, \_\-XfcDisplayerCtx::print\_\-size, RND8, \_\-XfcHandlerCtx::schema, \_\-XfcPosterCtx::sdi, \_\-XfcStatsCtx::size, \_\-XfcDisplayerCtx::ss\_\-to\_\-print, and \_\-XfcHandlerCtx::stats.\hypertarget{xfc_8h_e1ae533365bf4444aaef76966312e20a}{
\index{xfc.h@{xfc.h}!xfc\_\-statsCtx\_\-get@{xfc\_\-statsCtx\_\-get}}
\index{xfc\_\-statsCtx\_\-get@{xfc\_\-statsCtx\_\-get}!xfc.h@{xfc.h}}
\subsubsection[{xfc\_\-statsCtx\_\-get}]{\setlength{\rightskip}{0pt plus 5cm}void $\ast$ xfc\_\-statsCtx\_\-get (const {\bf XfcCtx} $\ast$ {\em ctx})}}
\label{xfc_8h_e1ae533365bf4444aaef76966312e20a}


Returns a pointer to the statistics control structure. 

\begin{Desc}
\item[Returns:]A pointer to the statistics control structure\end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em ctx}]The filter control context \end{description}
\end{Desc}


References \_\-XfcCtx::efcCtx, and \_\-XfcEfcCtx::statsCtx.