GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> GRBP / dev > grbpsiu / rad750


Interface   Data Structures   File List   Data Fields   Globals  

GRBP_message.h File Reference

Interface controlling the messageing and updating of the GRBP messages. More...

#include <GRBP_DB/GRBP_DB_messageSchedule.h>
#include <GRBP_skew.h>
#include <GRBP_math.h>
#include <GRBP_location.h>
#include <GRB/GRB_latMsg.h>

Classes

struct  _GRBP_messageTriggerPrms
 Parameters controlling the dispatching of the initial trigger message. More...
struct  _GRBP_messageUpdatePrms
 The parameters controlling the delivery of one update messages. More...
struct  _GRBP_messageUpdateListPrms
 The parameters controlling the delivery of update messages. More...
struct  _GRBP_messageCloseoutPrms
 Parameters controlling the dispatching of the closeout message message. More...
struct  _GRBP_messagePrms
 The parameters controlling the initial GRBP message message and the subsequent update and closeout messages. More...
struct  _GRBP_message
 The context controlling controlling the initial GRBP message message and the subsequent update and closeout messages. More...

Typedefs

typedef struct _GRBP_grb GRBP_grb
typedef struct
_GRBP_probabilityLogs 
GRBP_probabilityLogs
typedef struct
_GRBP_messageTriggerPrms 
GRBP_messageTriggerPrms
 Typedef for struct _GRBP_messageTriggerPrms.
typedef struct
_GRBP_messageUpdatePrms 
GRBP_messageUpdatePrms
 Typedef for struct _GRBP_messageUpdateMemberPrms.
typedef struct
_GRBP_messageUpdateListPrms 
GRBP_messageUpdateListPrms
 Typedef for struct _GRBP_messageUpdateListPrms.
typedef struct
_GRBP_messageCloseoutPrms 
GRBP_messageCloseoutPrms
 Typedef for struct _GRBP_messageCloseoutPrms.
typedef struct _GRBP_messagePrms GRBP_messagePrms
 Typedef for struct _GRBP_messagePrms.
typedef struct _GRBP_message GRBP_message
 Typedef for struct _GRBP_message.

Functions

int GRBP_messageSizeof (void)
void GRBP_messageConstruct (GRBP_message *msg, const GRBP_DB_messageSchedule *cfg, const GRB_latMsgServices *services)
void GRBP_messageReset (GRBP_message *msg)
int GRBP_messageTriggerCheck (GRBP_message *msg, int added, double start_time)
int GRBP_messageUpdateCheck (GRBP_message *msg, int added, double current_time)
void GRBP_messageCapture (GRBP_message *msg, const GRBP_grb *grb, double current_time)
 Captures the set of parameters that are defined when the GRB suspect message is issued.
void GRBP_messageFormat (GRBP_message *msg, const GRBP_grb *grb)
 Formats the part of the alert message that gets continually updated.
void GRBP_messagePlogsFormat (GRBP_message *msg, const GRBP_probabilityLogs *plogs)
 Formats the specified logs of the spatial and temporal probabilities into the working copy of the message.
void GRBP_messageEarliestTimeFormat (GRBP_message *msg, double earliest_time)
 Sets the time of the earliest photon.
static __inline void GRBP__messageSuspectDeliver (GRBP_message *msg)
 Delivers an GRB suspected alert message.
static __inline void GRBP__messageUpdateDeliver (GRBP_message *msg)
 Delivers an GRB update alert message.
static __inline void GRBP__messageConfirmDeliver (GRBP_message *msg, const GRBP_skew *skew, unsigned int duration, const GRBP_location *location)
 Delivers an GRB confirmed alert message.
static __inline void GRBP__messageConfirmSet (GRBP_message *msg)
 Sets the confirmation flag in the message.
static __inline void GRBP__messageCloseoutDeliver (GRBP_message *msg, int inhibit_finish)
 Delivers an GRB closeout alert message.


Detailed Description

Interface controlling the messageing and updating of the GRBP messages.

Author:
JJRussell - russell@slac.stanford.edu

   CVS $Id: GRBP_message.h,v 1.5 2011/03/30 22:11:51 russell Exp $

Function Documentation

static __inline void GRBP__messageCloseoutDeliver ( GRBP_message msg,
int  inhibit_finish 
) [static]

Delivers an GRB closeout alert message.

Parameters:
msg The message control block
inhibit_finish If non-zero, then request that the receive of this message inhibit the sending of the FINISH message.

References _GRBP_message::alert, and _GRBP_message::services.

Referenced by stop(), and updateCheck().

static __inline void GRBP__messageConfirmDeliver ( GRBP_message msg,
const GRBP_skew skew,
unsigned int  duration,
const GRBP_location location 
) [static]

Delivers an GRB confirmed alert message.

Parameters:
msg The message context block
skew Controls the skewing of the repoint direction
duration The duration, in seconds, from the start of the GRB
location The location of the GRB

References _GRBP_skew::dec, _GRBP_location::dx0, _GRBP_location::dy0, _GRBP_location::dz0, GRBP__dcosToDecArcmins(), GRBP__messageConfirmSet(), GRBP__skewDecArcmins(), GRBP__skewRaArcmins(), _GRBP_skew::ra, and _GRBP_message::services.

Referenced by confirmCheck().

void GRBP__messageConfirmSet ( GRBP_message msg  )  [static]

Sets the confirmation flag in the message.

Parameters:
msg The message context

References _GRBP_message::alert.

Referenced by GRBP__messageConfirmDeliver().

static __inline void GRBP__messageSuspectDeliver ( GRBP_message msg  )  [static]

Delivers an GRB suspected alert message.

Parameters:
msg The message context block

References _GRBP_message::alert, and _GRBP_message::services.

Referenced by grbDeclare().

static __inline void GRBP__messageUpdateDeliver ( GRBP_message msg  )  [static]

Delivers an GRB update alert message.

Parameters:
msg The message context block

References _GRBP_message::alert, and _GRBP_message::services.

Referenced by updateCheck().

void GRBP_messageCapture ( GRBP_message msg,
const GRBP_grb grb,
double  current_time 
)

Captures the set of parameters that are defined when the GRB suspect message is issued.

Parameters:
msg The message context
grb The GRB context
current_time The time of the gamma entered which caused the the suspect message to be issued

References _GRBP_message::alert, _GRBP_gammaList::beg, _GRBP_message::beg, _GRBP_windowTier2::earliest_time, format_class(), gam_cnts_clear(), _GRBP_grb::list, _GRBP_grb::location, _GRBP_grbLocations::method, _GRBP_windowTier1Prms::nrange, _GRBP_windowTier2::plog, _GRBP_windowTier1::prms, _GRBP_probabilityLogs::spatial, _GRBP_probabilityLogs::temporal, _GRBP_window::tier1, _GRBP_window::tier2, to_probability(), to_time(), _GRBP_window::type, and _GRBP_grb::window.

Referenced by grbDeclare().

void GRBP_messageEarliestTimeFormat ( GRBP_message msg,
double  earliest_time 
)

Sets the time of the earliest photon.

Parameters:
msg The message context
earliest_time The earliest time
On the SUSPECT message the earliest time is defined as the time of the earliest photon in the cluster. On subsequent messages it is redefined to be the time of earliest photon in the tier 2 list This routine allows one to reset the earliest time.after the initial message

References _GRBP_message::alert, and to_time().

Referenced by grbDeclare().

void GRBP_messageFormat ( GRBP_message msg,
const GRBP_grb grb 
)

void GRBP_messagePlogsFormat ( GRBP_message msg,
const GRBP_probabilityLogs plogs 
)

Formats the specified logs of the spatial and temporal probabilities into the working copy of the message.

Parameters:
msg The message context
plogs The logs of the spatial and temporal probabilities

References _GRBP_message::alert, _GRBP_probabilityLogs::spatial, _GRBP_probabilityLogs::temporal, and to_probability().

Referenced by stop(), and updateCheck().


Generated on Wed Sep 28 10:11:15 2011 by  doxygen 1.5.8