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>

Typedefs
typedef struct _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.8 2011/03/29 21:20:29 apw 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.

References _LIM_Too::key, lim_too_check(), and _LIM_Too::wut.

Referenced by LIM_mode_delete(), and LIM_too_new().

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.

References lim_too_check(), and lim_too_expire().

Referenced by lim_mode_too_abort().

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.

References _LIM_Too::expired, lim_too_check(), lim_too_expire(), and _LIM_Too::ready.

Referenced by lim_mode_bulk().

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.

References _LIM_Too::consign, _LIM_Too::cpu_mask, _LIM_Too::db, _LIM_Too::ignore, _LIM_Too::latc, LIM_lpa_get_start_parms(), LIM_LPA_MODE_TOO, LIM_lpa_send_start(), lim_too_change_started(), lim_too_check(), _LIM_Too::lpa_p, and _LIM_Too::started.

Referenced by lim_mode_physics_start().

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.

References _LIM_TOO_Start_Prm::consign, _LIM_Too::consign, _LIM_Too::cpu_mask, _LIM_TOO_Start_Prm::cpus, _LIM_TOO_Start_Prm::db, _LIM_Too::db, _LIM_Too::duration, _LIM_TOO_Start_Prm::ignore, _LIM_Too::ignore, _LIM_TOO_Start_Prm::latc, _LIM_Too::latc, LIM_LPA_MODE_TOO, LIM_lpa_send_start(), lim_too_change_ready(), lim_too_change_started(), lim_too_check(), lim_too_wut_handler(), _LIM_Too::lpa_p, _LIM_TOO_Start_Prm::observation_id, _LIM_Too::observation_id, _LIM_TOO_Start_Pkt::pay, _LIM_Too::ready, _LIM_TOO_Start_Prm::seconds, and _LIM_Too::wut.

Referenced by lim_mode_too_start().

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.

References lim_too_check(), and _LIM_Too::started.

Referenced by LIM_mode_get_info().

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.

References lim_too_check(), and _LIM_Too::ready.

Referenced by LIM_mode_get_info(), and lim_mode_target_mode().

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.

References _LIM_Too::action_p, _LIM_Too::bulk_p, _LIM_Too::key, LIM_too_delete(), LIM_TOO_VALID_KEY, _LIM_Too::lpa_p, _LIM_Too::ready, _LIM_Too::started, _LIM_Too::task_p, and _LIM_Too::wut.

Referenced by LIM_mode_new().

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.

References _LIM_Too::duration, lim_too_check(), _LIM_Too::ready, and _LIM_Too::start_sec.

Referenced by LIM_mode_get_info().