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

Action reporting for the LIM package. More...

#include "string.h"
#include "LIM/LIM_msgs.h"
#include "LIM/LIM_tlmdefs.h"
#include "MSG/MSG_pubdefs.h"
#include "PBS/MBA.h"
#include "LIM_action.h"
#include "LIM_pkt_send.h"
#include "LIM_task.h"

Include dependency graph for LIM_action.c:


Data Structures

struct  _LIM_Action
 State information for a LIM action object. More...

Defines

#define LIM_ACTION_VALID_KEY   (('L'<<24)+('A'<<16)+('C'<<8)+'T')
 Value that indicates LIM action object state is valid.

Functions

static unsigned int lim_action_check (LIM_Action *object_p)
 Validate a LIM action object pointer.
unsigned int LIM_action_new (LIM_Action **object_pp, LIM_Task *task_p, LIM_Pkt_Send *lim_state_p)
 Create and initialize a new action object.
unsigned int LIM_action_delete (LIM_Action *object_p)
 Shutdown and delete an action object.
unsigned int LIM_action_report (LIM_Action *object_p, LIM_Action_Id id, unsigned int report_status)
 Report an action by the LIM package.
unsigned int LIM_action_get_info (LIM_Action *object_p, LIM_Info *info_p)
 Return information about most recent LIM action.

Detailed Description

Action reporting for the LIM package.

**  CVS $Id: LIM_action.c,v 1.12 2008/01/13 19:09:40 dmay Exp $
**  

These functions report actions performed by the LIM package.


Function Documentation

unsigned int lim_action_check LIM_Action object_p  )  [static]
 

Validate a LIM action object pointer.

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

unsigned int LIM_action_delete LIM_Action object_p  ) 
 

Shutdown and delete an action object.

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

unsigned int LIM_action_get_info LIM_Action object_p,
LIM_Info info_p
 

Return information about most recent LIM action.

Parameters:
object_p Pointer to LIM action object.
info_p Location to return action information (must not be NULL).
Returns:
MSG code.

unsigned int LIM_action_new LIM_Action **  object_pp,
LIM_Task task_p,
LIM_Pkt_Send lim_state_p
 

Create and initialize a new action object.

Parameters:
object_pp Location to return pointer to new object.
task_p Pointer to a task object.
lim_state_p Pointer to a LIM-State telemetry pkt sending object.
Returns:
MSG code.

unsigned int LIM_action_report LIM_Action object_p,
LIM_Action_Id  id,
unsigned int  report_status
 

Report an action by the LIM package.

Parameters:
object_p Pointer to action object.
id ID of the action to report.
report_status MSG status code to report with the action.
Returns:
MSG code.


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