---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > DUMP / V0-0-0

Constituent: dump     Tag: linux-gcc

---

         

---

dump.h File Reference

Framework used to parse the contents of a stream of datagrams. More...

#include "QSE/CCSDS_apidDsc.h"
#include "QSE/QSE_printDvr.h"
#include <unistd.h>

Include dependency graph for dump.h:

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

Typedefs
typedef _ApidStream	ApidStream
	Typedef for struct _ApidStream.
typedef LSF_scanContributionHandler(	DUMP_dgmHandler )(ApidStream *, const LSF_datagram *)
	Application specific datagram handler.
Functions
size_t	DUMP_sizeofAstream (void)
	Return the size of the ApidStream structure.
ApidStream *	DUMP_constructAstream (void *astream, unsigned int dgmid, unsigned short int apid, unsigned char *dsc_buf, size_t buf_size, DUMP_dgmHandler *dgm_handler, void *rsrc)
	Construct an ApidStream structure using the resources provided.
void *	DUMP_getResource (ApidStream *astream)
	Hand back the pointer to the application resources.
int	DUMP_process (const char *file, int dmp_ccsds)
	Process a file of physics events datagrams.

---

Detailed Description

Framework used to parse the contents of a stream of datagrams.

Author:

jswain@slac.stanford.edu

   Cvs $Id: dump.h,v 1.1.1.1 2006/05/03 18:15:32 jswain Exp $

---

Function Documentation

ApidStream* DUMP_constructAstream (  void *  astream, unsigned int  dgmid, unsigned short int  apid, unsigned char *  dsc_buf, size_t  buf_size, DUMP_dgmHandler *  dgm_handler, void *  rsrc )

Construct an ApidStream structure using the resources provided. Returns: Pointer to the constructed ApidStream structure

void* DUMP_getResource (  ApidStream *  astream  )

Hand back the pointer to the application resources. Returns: Pointer handed to DUMP when DUMP_constructAstream was invoked Parameters: astream  Pointer to the ApidStream structure

int DUMP_process (  const char *  file, int  dmp_ccsds )

Process a file of physics events datagrams. Returns: Overall status Parameters: file  Name of the file to process dmp_ccsds  Flag indicating whether (1) or not (0) to print out the raw CCSDS

size_t DUMP_sizeofAstream (  void   )

Return the size of the ApidStream structure. Returns: Size of the ApidStream structure

---