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_too.c File Reference

Handle TOO mode observations. More...

#include "string.h"
#include "CCSDS/CCSDS_pkt.h"
#include "ITC/ITC_pubdefs.h"
#include "LIM/LIM_cmddefs.h"
#include "LIM/LIM_msgs.h"
#include "LIM/LIM_pubdefs.h"
#include "MSG/MSG_pubdefs.h"
#include "PBS/MBA.h"
#include "PBS/WCT.h"
#include "PBS/WUT.h"
#include "LIM_action.h"
#include "LIM_bulk.h"
#include "LIM_lpa.h"
#include "LIM_too.h"
#include "LIM_pkt_send.h"
#include "LIM_task.h"

Include dependency graph for LIM_too.c:


Data Structures

struct  _LIM_Too
 State information for a TOO observation object. More...

Defines

#define LIM_TOO_VALID_KEY   (('L'<<24)+('T'<<16)+('O'<<8)+'O')
 Value that indicates the TOO observation object state is valid.

Functions

static unsigned int lim_too_check (LIM_Too *object_p)
 Validate a TOO observation object pointer.
static unsigned int lim_too_change_ready (LIM_Too *object_p, int new_ready, unsigned int new_start_sec, unsigned int new_duration)
 Change the READY, START_SEC, and DURATION values of an object.
static unsigned int lim_too_change_started (LIM_Too *object_p, int new_state)
 Change the STARTED status of the object.
static WUT_cb_status lim_too_wut_handler (void *prm, WUT_tmr *wut)
 Handle wake-up timer expiration.
unsigned int LIM_too_new (LIM_Too **object_pp, LIM_Task *task_p, LIM_Action *action_p, LIM_Lpa *lpa_p, LIM_Bulk *bulk_p)
 Create and initialize a new TOO observation object.
unsigned int LIM_too_delete (LIM_Too *object_p)
 Shutdown and delete a TOO observation object.
int LIM_too_has_started (LIM_Too *object_p)
 Return the STARTED status of a TOO observation.
int LIM_too_is_ready (LIM_Too *object_p)
 Return the READY status of a TOO observation.
unsigned int LIM_too_remain_sec (LIM_Too *object_p)
 Return the number of seconds remaining in a TOO observation.
static unsigned int lim_too_expire (LIM_Too *object_p)
 End a TOO observation.
unsigned int LIM_too_handle_abort (LIM_Too *object_p, const ITC_QueueItem *qitem_p)
 Handle a TOO-Abort command.
unsigned int LIM_too_handle_bulk (LIM_Too *object_p, const ITC_QueueItem *qitem_p)
 Handle a message on the BULK queue.
unsigned int LIM_too_handle_physics_start (LIM_Too *object_p, const ITC_QueueItem *qitem_p)
 Handle a PHYSICS-START command in TOO mode.
unsigned int LIM_too_handle_start (LIM_Too *object_p, const ITC_QueueItem *qitem_p, int start_ok)
 Handle a TOO-Start command.

Detailed Description

Handle TOO mode observations. 

**  CVS $Id: LIM_too.c,v 1.17 2007/02/13 21:16:15 dmay Exp $
**

Function Documentation

unsigned int lim_too_change_ready (  LIM_Too *  object_p,
int  new_ready,
unsigned int  new_start_sec,
unsigned int  new_duration
)  [static]
 

Change the READY, START_SEC, and DURATION values of an object.

Parameters:
object_p Pointer to TOO observation object.
new_ready New READY status.
new_start_sec New START_SEC value.
new_duration New DURATION value.
Returns:
MSG code.

unsigned int lim_too_change_started (  LIM_Too *  object_p,
int  new_state
)  [static]
 

Change the STARTED status of the object.

Parameters:
object_p Pointer to TOO observation object.
new_state New STARTED status.
Returns:
MSG code.

unsigned int lim_too_check (  LIM_Too *  object_p  )  [static]
 

Validate a TOO observation object pointer.

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

unsigned int LIM_too_delete (  LIM_Too *  object_p  ) 
 

Shutdown and delete a TOO observation object.

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

unsigned int lim_too_expire (  LIM_Too *  object_p  )  [static]
 

End a TOO observation.

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

unsigned int LIM_too_handle_abort (  LIM_Too *  object_p,
const ITC_QueueItem *  qitem_p
) 
 

Handle a TOO-Abort command.

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

unsigned int LIM_too_handle_bulk (  LIM_Too *  object_p,
const ITC_QueueItem *  qitem_p
) 
 

Handle a message on the BULK queue.

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

unsigned int LIM_too_handle_physics_start (  LIM_Too *  object_p,
const ITC_QueueItem *  qitem_p
) 
 

Handle a PHYSICS-START command in TOO mode.

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

unsigned int LIM_too_handle_start (  LIM_Too *  object_p,
const ITC_QueueItem *  qitem_p,
int  start_ok
) 
 

Handle a TOO-Start command.

Parameters:
object_p Pointer to TOO observation object.
qitem_p Pointer to queue item containing the command.
start_ok Flag indicating that a PHYSICS-START cmd can be sent.
Returns:
MSG code.

int LIM_too_has_started (  LIM_Too *  object_p  ) 
 

Return the STARTED status of a TOO observation.

Parameters:
object_p Pointer to TOO observation object.
Returns:
Nonzero if the observation has STARTED.

int LIM_too_is_ready (  LIM_Too *  object_p  ) 
 

Return the READY status of a TOO observation.

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

unsigned int LIM_too_new (  LIM_Too **  object_pp,
LIM_Task *  task_p,
LIM_Action *  action_p,
LIM_Lpa *  lpa_p,
LIM_Bulk *  bulk_p
) 
 

Create and initialize a new TOO 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.
lpa_p Pointer to an LPA task interface object.
bulk_p Pointer to a BULK queue object.
Returns:
MSG code.

unsigned int LIM_too_remain_sec (  LIM_Too *  object_p  ) 
 

Return the number of seconds remaining in a TOO observation.

Parameters:
object_p Pointer to TOO observation object.
Returns:
Number of seconds remaining in the TOO observation.

WUT_cb_status lim_too_wut_handler (  void *  prm,
WUT_tmr *  wut
)  [static]
 

Handle wake-up timer expiration.

Parameters:
prm Pointer to TOO observation object.
wut Pointer to wake-up timer.
Returns:
WUT status.

Generated on Thu Oct 30 01:45:40 2008 by  doxygen 1.4.4