EFC_std.h File Reference

Interface to the routines that size and construct a standard EFC configuration. More...

Typedefs
typedef struct _EFC	EFC
	Typedef for struct _EFC.
typedef struct _EFC_DB_Schema	EFC_DB_Schema
typedef struct _EFC_definition	EFC_definition
typedef struct _EDS_fw	EDS_fw
typedef struct _EDS_fwHandlerServicesX1	EDS_fwHandlerServicesX1
typedef struct _LSD_sdiWriteCbp	LSD_sdiWriteCbp
Functions
int	EFC_stdSizeof (const EFC_DB_Schema *schema, const EFC_definition *def, int efa_pkt_cnt)
	Convenience routine to compute the size, in bytes, when the user is content with the standard setup.
const EDS_fwHandlerServicesX1 *	EFC_stdConstruct (EFC *efc, unsigned int handler_id, const EFC_DB_Schema *schema, unsigned int schema_key, LSD_sdiWriteCbp *write, EDS_fw *edsFw, const EFC_definition *def, unsigned int fw_objects, unsigned int fw_needs, int efa_pkt_cnt)
	Convenience routine to construct the standard configuration.

---

Detailed Description

Interface to the routines that size and construct a standard EFC configuration.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: EFC_std.h,v 1.1 2007/10/10 23:40:42 russell Exp $

This is purely a set of convenience routines that package a standard set of operations. These routines make use of no special knowledge about EFC, i.e. anything done here could be done in any other package that wishes to draw on the services of EFC.

While this is convenient, it does force the caller into using EFS as the analysis package.

---

Function Documentation

const EDS_fwHandlerServicesX1 * EFC_stdConstruct	(	EFC *	efc,
		unsigned int	handler_id,
		const EFC_DB_Schema *	schema,
		unsigned int	schema_key,
		LSD_sdiWriteCbp *	write,
		EDS_fw *	edsFw,
		const EFC_definition *	definition,
		unsigned int	fw_objects,
		unsigned int	fw_needs,
		int	efa_cnt
	)

Convenience routine to construct the standard configuration.

Returns:

The set of EDS_fw services

Parameters:

	efc	The Event Filter Control block to initialize
	handler_id	The id (EFC_DB_id) of this handler. This is used as an offset to the base value of the EFS datagram identifier
	schema	Pointer to the schema of the filter configuration file
	schema_key	The file (FMX) key of the schema
	write	The output write routine + parameter
	edsFw	The controlling EDS framework handle
	definition	The defining information for this filter
	fw_objects	The list of EDS framework objects used by this filter
	fw_needs	The list of EDS needs for this filter.
	efa_cnt	Number of result vectors to gather before submitting them to the analysis services

This bundles setting up the filter and analysis handles. There is nothing magical going on here, it is purely for convenience. The main limitation is that the standard package uses EFS for the analysis.

References EFA_construct(), EFC_construct(), EFC_get(), EFC_OBJECT_K_EFA, EFC_sizeof(), _EFC_sizes::result, and _EFC_definition::sizes.

int EFC_stdSizeof	(	const EFC_DB_Schema *	schema,
		const EFC_definition *	def,
		int	efa_cnt
	)

Convenience routine to compute the size, in bytes, when the user is content with the standard setup.

Returns:

The size, in bytes, of the standard setup

Parameters:

	schema	The handler database schema
	def	The handler defintion
	efa_cnt	Number of result vectors to gather before submitting them to the analysis services

References EFA_sizeof(), EFC_sizeof(), _EFC_sizes::result, and _EFC_definition::sizes.