GRB_siu.h File Reference

Gamma Ray Burst Inferface Defines the interface to and data structures containing the parameters used in processing and generating SIU gamma ray burst alerts. More...

#include <GRB/GRB_latMsg.h>
#include <GRB/GRB_gbmMsg.h>
#include <GRB/GRB_msgdef.h>
#include <GRB/GRB_pktdef.h>

Classes
struct	_GRB_siuServices
	Structure containing the SIU GRB services. More...
Typedefs
typedef unsigned int(*	GRB_siuSizeofRtn )(void *prm)
	Signature for a routine to get SIU GRB services size.
typedef const GRB_siuServices *(*	GRB_siuServicesGetRtn )(void *ctl, void *prm, const GRB_latMsgServices *latsvc)
	Signature for a routine to get SIU GRB services.
typedef void(*	GRB_siuProcessRtn )(void *ctl, const GRB_msgHdr *msg)
	Signature for a routine to process SIU GRB messages.
typedef void(*	GRB_siuStartRtn )(void *ctl)
	Signature for a routine to start a SIU GRB run.
typedef void(*	GRB_siuStopRtn )(void *ctl)
	Signature for a routine to stop a SIU GRB run.
typedef struct _GRB_siuServices	GRB_siuServices
	Typedef for struct _GRB_siuServices.

---

Detailed Description

Gamma Ray Burst Inferface Defines the interface to and data structures containing the parameters used in processing and generating SIU gamma ray burst alerts.

Author:

Sergio Maldonado - smaldona@slac.stanford.edu

    CVS $Id: GRB_siu.h,v 1.4 2011/03/25 23:20:51 apw Exp $

---

Typedef Documentation

GRB_siuProcessRtn

Signature for a routine to process SIU GRB messages.

Parameters:

	ctl	User control parameter
	msg	GRB message header

GRB_siuServices

Typedef for struct _GRB_siuServices.

This structure describes the content of an SIU GRB services block

const GRB_siuServicesGetRtn

Signature for a routine to get SIU GRB services.

Returns:

GRB SIU services pointer

Parameters:

	ctl	User control parameter
	prm	User parameter
	latsvc	GRB_latMsgServices struct

GRB_siuSizeofRtn

Signature for a routine to get SIU GRB services size.

Returns:

Size in bytes of SIU services

Parameters:

prm

User parameter

GRB_siuStartRtn

Signature for a routine to start a SIU GRB run.

Parameters:

ctl

User control parameter

GRB_siuStopRtn

Signature for a routine to stop a SIU GRB run.

Parameters:

ctl

User control parameter