GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > EFC / V4-1-1

Constituent: igfc     Tag: linux-gcc


Interface   Data Structures   File List   Data Fields   Globals  

GFC_dbConfigure.c File Reference

Uses an EDS_DB_schema to configure the Minimum Ionizing Particle (MIP) filter. More...

#include "EFC/EFC.h"
#include "EFC/EFC_std.h"
#include "EFC/GFC.h"
#include "EFC/GFC_status.h"
#include "GFC_def.h"
#include "GFC_resultDef.h"
#include "EDS_DB/EDS_DB_schema.h"

Include dependency graph for GFC_dbConfigure.c:


Functions

static int gfc_sizeof (const EFC_DB_Schema *schema, void *prm)
 Computes the size needed to hold configuration defined by the specified schema.
static const EDS_fwHandlerServicesX1 * gfc_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 * GFC_constructServicesGet (unsigned int prm)
 Returns a pointer to the services vector.

Variables

static const EFC_definition Gfc_Definition
 The defining parameters for this filter.

Detailed Description

Uses an EDS_DB_schema to configure the Minimum Ionizing Particle (MIP) filter.

Author:
JJRussell - russell@slac.stanford.edu
   CVS $Id: GFC_dbConfigure.c,v 1.6 2007/10/10 23:40:43 russell Exp $

Function Documentation

static const EDS_fwHandlerServicesX1 * gfc_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

const EDS_DB_HandlerConstructServices GFC_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.

static int gfc_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. Unused in this routine.


Variable Documentation

EFC_definition Gfc_Definition [static]
 

Initial value:

The defining parameters for this filter.


Generated on Fri Jan 25 01:26:37 2008 by  doxygen 1.4.4