LIM_ltc.c File Reference

Handle LIM interactions with the LTC task. More...

#include <string.h>
#include <ITC/ITC_cmddefs.h>
#include <LIM/LIM_msgs.h>
#include <LIM/LIM_pubdefs.h>
#include <LTC/LTC_cmddefs.h>
#include <MSG/MSG_pubdefs.h>
#include <PBS/MBA.h>
#include <LIM_action.h>
#include <LIM_ltc.h>
#include <LIM_pkt_send.h>

Classes
struct	_LIM_Ltc
	State information for an LTC task object. More...
Defines
#define	LIM_LTC_VALID_KEY   (('L'<<24)+('L'<<16)+('T'<<8)+'C')
	Value that indicates the LTC task object state is valid.
Functions
static unsigned int	lim_ltc_check (LIM_Ltc *object_p)
	Validate an LTC task object pointer.
unsigned int	LIM_ltc_new (LIM_Ltc **object_pp, LIM_Action *action_p, LIM_Pkt_Send *pkt_stop_p, unsigned int ltc_stop_apid, char *desc)
	Create and initialize a new LTC task object.
unsigned int	LIM_ltc_delete (LIM_Ltc *object_p)
	Shutdown and delete an LTC task object.
unsigned int	LIM_ltc_send_stop (LIM_Ltc *object_p)
	Send a Stop command to the LTC task.

---

Detailed Description

Handle LIM interactions with the LTC task.

**  CVS $Id: LIM_ltc.c,v 1.7 2011/03/29 21:20:28 apw Exp $
**  

These are functions related to the interface with the LTC task.

---

Function Documentation

unsigned int lim_ltc_check

(

LIM_Ltc *

object_p

)

[static]

Validate an LTC task object pointer.

Parameters:

object_p

Pointer to LTC task object.

Returns:

MSG code.

References _LIM_Ltc::key, and LIM_LTC_VALID_KEY.

Referenced by LIM_ltc_delete(), and LIM_ltc_send_stop().

unsigned int LIM_ltc_delete

(

LIM_Ltc *

object_p

)

Shutdown and delete an LTC task object.

Parameters:

object_p

Pointer to object.

Returns:

MSG code.

References _LIM_Ltc::desc, _LIM_Ltc::key, and lim_ltc_check().

Referenced by LIM_ltc_new(), and LIM_mode_delete().

unsigned int LIM_ltc_new	(	LIM_Ltc **	object_pp,
		LIM_Action *	action_p,
		LIM_Pkt_Send *	pkt_stop_p,
		unsigned int	ltc_stop_apid,
		char *	desc
	)

Create and initialize a new LTC task object.

Parameters:

	object_pp	Location to return pointer to new object.
	action_p	Pointer to an action reporting object.
	pkt_stop_p	Pointer to Stop command packet sending object.
	ltc_stop_apid	APID of the LTC-Stop command.
	desc	Description of the new object.

Returns:

MSG code.

References _LIM_Ltc::action_p, _LIM_Ltc::desc, _LIM_Ltc::key, LIM_ltc_delete(), LIM_LTC_VALID_KEY, LIM_pkt_set_info(), and _LIM_Ltc::pkt_stop_p.

Referenced by LIM_mode_new().

unsigned int LIM_ltc_send_stop

(

LIM_Ltc *

object_p

)

Send a Stop command to the LTC task.

Parameters:

object_p

Pointer to LTC task object.

Returns:

MSG code.

References _LIM_Ltc::action_p, LIM_ACTION_LTC_STOP, LIM_action_report(), lim_ltc_check(), LIM_pkt_send_cmd(), and _LIM_Ltc::pkt_stop_p.

Referenced by lim_mode_stop_activity().