GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LSEC / V7-0-0 > lsec / mv2304

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » APP » source » LSEC » V7-0-0 » LSEC

LSEC.h File Reference

Public definitions for the calibration event system. More...

#include "LSEC/LSEC_ctx.h"
#include "EDS/EBF_pkt.h"

Typedefs

typedef enum
_LSEC_compLevel 		LSEC_compLevel
 Compression level values.
typedef enum
_LSEC_evtStatus 		LSEC_evtStatus
 Event processing status values.
typedef struct
_LSEC_control 		LSEC_control
 Declaration of the opaque control structure.

Enumerations

enum  _LSEC_compLevel {
  LSEC_COMP_NORM = 0,
  LSEC_COMP_ONLY = 1,
  LSEC_COMP_NONE = 2,
  LSEC_COMP_DROP = 3
}
 Compression level values. More...
enum  _LSEC_evtStatus {
  LSEC_EVT_FREE = 0x01,
  LSEC_EVT_DONE = 0x02
}
 Event processing status values. More...

Functions

void LSEC_clearEvent (LSEC_control *lsec)
 Clear the event processor for the next data collection.
unsigned LSEC_consign (LSEC_control *lsec)
 Complete the consignment of the event data.
LSEC_ctx * LSEC_getCtx (LSEC_control *lsec)
 Get the address of the context structure.
void LSEC_getTimes (LSEC_control *lsec, long long *times)
 Get the contents of the processing times array.
LSEC_control * LSEC_initialize (unsigned cpuid, unsigned srcid, unsigned cap)
 Initialize the calibration event system.
void LSEC_initRun (LSEC_control *lsec, unsigned runid, unsigned mode, LSEC_compLevel comp)
 Initialize a new calibration run.
LSEC_evtStatus LSEC_processEvent (LSEC_control *lsec, unsigned int edw, EBF_pkt *pkt)
 Process an event.
void LSEC_setReason (LSEC_control *lsec, int reason)
 Set the current datagram close reason.
void LSEC_terminate (LSEC_control *lsec)
 Free the resources used by the calibration event system.

Detailed Description

Public definitions for the calibration event system.

Author:
Owen Saxton
$Id: LSEC.h,v 1.4 2010/05/21 21:33:49 saxton Exp $

Enumeration Type Documentation

enum _LSEC_compLevel

Compression level values.

Enumerator:
LSEC_COMP_NORM  Normal compression.
LSEC_COMP_ONLY  No compression and send only data for type.
LSEC_COMP_NONE  No compression and send all data.
LSEC_COMP_DROP  Drop all the data on the floor.

enum _LSEC_evtStatus

Event processing status values.

Enumerator:
LSEC_EVT_FREE  Free the packet.
LSEC_EVT_DONE  Event is complete.

Function Documentation

void LSEC_clearEvent ( LSEC_control *  lsec  ) 

Clear the event processor for the next data collection.

Parameters:
lsec Control handle, returned by LSEC_initialize.

unsigned LSEC_consign ( LSEC_control *  lsec  ) 

Complete the consignment of the event data.

Parameters:
lsec Control handle, returned by LSEC_initialize.
Return values:
LSEC_SUCCESS If all goes well

LSEC_ctx* LSEC_getCtx ( LSEC_control *  lsec  ) 

Get the address of the context structure.

Parameters:
lsec Control handle, returned by LSEC_initialize.
Returns:
The address of the context structure

void LSEC_getTimes ( LSEC_control *  lsec,
long long *  times 
)

Get the contents of the processing times array.

Parameters:
lsec Control handle, returned by LSEC_initialize.
times Address of an array to receive the processing times. It must contain at least LSEC_N_TIMES entries.

LSEC_control* LSEC_initialize ( unsigned  cpuid,
unsigned  srcid,
unsigned  cap 
)

Initialize the calibration event system.

This routine creates the components of the calibration event system.

Parameters:
srcid ID of the data source
cpuid ID of the CPU the calibration is being run on
cap The capacity (in events) of the system
Returns:
Handle for further access to the system, or NULL if initialization failed.

void LSEC_initRun ( LSEC_control *  lsec,
unsigned  runid,
unsigned  mode,
LSEC_compLevel  comp 
)

Initialize a new calibration run.

This routine sets the runid and start time for the first datagram of a new calibration.

Parameters:
lsec Control handle, returned by LSEC_initialize.
runid 32-bit number identifying the calibration run
mode The calibration mode (ACD, CAL or TKR)
comp The compression level (normal, only, none)

LSEC_evtStatus LSEC_processEvent ( LSEC_control *  lsec,
unsigned int  edw,
EBF_pkt *  pkt 
)

Process an event.

Parameters:
lsec Control handle, returned by LSEC_initialize.
edw The event descriptor word.
pkt The event packet.
Returns:
The OR of zero or more of the bits:

void LSEC_setReason ( LSEC_control *  lsec,
int  reason 
)

Set the current datagram close reason.

Parameters:
lsec Control handle, returned by LSEC_initialize.
reason The reason code to be set

void LSEC_terminate ( LSEC_control *  lsec  ) 

Free the resources used by the calibration event system.

Parameters:
lsec Control handle, returned by LSEC_initialize.

Generated on Wed May 26 10:22:36 2010 by  doxygen 1.5.3