GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> XFC / dev > gdmfc / linux-gcc


Interface   Data Structures   File List   Data Fields   Globals  

MFC_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 <XFC/MFC.h>
#include <XFC/MFC_status.h>
#include <MFC_def.h>
#include <MFC_resultDef.h>
#include <EDS_DB/EDS_DB_schema.h>

Functions

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

Variables

static const EFC_definition Mfc_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: MFC_dbConfigure.c,v 1.3 2011/03/28 20:50:58 russell Exp $

Function Documentation

static const EDS_fwHandlerServicesX1 * mfc_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 Mfc_Definition, MFC_fwNeeds(), and MFC_fwObjects().

Referenced by MFC_constructServicesGet().

const EDS_DB_HandlerConstructServices MFC_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 mfc_construct(), and mfc_sizeof().

static int mfc_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.

References Mfc_Definition.

Referenced by MFC_constructServicesGet().


Variable Documentation

EFC_definition Mfc_Definition [static]

Initial value:

{
  
  {
    (EFC_servicesConstruct)MFC_cfgCompile,   
    (EFC_servicesFilter)  MFC_filter,        
    (EFC_servicesCfgSet)  MFC_cfgSet,        
    (EFC_servicesDestruct)NULL,              
    (EFC_servicesReport)  NULL               
  },


  
  {
    sizeof (MFC),             
    sizeof (MFC_cfg),         
    sizeof (MFC_result)       
  },


  
  {
      MFC_STATUS_M_INFO | MFC_STATUS_M_PASSES | MFC_STATUS_M_VETOES,
      MFC_STATUS_M_VETOES,
      MFC_STATUS_M_PASSES,
      MFC_STATUS_M_INFO
  }
}
The defining parameters for this filter.

Referenced by mfc_construct(), and mfc_sizeof().


Generated on Mon Aug 8 10:33:26 2011 by  doxygen 1.5.8