HFC_dbConfigure.c File Reference

Uses an EDS_DB_schema to configure the Heavy Ion (CNO) filter. More...

#include <XFC/HFC.h>
#include <XFC/HFC_status.h>
#include <HFC_def.h>
#include <HFC_resultDef.h>
#include <EFC/EFC.h>
#include <EFC/EFC_std.h>
#include <EDS_DB/EDS_DB_schema.h>

Functions
static int	hfc_sizeof (const EFC_DB_Schema *schema, void *prm)
	Computes the size needed to hold configuration defined by the specified schema.
static const EDS_fwHandlerServicesX1 *	hfc_construct (EFC *efc, unsigned int handler_id, const EFC_DB_Schema *schema, unsigned int schema_key, LSD_sdiWriteCbp *write, EDS_fw *edsFw)
	Constructs the configuration for the specified set of parameters.
const EDS_DB_HandlerConstructServices *	HFC_constructServicesGet (unsigned int prm)
	Returns a pointer to the services vector.
Variables
static const EFC_definition	Hfc_Definition
	The defining parameters for this filter.

---

Detailed Description

Uses an EDS_DB_schema to configure the Heavy Ion (CNO) filter.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: HFC_dbConfigure.c,v 1.4 2012/01/04 20:36:41 russell Exp $

---

Function Documentation

static const EDS_fwHandlerServicesX1 * hfc_construct	(	EFC *	efc,
		unsigned int	handler_id,
		const EFC_DB_Schema *	schema,
		unsigned int	schema_key,
		LSD_sdiWriteCbp *	write,
		EDS_fw *	edsFw
	)			[static]

Constructs the configuration for the specified set of parameters.

Parameters:

	efc	The controlling Event Filter's handle
	handler_id	Unique and static identifier for this handler. This value is used as the basis of many associate identifiers, such as datagrams.
	schema	The database schema
	schema_key	The handler's configuration key (likely FMX key)
	write	The optional, user supplied parameter is used to convey the datagram write routine.
	edsFw	The controlling EDS framework's handle

References Hfc_Definition, HFC_fwNeeds(), and HFC_fwObjects().

Referenced by HFC_constructServicesGet().

const EDS_DB_HandlerConstructServices HFC_constructServicesGet

(

unsigned int

prm

)

Returns a pointer to the services vector.

Returns:

A pointer to the services vector

This is the seed point for an EDS_DB, i.e. the database contains a string with the name of this routine. Using the CMX_lookupSymbol method (or some other equivalent method) the string is translated into the address of this routine.

The driving program is then expected to use this address to fetch a vector of 2 routines

1. A size routine, to determine the amount of storage this filter needs to define its control and configuration block
2. A construct routine, to fill in the control and configuration block.

References hfc_construct(), and hfc_sizeof().

static int hfc_sizeof	(	const EFC_DB_Schema *	schema,
		void *	prm
	)			[static]

Computes the size needed to hold configuration defined by the specified schema.

Returns:

The size, in bytes,

Parameters:

	schema	The defining schema
	prm	An optional, modifying parameter

References Hfc_Definition.

Referenced by HFC_constructServicesGet().

---

Variable Documentation

EFC_definition Hfc_Definition [static]

Initial value:

{
   
   {
    (EFC_servicesConstruct)HFC_cfgSchemaCompile, 
                                             
    (EFC_servicesFilter)  HFC_filter,        
    (EFC_servicesCfgSet)  HFC_cfgSet,        
    (EFC_servicesDestruct)NULL,              
    (EFC_servicesReport)  NULL,              
  },

  
  {
    sizeof (HFC),             
    sizeof (HFC_cfg),         
    sizeof (HFC_result)       
  },

  
  {
      HFC_STATUS_M_INFO | HFC_STATUS_M_PASSES | HFC_STATUS_M_VETOES,
      HFC_STATUS_M_VETOES,
      HFC_STATUS_M_PASSES,
      HFC_STATUS_M_INFO
  }

}

The defining parameters for this filter.

Referenced by hfc_construct(), and hfc_sizeof().