xfc.h File Reference

Filter interface definitions. More...

#include "EDS/TMR.h"
#include "EDS/EDS_fwServices.h"
#include "EDS/LCBV.h"
#include "EDS/io/EBF_stream.h"
#include "EDS/io/LCBP.h"

Include dependency graph for xfc.h:

This graph shows which files directly or indirectly include this file:


Data Structures
struct	_XfcFilterHandle
Typedefs
typedef int(*	XfcResultsPrintRtn )(unsigned int options, const void beg, const void end)
typedef void(*	XfcStatsAccumulateRtn )(void stats, const void beg, const void *end)
typedef void(*	XfcStatsPrintRtn )(void *stats, unsigned int vetoes)
typedef void(*	XfcStatsClearRtn )(void *stats)
typedef _XfcFilterHandle	XfcFilterHandle
Functions
int	xfc_initialize (void)
	One time initialization routine.
int	xfc_process (int id, const XfcRto rto, const EDS_DB_HandlerConstructServices services)
	Common routine to do the processing.
int	xfc_sizeof (XfcConstructCtx ctx, const EFC_definition def, const EFC_DB_Schema *schema, int stats_size)
	Computes the size needed to hold configuration defined by the specified context, definition block and schema.
const EDS_fwHandlerServicesX1 *	xfc_construct (XfcConstructCtx ctx, EFC efc, unsigned int handler_id, const EFC_DB_Schema schema, unsigned int schema_key, EDS_fw edsFw, unsigned int objects, unsigned int needs, XfcResultsPrintRtn resultsPrint, XfcStatsClearRtn statsClear, XfcStatsAccumulateRtn statsAcc, XfcStatsPrintRtn statsPrint)
	Constructs the configuration for the specified set of parameters.
void	xfc_display (XfcCtx ctx, unsigned int pktBytes, EBF_pkt pkt, EBF_siv siv, EDS_fwIxb *ixb)
	Displays the requested subsystems.
int	xfc_any_display (const XfcCtx *ctx)
	Returns non-zero if there are any subsystems to display that need a directory.
void	xfc_begtick_set (XfcCtx *ctx, TMR_tick tick)
	Seeds the beginning tick of this sample.
void	xfc_endtick_set (XfcCtx *ctx, TMR_tick tick)
	Seeds the ending tick of this sample.
void *	xfc_filterCtx_get (const XfcCtx *ctx)
	Returns a pointer to the underlying user filter control structure.
void *	xfc_resultsCtx_get (const XfcCtx *ctx)
	Returns a pointer to the results control structure.
void *	xfc_statsCtx_get (const XfcCtx *ctx)
	Returns a pointer to the statistics control structure.
void	xfc_results_post (XfcCtx ctx, int reason, const void beg, const void end, const EFA_span span)
	Dummy result vector post routine.
int	xfc_results_start (XfcCtx *ctx, int reason, int run_id, int startTime, int mode)
	Handles the start run for the result analysis.
void	xfc_results_print (XfcCtx ctx, const void beg, const void *end)
	Prints the standard part of the results, then calls the filter specific piece.
unsigned int	xfc_objects_get (const XfcCtx *ctx)
	Used to supply any additional EDS_fw objects needed by this filter context.
unsigned int	xfc_needs_get (const XfcCtx *ctx)
	Used to supply any additional EDS_fw needs for this filter context.

Detailed Description

Filter interface definitions.

Author:: JJRussell - russell@slac.stanford.edu

   CVS $Id: xfc.h,v 1.1 2007/10/17 02:12:28 russell Exp $

Function Documentation

int xfc_any_display ( const XfcCtx * ctx )

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

Parameters:

ctx The filter context parameter

void xfc_begtick_set ( XfcCtx * ctx,

TMR_tick tick

)

Seeds the beginning tick of this sample.

Parameters:

ctx The xfc context

tick The beginning tick value

const EDS_fwHandlerServices xfc_construct ( XfcConstructCtx * ctxx,

EFC * efc,

unsigned int handler_id,

const EFC_DB_Schema * schema,

unsigned int schema_key,

EDS_fw * edsFw,

unsigned int objects,

unsigned int needs,

XfcResultsPrintRtn resultsPrint,

XfcStatsClearRtn statsClear,

XfcStatsAccumulateRtn statsAcc,

XfcStatsPrintRtn statsPrint

)

Constructs the configuration for the specified set of parameters.
!!!results;

void void xfc_display ( XfcCtx * ctx,

unsigned int pktBytes,

EBF_pkt * pkt,

EBF_siv siv,

EDS_fwIxb * ixb

)

Displays the requested subsystems.

Parameters:

ctx The filter context

pktBytes The number of bytes in the packet

pkt The event data packet

siv The packet state information vector

ixb The EDS information exchange block

void xfc_endtick_set ( XfcCtx * ctx,

TMR_tick tick

)

Seeds the ending tick of this sample.

Parameters:

ctx The xfc context

tick The ending tick value

void * xfc_filterCtx_get ( const XfcCtx * ctx )

Returns a pointer to the underlying user filter control structure.

Returns:
A pointer to the underlying user filter control structure

Parameters:

ctx The filter control context

int xfc_initialize ( void )

One time initialization routine.

Returns:
Status

unsigned int xfc_needs_get ( const XfcCtx * ctx )

Used to supply any additional EDS_fw needs for this filter context.

Returns:
Bit mask of the addition objects

Parameters:

ctx The filter context handle

unsigned int xfc_objects_get ( const XfcCtx * ctx )

Used to supply any additional EDS_fw objects needed by this filter context.

Returns:
Bit mask of the addition objects

Parameters:

ctx The filter context handle

int xfc_process ( int id,

const XfcRto * rto,

const EDS_DB_HandlerConstructServices * services

)

Common routine to do the processing.

Parameters:

id The EFC_DB_id of this filter

rto The runtime options structure

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 rto will be used.

Returns:
Status

void xfc_results_post ( XfcCtx * ctx,

int reason,

const void * beg,

const void * end,

const EFA_span * span

)

Dummy result vector post routine.

Parameters:

ctx The xfc context

reason The posting reason

beg The first result vector

end The last result vector (actually one past the last one)

span The span of the sample

void xfc_results_print ( XfcCtx * ctx,

const void * beg,

const void * end

)

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

Parameters:

ctx The xfc context

beg Pointer to the first filter specific result vector

end Pointer to the last filter specific result vector

int xfc_results_start ( XfcCtx * ctx,

int reason,

int run_id,

int startTime,

int mode

)

Handles the start run for the result analysis.

Return values:

==0,if successfully started

!=0,if not successfully started

Parameters:

ctx The callback context parameter

reason The LSF_REASON_OPEN to indicate why the stream is being started

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

startTime The run start time rounded to the nearest second

mode This must be the running mode.

void * xfc_resultsCtx_get ( const XfcCtx * ctx )

Returns a pointer to the results control structure.

Returns:
A pointer to the results control structure

Parameters:

ctx The filter control context

int xfc_sizeof ( XfcConstructCtx * ctxx,

const EFC_definition * def,

const EFC_DB_Schema * schema,

int stats_size

)

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

Returns:
The size, in bytes,

Parameters:

ctxx The filter control construction context

def The EFC definition block

schema The defining schema

stats_size The size, in bytes, of one statistics buffer

void * xfc_statsCtx_get ( const XfcCtx * ctx )

Returns a pointer to the statistics control structure.

Returns:
A pointer to the statistics control structure

Parameters:

ctx The filter control context

Generated on Sun Jun 14 02:14:15 2009 by

1.4.4

xfc.h File Reference

Data Structures

Typedefs

Functions

Detailed Description

Function Documentation