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

Constituent: lim     Tag: rad750


Interface   Data Structures   File List   Data Fields   Globals  

LIM_sc.h File Reference

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

#include "LIM/LIM_pubdefs.h"
#include "PBS/WCT.h"
#include "LIM_action.h"
#include "LIM_pkt_send.h"
#include "LIM_task.h"

Include dependency graph for LIM_sc.h:

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


Typedefs

typedef _LIM_Sc LIM_Sc
 Typedef for opaque spacecraft interface object handle.

Functions

unsigned int LIM_sc_new (LIM_Sc **object_pp, LIM_Task *task_p, LIM_Bulk *bulk_p, LIM_Action *action_p, LIM_Pkt_Send *pkt_slew_req_cmd_p, LIM_Pkt_Send *pkt_slew_req_tlm_p, LIM_Pkt_Send *pkt_slew_rsp_tlm_p)
 Create and initialize a new spacecraft interface object.
unsigned int LIM_sc_delete (LIM_Sc *object_p)
 Shutdown and delete a spacecraft interface object.
unsigned int LIM_sc_handle_bulk (LIM_Sc *object_p, const ITC_QueueItem *qitem_p)
 Handle a message on the BULK queue.
unsigned int LIM_sc_handle_grb_idle (LIM_Sc *object_p)
 Handle a transition to the GRB-Idle state.
int LIM_sc_rep_is_active (LIM_Sc *object_p)
 Return the ACTIVE status of a repoint.
int LIM_sc_rep_req_is_pending (LIM_Sc *object_p)
 Return the PENDING status of a repoint request.
unsigned int LIM_sc_remain_sec (LIM_Sc *object_p)
 Return the number of seconds remaining in a repoint period.
unsigned int LIM_sc_send_slew_request (LIM_Sc *object_p, LIM_Action_Id action, unsigned int tran_id, unsigned int dwell_time, double ra, double dec)
 Send a Slew-Request command to the spacecraft.
unsigned int LIM_sc_handle_slew_response (LIM_Sc *object_p, const ITC_QueueItem *qitem_p)
 Handle a Slew-Request-Reply message.

Detailed Description

Interface to the functions found in LIM_sc.c.

**  CVS $Id: LIM_sc.h,v 1.5 2007/12/16 23:06:07 dmay Exp $
**  

Function Documentation

unsigned int LIM_sc_delete LIM_Sc object_p  ) 
 

Shutdown and delete a spacecraft interface object.

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

unsigned int LIM_sc_handle_bulk LIM_Sc object_p,
const ITC_QueueItem *  qitem_p
 

Handle a message on the BULK queue.

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

unsigned int LIM_sc_handle_grb_idle LIM_Sc object_p  ) 
 

Handle a transition to the GRB-Idle state.

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

unsigned int LIM_sc_handle_slew_response LIM_Sc object_p,
const ITC_QueueItem *  qitem_p
 

Handle a Slew-Request-Reply message.

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

unsigned int LIM_sc_new LIM_Sc **  object_pp,
LIM_Task task_p,
LIM_Bulk bulk_p,
LIM_Action action_p,
LIM_Pkt_Send pkt_slew_req_cmd_p,
LIM_Pkt_Send pkt_slew_req_tlm_p,
LIM_Pkt_Send pkt_slew_rsp_tlm_p
 

Create and initialize a new spacecraft interface object.

Parameters:
object_pp Location to return pointer to new object.
task_p Ptr to a task object.
bulk_p Ptr to a bulk queue object.
action_p Ptr to an action reporting object.
pkt_slew_req_cmd_p Ptr to Slew-Request cmd pkt send object.
pkt_slew_req_tlm_p Ptr to Slew-Request tlm pkt send object.
pkt_slew_rsp_tlm_p Ptr to Slew-Request resp tlm pkt send object.
Returns:
MSG code.

unsigned int LIM_sc_remain_sec LIM_Sc object_p  ) 
 

Return the number of seconds remaining in a repoint period.

Parameters:
object_p Pointer to spacecraft interface object.
Returns:
Number of seconds remaining in the repoint period.

int LIM_sc_rep_is_active LIM_Sc object_p  ) 
 

Return the ACTIVE status of a repoint.

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

int LIM_sc_rep_req_is_pending LIM_Sc object_p  ) 
 

Return the PENDING status of a repoint request.

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

unsigned int LIM_sc_send_slew_request LIM_Sc object_p,
LIM_Action_Id  action,
unsigned int  tran_id,
unsigned int  dwell_time,
double  ra,
double  dec
 

Send a Slew-Request command to the spacecraft.

Parameters:
object_p Pointer to spacecraft interface object.
action Action to report.
tran_id Transaction ID value for the command.
dwell_time Dwell Time value for the command.
ra RA value for the command.
dec DEC value for the command.
Returns:
MSG code.


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