---

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

Constituent: lim     Tag: rad750

---

         

---

LIM_too.h File Reference

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

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

Include dependency graph for LIM_too.h:

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

Typedefs
typedef _LIM_Too	LIM_Too
	Typedef for opaque TOO observation object handle.
Functions
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.
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

Interface to the functions found in LIM_too.c.

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

---

Function Documentation

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_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.

---