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>

Classes
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.13 2011/03/29 21:20:28 apw 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.

References _LIM_Action::key, and LIM_ACTION_VALID_KEY.

Referenced by LIM_action_delete(), LIM_action_get_info(), and LIM_action_report().

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.

References _LIM_Action::key, and lim_action_check().

Referenced by LIM_shutdown().

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.

References _LIM_Action::last_action, _LIM_Info::last_action, _LIM_Action::last_status, _LIM_Info::last_status, and lim_action_check().

Referenced by LIM_get_info().

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.

References _LIM_Action::key, LIM_ACTION_VALID_KEY, LIM_pkt_set_info(), _LIM_Action::lim_state_p, LIM_STATE_TLM_APID, and _LIM_Action::task_p.

Referenced by LIM_initialize().

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.

References _LIM_State_Tlm::action, _LIM_Info::arr_active, _LIM_Info::arr_ready, _LIM_Info::arr_remain_sec, _LIM_State_Tlm::arr_remain_sec, _LIM_State_Tlm::arr_state, _LIM_THVCONFIGBF::bf, _LIM_TGBMCONFIGBF::bf, _LIM_TARRSTATEBF::bf, _LIM_TTOOSTATEBF::bf, _LIM_State_Tlm::gbm_config, _LIM_Info::gbm_int_dis_remain_sec, _LIM_State_Tlm::gbm_int_dis_remain_sec, _LIM_Info::gbm_pri_int_allowed, _LIM_Info::gbm_red_int_allowed, _LIM_Info::gbm_rep_allowed, _LIM_Info::grb_state, _LIM_Info::hv_allowed, _LIM_State_Tlm::hv_config, _LIM_Info::last_action, _LIM_Action::last_action, _LIM_Info::last_status, _LIM_Action::last_status, _LIM_Info::lci_state, _LIM_State_Tlm::lci_state, _LIM_Info::ldf_state, _LIM_State_Tlm::ldf_state, lim_action_check(), LIM_get_info(), LIM_pkt_send_tlm(), _LIM_Action::lim_state_p, LIM_task_lock_access(), LIM_task_unlock_access(), _LIM_Info::lpa_state, _LIM_State_Tlm::lpa_state, _LIM_Info::op_mode, _LIM_State_Tlm::op_mode, _LIM_Info::rep_req_pending, _LIM_Info::saa_transit, _LIM_State_Tlm::saa_transit, _LIM_State_Tlm::status, _LIM_Action::task_p, _LIM_Info::too_active, _LIM_Info::too_ready, _LIM_Info::too_remain_sec, _LIM_State_Tlm::too_remain_sec, _LIM_Info::too_started, _LIM_State_Tlm::too_state, _LIM_Info::virt_mode, and _LIM_State_Tlm::virt_mode.

Referenced by lim_arr_change_grb_state(), LIM_arr_handle_confirmed(), LIM_arr_handle_finished(), LIM_arr_handle_suspected(), LIM_gbm_change_pri_int_allowed(), LIM_gbm_change_red_int_allowed(), LIM_gbm_change_rep_allowed(), LIM_gbm_handle_bulk(), LIM_gbm_handle_calcinfo(), LIM_gbm_handle_closeout(), LIM_gbm_handle_repoint(), LIM_lpa_gbm_int(), LIM_lpa_handle_complete(), LIM_lpa_set_mode(), LIM_ltc_send_stop(), lim_mode_cal_complete(), lim_mode_change_hv_allowed(), lim_mode_change_op_mode(), lim_mode_change_saa(), lim_mode_grb_confirmed(), lim_mode_grb_finished(), lim_mode_load_shed(), lim_other_change_state(), LIM_other_fwd_active(), LIM_other_fwd_idle(), LIM_other_fwd_stop(), LIM_other_handle_bulk(), LIM_other_send_start(), LIM_other_send_stop(), LIM_pid_int_disable_gbm(), LIM_pid_int_enable_gbm(), LIM_pid_select(), LIM_pig_bias_acd(), LIM_pig_bias_acd_off(), LIM_pig_bias_acd_on(), LIM_pig_bias_cal(), LIM_pig_bias_cal_off(), LIM_pig_bias_cal_on(), LIM_pig_bias_tkr(), LIM_pig_bias_tkr_off(), LIM_pig_bias_tkr_on(), LIM_pig_extract(), LIM_pig_extract_evt(), LIM_pig_insert(), LIM_pig_insert_evt(), LIM_pig_saa_enter(), LIM_pig_saa_exit(), LIM_pig_shed(), LIM_pig_siu_init(), lim_sc_change_state(), LIM_sc_handle_slew_response(), LIM_sc_send_slew_request(), LIM_start(), LIM_stop(), lim_too_change_ready(), and lim_too_change_started().