---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LSF / V2-0-5

Constituent: lsfprint     Tag: sun-gcc

---

         

---

LSF_print.h File Reference

Interface to generic LSF print routines. More...

#include "LSF/LSF_scan.h"

Include dependency graph for LSF_print.h:

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

Data Structures
struct	_LSF_printCtxCnts
	Global counts of datagrams, contributions and records. More...
struct	_LSF_printCtx
	Print context. More...
Typedefs
typedef _LSF_printCtxCnts	LSF_printCtxCnts
	Typedef for struct _LSF_printCtxCnts.
typedef _LSF_printCtx	LSF_printCtx
	struct _LSF_printCtx
Functions
unsigned int	LSF_printCtxSizeof (void *prm)
	Returns the size, in bytes, of the print context handle.
void	LSF_printCtxConstruct (LSF_printCtx *ctx, unsigned int options)
	Constructs/Initializes the print control context.
void	LSF_printCtxDestruct (LSF_printCtx *ctx)
	Destroys the print context.
LSF_scanContributionHandler	LSF_printDatagram (LSF_printCtx *ctx, const LSF_datagram *dgm)
	Prints the header of the specified datagram.
LSF_scanRecordHandler	LSF_printContribution (LSF_printCtx *ctx, const LSF_contribution *ctb)
	Prints the header of the specified contribution.
unsigned int	LSF_printRecord (LSF_printCtx *ctx, const LSF_record *rec)
	Prints the header of the specified contribution.
unsigned int	LSF_printDatagramHdr (const LSF_datagram_hdr *dgm_hdr, unsigned int dgm_seq)
	Prints a short, one-line dump of the datagram header.
unsigned int	LSF_printContributionHdr (const LSF_contribution_hdr *ctb_hdr, unsigned int ctb_seq)
	Prints a short, one-line dump of the contribution header.
unsigned int	LSF_printRecordHdr (const LSF_record_hdr *rec_hdr, unsigned int rec_seq)
	Prints a short, one-line dump of the record header.

---

Detailed Description

Interface to generic LSF print routines.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: LSF_print.h,v 1.4 2005/10/13 18:36:43 russell Exp $

---

Function Documentation

LSF_scanRecordHandler LSF_printContribution (  LSF_printCtx *  ctx, const LSF_contribution *  ctb )

Prints the header of the specified contribution. Return values: 0,indicating  to continue the scan Parameters: ctx  Print context parameter ctb  The contribution to print

unsigned int LSF_printContributionHdr (  const LSF_contribution_hdr *  ctb_hdr, unsigned int  ctb_seq )

Prints a short, one-line dump of the contribution header. Returns: The number of characters printed to the screen Parameters: ctb_hdr  The contribution header to print ctb_seq  A integer that identifies the number or sequence of this contribution Warning: No new line is emitted on the theory that the user can provide one if desired, but cannot retract it once emitted.

void LSF_printCtxConstruct (  LSF_printCtx *  ctx, unsigned int  options )

Constructs/Initializes the print control context. Parameters: ctx  The context to initialize options  Options flags, currently unused, specify as 0

void LSF_printCtxDestruct (  LSF_printCtx *  ctx  )

Destroys the print context. Parameters: ctx  The context to destroy This is a NOOP here only to statisfy interface requirements

unsigned int LSF_printCtxSizeof (  void *  prm  )

Returns the size, in bytes, of the print context handle. Returns: The size, in bytes, of the print context handle Parameters: prm  Unused context parameter

LSF_scanContributionHandler LSF_printDatagram (  LSF_printCtx *  ctx, const LSF_datagram *  dgm )

Prints the header of the specified datagram. Return values: 0,indicating  to continue the scan Parameters: ctx  Print context parameter dgm  The datagram to print

unsigned int LSF_printDatagramHdr (  const LSF_datagram_hdr *  dgm_hdr, unsigned int  dgm_seq )

Prints a short, one-line dump of the datagram header. Returns: The number of characters printed to the screen Parameters: dgm_hdr  The datagram header to print dgm_seq  A integer that identifies the number or sequence of this datagram Warning: No new line is emitted on the theory that the user can provide one if desired, but cannot retract it once emitted.

unsigned int LSF_printRecord (  LSF_printCtx *  ctx, const LSF_record *  rec )

Prints the header of the specified contribution. Return values: 0,indicating  to continue the scan Parameters: ctx  Print context parameter rec  The record to print

unsigned int LSF_printRecordHdr (  const LSF_record_hdr *  rec_hdr, unsigned int  rec_seq )

Prints a short, one-line dump of the record header. Returns: The number of characters printed to the screen Parameters: rec_hdr  The record header to print rec_seq  A integer that identifies the number or sequence of this record Warning: No new line is emitted on the theory that the user can provide one if desired, but cannot retract it once emitted.

---