---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LCI / dev

Constituent: lci     Tag: mcp750

---

         

---

consign.h File Reference

Public definitions of the consignment structure and functions. More...

#include "configure.h"
#include "collect.h"
#include "LSEC/compact.h"
#include "PBS/WCT.h"

Include dependency graph for consign.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef _LCI_consignment	LCI_consignment
	Declaration of the opaque consignment structure.
Functions
LCI_consignment *	LCI_newConsignment (unsigned cpuid, unsigned srcid, LCI_configuration *cnf, LCI_collection *cll, LSEC_compaction *cpc)
	Allocate memory for an LCI_consigment structure and initialise (clear).
void	LCI_deleteConsignment (LCI_consignment *cns)
	Free the previously allocated consignment structure.
WCT_time_sat	LCI_prepare (LCI_consignment *cns, unsigned runid)
	Set the runid and start time for the first datagram of the new calibration.
unsigned	LCI_consign (LCI_consignment *cns)
	Perform a consignment.
unsigned	LCI_complete (LCI_consignment *cns)
	Complete a consignment.
void	LCI_setReason (LCI_consignment *cns, int reason)
	Set the current datagram close reason.

---

Detailed Description

Public definitions of the consignment structure and functions.

Author:

James Swain & Owen Saxton

Id

consign.h,v 1.11 2007/08/21 22:51:56 saxton Exp

---

Function Documentation

unsigned LCI_complete (  LCI_consignment *  cns  )

Complete a consignment. Parameters: cns  pointer to the consignment Return values: LCI_SUCCESS  If all goes well

unsigned LCI_consign (  LCI_consignment *  cns  )

Perform a consignment. Parameters: cns  Pointer to a consignment structure Return values: LCI_SUCCESS  If all goes well

void LCI_deleteConsignment (  LCI_consignment *  cns  )

Free the previously allocated consignment structure. Parameters: cns  Pointer to allocated, intialised consignment structure (from LCI_newConsignment)

LCI_consignment* LCI_newConsignment (  unsigned  cpuid, unsigned  srcid, LCI_configuration *  cnf, LCI_collection *  cll, LSEC_compaction *  cpc )

Allocate memory for an LCI_consigment structure and initialise (clear). Parameters: srcid  ID of the data source cpuid  ID of the CPU LCI is being run on cll  Pointer to the collection of events to consign cpc  Pointer to the compaction state information cnf  Pointer to the configuration data Returns: Pointer to an allocated, initialised consignment (NULL if there is an error allocating memory)

WCT_time_sat LCI_prepare (  LCI_consignment *  cns, unsigned  runid )

Set the runid and start time for the first datagram of the new calibration. Parameters: cns  Pointer to allocated, intialised consignment structure (from LCI_newConsignment) runid  32-bit number identifying the calibration run Returns: The run start time (as a 64-bit Spectrum Astro time)

void LCI_setReason (  LCI_consignment *  cns, int  reason )

Set the current datagram close reason. Parameters: cns  Pointer to the consignment structure reason  The reason code to be set

---