GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> LIM / V1-22-4 > lim_scp / rhel6-32
#include <ITC/ITC_pubdefs.h>
#include <PBS/TASK.h>
** CVS $Id: LIM_pubdefs.h,v 1.31 2011/03/29 21:20:27 apw Exp $ **
Defines the public interface to the functions found in the LIM package.
enum _LIM_Action_Id |
Identifiers for actions that can be reported.
enum _LIM_Grb_State |
State of the GRB handler.
enum _LIM_Operating_Mode |
LIM operating modes.
enum _LIM_Other_State |
enum _LIM_Virtual_Mode |
unsigned int LIM_capture_cal | ( | unsigned int | apid, | |
int | start_fc, | |||
int | abort_fc | |||
) |
Capture calibration telecommands with the specified APID.
This function instructs LIM to capture calibration telecommands with the specified APID. If non-negative, LIM handles the telecommands with the start_fc function code as Calibration-Start commands. Likewise, if abort_fc is non-negative, LIM handles the telecommands with that function code as Calibration-Abort commands.
apid | APID to capture. | |
start_fc | Func code of Calibration-Start cmd (-1 if none). | |
abort_fc | Func code of Calibration-Abort cmd (-1 if none). |
A MSG code if an error occurs.
unsigned int LIM_capture_cal_with_db | ( | void | ) |
Capture calibration telecommands using the LIM_DB configuration.
This function is a wrapper for LIM_capture_cal() that uses the LIM_DB configuration database to determine its parameters.
A MSG code if an error occurs.
unsigned int LIM_capture_diag | ( | unsigned int | apid, | |
int | start_fc, | |||
int | abort_fc | |||
) |
Capture diagnostic telecommands with the specified APID.
This function instructs LIM to capture diagnostic telecommands with the specified APID. If non-negative, LIM handles the telecommands with the start_fc function code as Diagnostic-Start commands. Likewise, if abort_fc is non-negative, LIM handles the telecommands with that function code as Diagnostic-Abort commands.
apid | APID to capture. | |
start_fc | Func code of Diagnostic-Start command (-1 if none). | |
abort_fc | Func code of Diagnostic-Abort command (-1 if none). |
A MSG code if an error occurs.
unsigned int LIM_capture_diag_with_db | ( | void | ) |
Capture diagnostic telecommands using the LIM_DB configuration.
This function is a wrapper for LIM_capture_diag() that uses the LIM_DB configuration database to determine its parameters.
A MSG code if an error occurs.
unsigned int LIM_capture_physics | ( | unsigned int | apid, | |
int | start_fc, | |||
int | config_fc, | |||
int | stop_fc | |||
) |
Capture physics telecommands with the specified APID.
This function instructs LIM to capture physics observation telecommands with the specified APID. If non-negative, LIM handles the telecommand with the start_fc function code as the Physics-Start command. Likewise, if config_fc or stop_fc is non-negative, LIM handles the telecommands with those function codes as the Physics-Reconfig and Physics-Abort commands.
apid | APID to capture. | |
start_fc | Function code of Physics-Start cmd (-1 if none). | |
config_fc | Function code of Physics-Config cmd (-1 if none). | |
stop_fc | Function code of Physics-Stop cmd (-1 if none). |
A MSG code if an error occurs.
unsigned int LIM_capture_physics_with_db | ( | void | ) |
Capture physics telecommands using the LIM_DB configuration.
This function is similar to LIM_capture_physics() except that it uses the LIM_DB configuration database to determine its parameters.
A MSG code if an error occurs.
unsigned int LIM_get_info | ( | LIM_Info * | info_p | ) |
Get current LIM state information.
This function returns selected items from the current LIM state.
info_p | Location to return state information (must not be NULL). |
A MSG code if an error occurs.
unsigned int LIM_init_with_db | ( | void | ) |
Initialize the LIM package using CDM.
This function is a wrapper for LIM_initialize that uses CDM to determine its parameters.
A MSG code if an error occurs.
unsigned int LIM_initialize | ( | ITC_TaskID | tid | ) |
Initialize the LIM package.
This function initializes the LIM package using the functions found in LIM_task.c. It should be the first LIM function called when using the LIM package.
tid | ID of the LIM task. |
A MSG code if an error occurs.
unsigned int LIM_shutdown | ( | void | ) |
Shutdown the LIM package.
This function shuts down the LIM package using the functions found in LIM_task.c. It can be called only if the current LIM task state is INITIALIZED, INIT_FAIL, or SHUTDOWN_FAIL. This function should be called when the LIM package is no longer needed.
A MSG code if an error occurs.
unsigned int LIM_start | ( | TASK_attr * | attr_p | ) |
Start the LIM task.
This function starts the LIM task and transitions LIM to the STARTED state. It can be called only if the current LIM state is INITIALIZED. This function should be called after LIM_initialize().
attr_p | Pointer to task attributes. CPU_DB task attributes will be used if this value is NULL. |
A MSG code if an error occurs.
unsigned int LIM_start_with_db | ( | void | ) |
Start the LIM task using CDM.
This function is a wrapper for LIM_start that uses CDM to determine its parameters.
A MSG code if an error occurs.
unsigned int LIM_stop | ( | void | ) |
Stop the LIM task.
This function stops the LIM task and transitions LIM back to the INITIALIZED state. It can be called only if the current LIM state is STARTED, START_FAIL, or STOP_FAIL. This function should be called before LIM_shutdown().
A MSG code if an error occurs.