GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > QSSP / V1-1-0

Constituent: qssp     Tag: sun-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » QSD » source » QSSP » V1-1-0 » QSSP

QSSP_span.h File Reference

Defines a standard sample span. More...

#include "QSSP/QSSP_point.h"

Include dependency graph for QSSP_span.h:

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


Data Structures

struct  _QSSP_spanV0
 Defines the beginning and ending of when the sample was taken. More...
struct  _QSSP_spanV1
 Defines the beginning and ending of when the sample was taken, version 2. More...

Typedefs

typedef _QSSP_spanV0 QSSP_spanV0
 Typedef for struct _QSSP_spanV0.
typedef _QSSP_spanV1 QSSP_spanV1
 Typedef for struct _QSSP_spanV1.

Functions

const unsigned int * QSSP_spanV0DecodeTwo (unsigned int *diff_p, QSSP_spanV0 *cumulative, QSSP_spanV0 *current, const unsigned int *dat, unsigned char bridge)
 Decodes two headers that are just straight copies.
const unsigned int * QSSP_spanV0DecodeOne (unsigned int *diff_p, QSSP_spanV0 *cumulative, QSSP_spanV0 *current, const unsigned int *dat, unsigned char bridge)
 Decodes one header that is just a straight copy.
const unsigned int * QSSP_spanV0DecodeDiff (unsigned int *diff_p, QSSP_spanV0 *cumulative, QSSP_spanV0 *current, const unsigned int *dat, unsigned char bridge)
 Decodes the sample point information when it is encoded as a difference from the previous point to the current point.
void QSSP_spanV0Complete (QSSP_spanV0 *span)
 Completes the derived values of the QSSP_spanV0 structure.
void QSSP_spanV0Update (QSSP_spanV0 *dst, const QSSP_spanV0 *src)
 Logically combines the source span record with the destination span record.
const unsigned int * QSSP_spanV1DecodeTwo (unsigned int *diff_p, QSSP_spanV1 *cumulative, QSSP_spanV1 *current, const unsigned int *dat, unsigned char bridge)
 Decodes two headers that are just straight copies.
const unsigned int * QSSP_spanV1DecodeOne (unsigned int *diff_p, QSSP_spanV1 *cumulative, QSSP_spanV1 *current, const unsigned int *dat, unsigned char bridge)
 Decodes one header that is just a straight copy.
const unsigned int * QSSP_spanV1DecodeDiff (unsigned int *diff_p, QSSP_spanV1 *cumulative, QSSP_spanV1 *current, const unsigned int *dat, unsigned char bridge)
 Decodes the sample point information when it is encoded as a difference from the previous point to the current point.
void QSSP_spanV1Complete (QSSP_spanV1 *span)
 Completes the derived values of the QSSP_spanV1 structure.
void QSSP_spanV1Update (QSSP_spanV1 *dst, const QSSP_spanV1 *src)
 Logically combines the source span record with the destination span record.

Detailed Description

Defines a standard sample span.

Author:
JJRussell - russell@slac.stanford.edu
   CVS $Id: QSSP_span.h,v 1.1 2008/06/10 22:30:00 russell Exp $

A sample span captures the conditions at both the beginning or ending of a sample, defining the conditions and duration of the sample

Function Documentation

void QSSP_spanV0Complete (  QSSP_spanV0 *  span  ) 
 

Completes the derived values of the QSSP_spanV0 structure.

Parameters:
span The sample span structure to complete

const unsigned int* QSSP_spanV0DecodeDiff (  unsigned int *  diff_p,
QSSP_spanV0 *  cumulative,
QSSP_spanV0 *  current,
const unsigned int *  dat,
unsigned char  bridge
) 
 

Decodes the sample point information when it is encoded as a difference from the previous point to the current point.

Returns:
The next location to continue the decoding
Parameters:
diff_p Pointer to the current sequence number difference
cumulative The cumulative span
current The current span
dat The input data to decode from
bridge The record's bridge word

const unsigned int* QSSP_spanV0DecodeOne (  unsigned int *  diff_p,
QSSP_spanV0 *  cumulative,
QSSP_spanV0 *  current,
const unsigned int *  dat,
unsigned char  bridge
) 
 

Decodes one header that is just a straight copy.

Returns:
The next address to decode from
Parameters:
diff_p Pointer to the current sequence number difference
cumulative The cumulative span
current The current span
dat The input data to decode from
bridge The record's bridge word

const unsigned int* QSSP_spanV0DecodeTwo (  unsigned int *  diff_p,
QSSP_spanV0 *  cumulative,
QSSP_spanV0 *  current,
const unsigned int *  dat,
unsigned char  bridge
) 
 

Decodes two headers that are just straight copies.

Returns:
The next address to decode from
Parameters:
diff_p Pointer to the current sequence number difference
cumulative The cumulative span
current The current span
dat The input data to decode from
bridge The record's bridge word

void QSSP_spanV0Update (  QSSP_spanV0 *  dst,
const QSSP_spanV0 *  src
) 
 

Logically combines the source span record with the destination span record.

Parameters:
dst The destination span record
src The source span recode
Updatine a span record involves three operations
  • Replacing the end point in the destination span record with the end point in the source span record
  • Recalculating the delta time and delta sequence values
  • Adding the incremental fields. For V0 there are no such fields

void QSSP_spanV1Complete (  QSSP_spanV1 *  span  ) 
 

Completes the derived values of the QSSP_spanV1 structure.

Parameters:
span The sample span structure to complete

const unsigned int* QSSP_spanV1DecodeDiff (  unsigned int *  diff_p,
QSSP_spanV1 *  cumulative,
QSSP_spanV1 *  current,
const unsigned int *  dat,
unsigned char  bridge
) 
 

Decodes the sample point information when it is encoded as a difference from the previous point to the current point.

Returns:
The next location to continue the decoding
Parameters:
diff_p Pointer to the current sequence number difference
cumulative The cumulative span
current The current span
dat The input data to decode from
bridge The record's bridge word

const unsigned int* QSSP_spanV1DecodeOne (  unsigned int *  diff_p,
QSSP_spanV1 *  cumulative,
QSSP_spanV1 *  current,
const unsigned int *  dat,
unsigned char  bridge
) 
 

Decodes one header that is just a straight copy.

Returns:
The next address to decode from
Parameters:
diff_p Pointer to the current sequence number difference
cumulative The cumulative span
current The current span
dat The input data to decode from
bridge The record's bridge word

const unsigned int* QSSP_spanV1DecodeTwo (  unsigned int *  diff_p,
QSSP_spanV1 *  cumulative,
QSSP_spanV1 *  current,
const unsigned int *  dat,
unsigned char  bridge
) 
 

Decodes two headers that are just straight copies.

Returns:
The next address to decode from
Parameters:
diff_p Pointer to the current sequence number difference
cumulative The cumulative span
current The current span
dat The input data to decode from
bridge The record's bridge word

void QSSP_spanV1Update (  QSSP_spanV1 *  dst,
const QSSP_spanV1 *  src
) 
 

Logically combines the source span record with the destination span record.

Parameters:
dst The destination span record
src The source span recode
Updatine a span record involves two operations
  • Replacing the end point in the destination span record with the end point in the source span record
  • Adding the incremental fields, such as the elapsed time and counts field

Generated on Sat Sep 20 03:01:05 2008 by  doxygen 1.4.4