GRB_latMsg.h File Reference

Gamma Ray Burst LAT Messages Defines the interface for processing of LAT GRB messages. More...

#include <PBI/Endianness.h>

Classes
struct	_GRB_latAlertMsgTime
	The representation of time in the LAT alert message. More...
struct	_GRB_latAlertMsgBclass_bf
	The bclass word as bit fields. More...
union	_GRB_latAlertMsgBclass
	Union of the uninterpreted 32-bit and bit field representation of the burst classification word. More...
struct	_GRB_latAlertMsg
	Structure containing a GRB alert message. More...
struct	_GRB_latMsgServices
	Structure containing the LAT message services. More...
Defines
#define	GRB_LATALERTMSG_BCLASS(_trigger_type,_location_method,_window_size)
	Macro to set the static fields GRB classification word.
Typedefs
typedef void(*	GRB_latSuspectRtn )(const GRB_latAlertMsg *alert)
	Signature for a GRB Suspect Alert callback routine.
typedef void(*	GRB_latUpdateRtn )(const GRB_latAlertMsg *alert)
	Signature for a GRB latUpdate Alert callback routine.
typedef void(*	GRB_latConfirmRtn )(unsigned int duration, double ra, double dec)
	Signature for a GRB Confirm Alert callback routine.
typedef void(*	GRB_latCloseoutRtn )(const GRB_latAlertMsg *alert, int inhibit)
	Signature for a GRB Closeout Alert callback routine.
typedef struct _GRB_latAlertMsgTime	GRB_latAlertMsgTime
	Typedef for struct _GRB_latAlertMsgTime.
typedef enum _GRB_latAlertMsgLocMethod	GRB_latAlertMsgLocMethod
	Typedef for enum _GRB_latAlertMsgLocMethod.
typedef enum _GRB_latAlertMsgTriggerType	GRB_latAlertMsgTriggerType
	Typedef for enum _GRB_latAlertMsgTriggerType.
typedef struct _GRB_latAlertMsgBclass_bf	GRB_latAlertMsgBclass_bf
	Typedef for struct _GRB_latAlertMsgBclass_bf.
typedef union _GRB_latAlertMsgBclass	GRB_latAlertMsgBclass
	Typedef for union _GRB_latAlertMsgBclass.
typedef struct _GRB_latAlertMsg	GRB_latAlertMsg
	Typedef for struct _GRB_latAlertMsg.
typedef struct _GRB_latMsgServices	GRB_latMsgServices
	Typedef for struct GRB_latMsgServices.
Enumerations
enum	_GRB_latAlertMsgLocMethod {   GRB_LATALERTMSG_LOCMETHOD_ALL = 0,   GRB_LATALERTMSG_LOCMETHOD_ENERGY = 1,   GRB_LATALERTMSG_LOCMETHOD_RSVD_2 = 2,   GRB_LATALERTMSG_LOCMETHOD_RSVD_3 = 3 }
	Enumerates the location method. More...
enum	_GRB_latAlertMsgTriggerType {   GRB_LATALERTMSG_TRIGGERTYPE_LAT = 0,   GRB_LATALERTMSG_TRIGGERTYPE_GBM = 1 }
	Enumerates the trigger types. More...

---

Detailed Description

Gamma Ray Burst LAT Messages Defines the interface for processing of LAT GRB messages.

Author:

Sergio Maldonado - smaldona@slac.stanford.edu

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

---

Define Documentation

#define GRB_LATALERTMSG_BCLASS	(	_trigger_type,
		_location_method,
		_window_size		)

Value:

( (((_trigger_type   ) &    0x1) << 18) |        \
    (((_location_method) &    0x3) << 16) |        \
    (((_window_size    ) & 0xffff) <<  0) )        \

Macro to set the static fields GRB classification word.

Parameters:

	_trigger_type	The GRB trigger. This must be one of GRB_latAlertMsgTriggerType
	_location_method	The location method, This must be one of GRB_latAlertMsgLocMethod
	_window_size	The size, in photons, of the detection window

---

Typedef Documentation

GRB_latAlertMsg

Typedef for struct _GRB_latAlertMsg.

This structure describes the content of a GRB alert message.

Note:

GRB_latAlertMsgTime is of size 8 bytes. GRB_latAlertMsgBclass is of size 4 bytes

void(* GRB_latCloseoutRtn)(GRB_Alert *alert)

Signature for a GRB Closeout Alert callback routine.

Parameters:

	alert	The GRB alert message
	inhibit	The GRB finish flag - 0 allow, non-zero inhibit

void(* GRB_latConfirmRtn)(unsigned int duration, double ra, double dec)

Signature for a GRB Confirm Alert callback routine.

Parameters:

	duration	Duration in seconds of the requested repoint
	ra	The right ascension, in degrees
	dec	The declination, in degrees

GRB_latMsgServices

Typedef for struct GRB_latMsgServices.

This structure describes the content of a LAT message services block

void(* GRB_latSuspectRtn)(const GRB_Alert *alert)

Signature for a GRB Suspect Alert callback routine.

Parameters:

alert

The GRB alert message

void(* GRB_latUpdateRtn)(GRB_Alert *alert)

Signature for a GRB latUpdate Alert callback routine.

Parameters:

alert

The GRB alert message

---

Enumeration Type Documentation

enum _GRB_latAlertMsgLocMethod

Enumerates the location method.

Enumerator:

GRB_LATALERTMSG_LOCMETHOD_ALL	Used all the gammas
GRB_LATALERTMSG_LOCMETHOD_ENERGY	Used energy selected gammas
GRB_LATALERTMSG_LOCMETHOD_RSVD_2	Reserved for future use
GRB_LATALERTMSG_LOCMETHOD_RSVD_3	Reserved for future use

enum _GRB_latAlertMsgTriggerType

Enumerates the trigger types.

Enumerator:

GRB_LATALERTMSG_TRIGGERTYPE_LAT	LAT triggered GRB
GRB_LATALERTMSG_TRIGGERTYPE_GBM	GBM triggered GRB