GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LIM / V1-20-0

Constituent: lim     Tag: rad750

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » APP » source » LIM » V1-20-0 » src

LIM_arr.h File Reference

Interface to the functions found in LIM_arr.c. More...

#include "ITC/ITC_pubdefs.h"
#include "LIM/LIM_pubdefs.h"
#include "LIM_action.h"
#include "LIM_bulk.h"
#include "LIM_gbm.h"
#include "LIM_lpa.h"
#include "LIM_pkt_send.h"
#include "LIM_sc.h"
#include "LIM_task.h"

Include dependency graph for LIM_arr.h:

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


Typedefs

typedef _LIM_Arr LIM_Arr
 Typedef for opaque ARR observation object handle.

Functions

unsigned int LIM_arr_new (LIM_Arr **object_pp, LIM_Task *task_p, LIM_Action *action_p, LIM_Gbm *gbm_p, LIM_Sc *sc_p, LIM_Lpa *lpa_p, LIM_Bulk *bulk_p, const LIM_DB_Schema *db_p)
 Create and initialize a new ARR observation object.
unsigned int LIM_arr_delete (LIM_Arr *object_p)
 Shutdown and delete a ARR observation object.
int LIM_arr_is_ready (LIM_Arr *object_p)
 Return the READY status of an ARR observation.
LIM_Grb_State LIM_arr_grb_state (LIM_Arr *object_p)
 Return the GRB state of an ARR observation.
unsigned int LIM_arr_get_info (LIM_Arr *object_p, LIM_Info *info_p)
 Return ARR observation information.
unsigned int LIM_arr_handle_abort (LIM_Arr *object_p, const ITC_QueueItem *qitem_p)
 Handle an ARR-Abort command.
unsigned int LIM_arr_handle_activity (LIM_Arr *object_p)
 Handle ARR observation activity.
unsigned int LIM_arr_handle_bulk (LIM_Arr *object_p, LIM_Operating_Mode op_mode)
 Handle a message on the BULK queue.
unsigned int LIM_arr_handle_calcinfo (LIM_Arr *object_p, const ITC_QueueItem *qitem_p, int forward_ok, LIM_Operating_Mode op_mode)
 Handle a GBM-Calcinfo command.
unsigned int LIM_arr_handle_closeout (LIM_Arr *object_p, const ITC_QueueItem *qitem_p, int forward_ok)
 Handle a GBM-Closeout command.
unsigned int LIM_arr_handle_confirmed (LIM_Arr *object_p, const ITC_QueueItem *qitem_p, LIM_Operating_Mode op_mode)
 Handle a GRB-Confirmed command.
unsigned int LIM_arr_handle_finished (LIM_Arr *object_p)
 Handle a GRB-Finished command.
unsigned int LIM_arr_handle_physics_start (LIM_Arr *object_p, const ITC_QueueItem *qitem_p)
 Handle a PHYSICS-START command in ARR mode.
unsigned int LIM_arr_handle_repoint (LIM_Arr *object_p, const ITC_QueueItem *qitem_p, int forward_ok, int slew_req_ok, LIM_Operating_Mode op_mode)
 Handle a GBM-Repoint command.
unsigned int LIM_arr_handle_suspected (LIM_Arr *object_p, LIM_Operating_Mode op_mode)
 Handle a GRB-Suspected command.
unsigned int LIM_arr_handle_response (LIM_Arr *object_p, const ITC_QueueItem *qitem_p)
 Handle an ARR-Response message.

Detailed Description

Interface to the functions found in LIM_arr.c. 

**  CVS $Id: LIM_arr.h,v 1.12 2007/12/16 23:01:54 dmay Exp $
**

Function Documentation

unsigned int LIM_arr_delete (  LIM_Arr *  object_p  ) 
 

Shutdown and delete a ARR observation object.

Parameters:
object_p Pointer to object.
Returns:
MSG code.

unsigned int LIM_arr_get_info (  LIM_Arr *  object_p,
LIM_Info *  info_p
) 
 

Return ARR observation information.

Parameters:
object_p Pointer to ARR observation object.
info_p Location to return GBM interface information (must not be NULL).
Returns:
MSG code.

LIM_Grb_State LIM_arr_grb_state (  LIM_Arr *  object_p  ) 
 

Return the GRB state of an ARR observation.

Parameters:
object_p Pointer to ARR observation object.
Returns:
Current GRB state.

unsigned int LIM_arr_handle_abort (  LIM_Arr *  object_p,
const ITC_QueueItem *  qitem_p
) 
 

Handle an ARR-Abort command.

Parameters:
object_p Pointer to ARR observation object.
qitem_p Pointer to queue item containing the command.
Returns:
MSG code.

unsigned int LIM_arr_handle_activity (  LIM_Arr *  object_p  ) 
 

Handle ARR observation activity.

Parameters:
object_p Pointer to ARR observation object.
Returns:
MSG code.

unsigned int LIM_arr_handle_bulk (  LIM_Arr *  object_p,
LIM_Operating_Mode  op_mode
) 
 

Handle a message on the BULK queue.

Parameters:
object_p Pointer to ARR observation object.
op_mode Current operating mode.
Returns:
MSG code.

unsigned int LIM_arr_handle_calcinfo (  LIM_Arr *  object_p,
const ITC_QueueItem *  qitem_p,
int  forward_ok,
LIM_Operating_Mode  op_mode
) 
 

Handle a GBM-Calcinfo command.

Parameters:
object_p Pointer to ARR observation object.
qitem_p Pointer to queue item containing the command.
forward_ok Flag indicating that command may be fowarded to LPA.
op_mode Current operating mode.
Returns:
MSG code.

unsigned int LIM_arr_handle_closeout (  LIM_Arr *  object_p,
const ITC_QueueItem *  qitem_p,
int  forward_ok
) 
 

Handle a GBM-Closeout command.

Parameters:
object_p Pointer to ARR observation object.
qitem_p Pointer to queue item containing the command.
forward_ok Flag indicating that command can be forwarded to LPA.
Returns:
MSG code.

unsigned int LIM_arr_handle_confirmed (  LIM_Arr *  object_p,
const ITC_QueueItem *  qitem_p,
LIM_Operating_Mode  op_mode
) 
 

Handle a GRB-Confirmed command.

Parameters:
object_p Pointer to ARR observation object.
qitem_p Pointer to queue item containing the command.
op_mode Current operating mode.
Returns:
MSG code.

unsigned int LIM_arr_handle_finished (  LIM_Arr *  object_p  ) 
 

Handle a GRB-Finished command.

Parameters:
object_p Pointer to ARR observation object.
Returns:
MSG code.

unsigned int LIM_arr_handle_physics_start (  LIM_Arr *  object_p,
const ITC_QueueItem *  qitem_p
) 
 

Handle a PHYSICS-START command in ARR mode.

Parameters:
object_p Pointer to ARR observation object.
qitem_p Pointer to queue item containing the command.
Returns:
MSG code.

unsigned int LIM_arr_handle_repoint (  LIM_Arr *  object_p,
const ITC_QueueItem *  qitem_p,
int  forward_ok,
int  slew_req_ok,
LIM_Operating_Mode  op_mode
) 
 

Handle a GBM-Repoint command.

Parameters:
object_p Pointer to ARR observation object.
qitem_p Pointer to queue item containing the command.
forward_ok Flag indicating that cmd can be forwarded to LPA.
slew_req_ok Flag indicating that slew-req can be sent to S/C.
op_mode Current operating mode.
Returns:
MSG code.

unsigned int LIM_arr_handle_response (  LIM_Arr *  object_p,
const ITC_QueueItem *  qitem_p
) 
 

Handle an ARR-Response message.

Parameters:
object_p Pointer to ARR observation object.
qitem_p Pointer to queue item containing the message.
Returns:
MSG code.

unsigned int LIM_arr_handle_suspected (  LIM_Arr *  object_p,
LIM_Operating_Mode  op_mode
) 
 

Handle a GRB-Suspected command.

Parameters:
object_p Pointer to ARR observation object.
op_mode Current operating mode.
Returns:
MSG code.

int LIM_arr_is_ready (  LIM_Arr *  object_p  ) 
 

Return the READY status of an ARR observation.

Parameters:
object_p Pointer to ARR observation object.
Returns:
Nonzero if the observation is READY.

unsigned int LIM_arr_new (  LIM_Arr **  object_pp,
LIM_Task *  task_p,
LIM_Action *  action_p,
LIM_Gbm *  gbm_p,
LIM_Sc *  sc_p,
LIM_Lpa *  lpa_p,
LIM_Bulk *  bulk_p,
const LIM_DB_Schema *  db_p
) 
 

Create and initialize a new ARR observation object.

Parameters:
object_pp Location to return pointer to new object.
task_p Pointer to a task object.
action_p Pointer to an action reporting object.
gbm_p Pointer to a GBM interface object.
sc_p Pointer to a spacecraft interface object.
lpa_p Pointer to an LPA task interface object.
bulk_p Pointer to a BULK queue object.
db_p Pointer to configuration information.
Returns:
MSG code.

Generated on Thu Oct 30 01:44:29 2008 by  doxygen 1.4.4