---

GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LIM / V1-22-0 > lim / linux-gcc

---

         

---

LIM_action.h File Reference

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

#include "LIM/LIM_pubdefs.h"
#include "LIM_pkt_send.h"
#include "LIM_task.h"

Typedefs
typedef struct _LIM_Action	LIM_Action
	Typedef for opaque LIM action object handle.
Functions
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

Interface to the functions found in LIM_action.c.

**  CVS $Id: LIM_action.h,v 1.3 2005/09/07 21:51:04 dmay Exp $
**  

---

Function Documentation

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.

---