LIH_cmddefs.h File Reference

Structures associated with CCSDS commands to subsystem LIH \ This file was auto-generated on Wed 27 Aug 2008 03:10:36 PM PDT \ LCAT version: V1-23-1. More...

#include <PBI/Endianness.h>

Classes
struct	_LIH_LIHACTION_Bfl
	LIH transition action description. More...
union	_LIH_LIHACTION
	Union for command bitfield _LIH_LIHACTION_Bfl. More...
struct	_LIH_LoadLimits_Prm
	Load ADC limit sets from CDM database \ APID 0x654 \ function code 1. More...
struct	_LIH_EnableActions_Prm
	Enable/disable actions on ADC state changes \ APID 0x654 \ function code 2. More...
struct	_LIH_SetLimitsAdc_Prm
	Set limits boundaries for an ADC \ APID 0x654 \ function code 3. More...
struct	_LIH_SetActionsAdc_Prm
	Set actions for a limit transition on an ADC \ APID 0x654 \ function code 4. More...
struct	_LIH_SetNagTimesAdc_Prm
	Set the nag periods for an ADC \ APID 0x654 \ function code 5. More...
struct	_LIH_SetPersistAdc_Prm
	Set persistence time (msec) on an ADC \ APID 0x654 \ function code 6. More...
struct	_LIH_SetSettleAdc_Prm
	Set the maximum settling period (msec) for an ADC \ APID 0x654 \ function code 7. More...
struct	_LIH_DumpLimitsAdc_Prm
	Dump the limits table for a single ADC \ APID 0x654 \ function code 8. More...
struct	_LIH_DumpLimits_Prm
	Dump the complete limits table \ APID 0x654 \ function code 9. More...
struct	_LIH_Noop_Pkt
	No operation \ APID 0x654 \ function code 0. More...
struct	_LIH_LoadLimits_Pkt
	Load ADC limit sets from CDM database \ APID 0x654 \ function code 1. More...
struct	_LIH_EnableActions_Pkt
	Enable/disable actions on ADC state changes \ APID 0x654 \ function code 2. More...
struct	_LIH_SetLimitsAdc_Pkt
	Set limits boundaries for an ADC \ APID 0x654 \ function code 3. More...
struct	_LIH_SetActionsAdc_Pkt
	Set actions for a limit transition on an ADC \ APID 0x654 \ function code 4. More...
struct	_LIH_SetNagTimesAdc_Pkt
	Set the nag periods for an ADC \ APID 0x654 \ function code 5. More...
struct	_LIH_SetPersistAdc_Pkt
	Set persistence time (msec) on an ADC \ APID 0x654 \ function code 6. More...
struct	_LIH_SetSettleAdc_Pkt
	Set the maximum settling period (msec) for an ADC \ APID 0x654 \ function code 7. More...
struct	_LIH_DumpLimitsAdc_Pkt
	Dump the limits table for a single ADC \ APID 0x654 \ function code 8. More...
struct	_LIH_DumpLimits_Pkt
	Dump the complete limits table \ APID 0x654 \ function code 9. More...
Typedefs
typedef enum _LIH_LIHADCLMTSTATES	LIH_LIHADCLMTSTATES
	Typedef for enumeration _LIH_LIHADCLMTSTATES.
typedef enum _LIH_LIHENABLESTATES	LIH_LIHENABLESTATES
	Typedef for enumeration _LIH_LIHENABLESTATES.
typedef enum _LIH_LIHADCACTENABLES	LIH_LIHADCACTENABLES
	Typedef for enumeration _LIH_LIHADCACTENABLES.
typedef enum _LIH_LIHADCACTMSG	LIH_LIHADCACTMSG
	Typedef for enumeration _LIH_LIHADCACTMSG.
typedef struct _LIH_LIHACTION_Bfl	LIH_LIHACTION_Bfl
	Typedef for command bitfield structure _LIH_LIHACTION_Bfl.
typedef union _LIH_LIHACTION	LIH_LIHACTION
	Typedef for union _LIH_LIHACTION.
typedef struct _LIH_LoadLimits_Prm	LIH_LoadLimits_Prm
	Typedef for structure _LIH_LoadLimits_Prm.
typedef struct _LIH_EnableActions_Prm	LIH_EnableActions_Prm
	Typedef for structure _LIH_EnableActions_Prm.
typedef struct _LIH_SetLimitsAdc_Prm	LIH_SetLimitsAdc_Prm
	Typedef for structure _LIH_SetLimitsAdc_Prm.
typedef struct _LIH_SetActionsAdc_Prm	LIH_SetActionsAdc_Prm
	Typedef for structure _LIH_SetActionsAdc_Prm.
typedef struct _LIH_SetNagTimesAdc_Prm	LIH_SetNagTimesAdc_Prm
	Typedef for structure _LIH_SetNagTimesAdc_Prm.
typedef struct _LIH_SetPersistAdc_Prm	LIH_SetPersistAdc_Prm
	Typedef for structure _LIH_SetPersistAdc_Prm.
typedef struct _LIH_SetSettleAdc_Prm	LIH_SetSettleAdc_Prm
	Typedef for structure _LIH_SetSettleAdc_Prm.
typedef struct _LIH_DumpLimitsAdc_Prm	LIH_DumpLimitsAdc_Prm
	Typedef for structure _LIH_DumpLimitsAdc_Prm.
typedef struct _LIH_DumpLimits_Prm	LIH_DumpLimits_Prm
	Typedef for structure _LIH_DumpLimits_Prm.
typedef struct _LIH_Noop_Pkt	LIH_Noop_Pkt
	Typedef for packet _LIH_Noop_Pkt.
typedef struct _LIH_LoadLimits_Pkt	LIH_LoadLimits_Pkt
	Typedef for packet _LIH_LoadLimits_Pkt.
typedef struct _LIH_EnableActions_Pkt	LIH_EnableActions_Pkt
	Typedef for packet _LIH_EnableActions_Pkt.
typedef struct _LIH_SetLimitsAdc_Pkt	LIH_SetLimitsAdc_Pkt
	Typedef for packet _LIH_SetLimitsAdc_Pkt.
typedef struct _LIH_SetActionsAdc_Pkt	LIH_SetActionsAdc_Pkt
	Typedef for packet _LIH_SetActionsAdc_Pkt.
typedef struct _LIH_SetNagTimesAdc_Pkt	LIH_SetNagTimesAdc_Pkt
	Typedef for packet _LIH_SetNagTimesAdc_Pkt.
typedef struct _LIH_SetPersistAdc_Pkt	LIH_SetPersistAdc_Pkt
	Typedef for packet _LIH_SetPersistAdc_Pkt.
typedef struct _LIH_SetSettleAdc_Pkt	LIH_SetSettleAdc_Pkt
	Typedef for packet _LIH_SetSettleAdc_Pkt.
typedef struct _LIH_DumpLimitsAdc_Pkt	LIH_DumpLimitsAdc_Pkt
	Typedef for packet _LIH_DumpLimitsAdc_Pkt.
typedef struct _LIH_DumpLimits_Pkt	LIH_DumpLimits_Pkt
	Typedef for packet _LIH_DumpLimits_Pkt.
typedef enum _LIH_Apid654Fcodes	LIH_Apid654Fcodes
	Typedef for enumeration _LIH_Apid654Fcodes.
Enumerations
enum	_LIH_LIHADCLMTSTATES {   LIH_LIHADCLMTSTATES_LIHUNKNOWNST = 0,   LIH_LIHADCLMTSTATES_LIHREDLOWST = 1,   LIH_LIHADCLMTSTATES_LIHYELLOWLOWST = 2,   LIH_LIHADCLMTSTATES_LIHGREENST = 3,   LIH_LIHADCLMTSTATES_LIHYELLOWHIGHST = 4,   LIH_LIHADCLMTSTATES_LIHREDHIGHST = 5,   LIH_LIHADCLMTSTATES_LIHPURPLEST = 6,   LIH_LIHADCLMTSTATES_LIHUNSTABLEST = 7 }
	Enumeration of ADC limit evaluation states. More...
enum	_LIH_LIHENABLESTATES {   LIH_LIHENABLESTATES_LIHENABLE = 1,   LIH_LIHENABLESTATES_LIHDISABLE = 0 }
	A disabled/enabled enumeration. More...
enum	_LIH_LIHADCACTENABLES {   LIH_LIHADCACTENABLES_LIHADCACTNOCHNG = -1,   LIH_LIHADCACTENABLES_LIHADCACTENABLE = 1,   LIH_LIHADCACTENABLES_LIHADCACTDISABLE = 0 }
	Enumeration of action enables. More...
enum	_LIH_LIHADCACTMSG {   LIH_LIHADCACTMSG_LIHACTNOCHNG = -1,   LIH_LIHADCACTMSG_LIHSEVINFO = 1,   LIH_LIHADCACTMSG_LIHSEVWARN = 2,   LIH_LIHADCACTMSG_LIHSEVERROR = 3,   LIH_LIHADCACTMSG_LIHSEVNONE = 0 }
	Enumeration of message severity flags. More...
enum	_LIH_Apid654Fcodes {   LIH_NOOP_FCODE = 0,   LIH_LOADLIMITS_FCODE = 1,   LIH_ENABLEACTIONS_FCODE = 2,   LIH_SETLIMITSADC_FCODE = 3,   LIH_SETACTIONSADC_FCODE = 4,   LIH_SETNAGTIMESADC_FCODE = 5,   LIH_SETPERSISTADC_FCODE = 6,   LIH_SETSETTLEADC_FCODE = 7,   LIH_DUMPLIMITSADC_FCODE = 8,   LIH_DUMPLIMITS_FCODE = 9 }
	Function code enumerations for apid 0x654. More...
Functions
unsigned int	LIH_Noop (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "Noop" command.
unsigned int	LIH_LoadLimits (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function to "load a new limits file" command.
unsigned int	LIH_EnableActions (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "enable/disable actions on an ADC" command.
unsigned int	LIH_SetLimitsAdc (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "set new limits for an ADC" command.
unsigned int	LIH_SetActionsAdc (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "set new actions for an ADC" command.
unsigned int	LIH_SetNagTimesAdc (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "set new limits for an ADC" command.
unsigned int	LIH_SetPersistAdc (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "set persistence for an ADC" command.
unsigned int	LIH_SetSettleAdc (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "set persistence for an ADC" command.
unsigned int	LIH_DumpLimitsAdc (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "enable/disable actions on an ADC" command.
unsigned int	LIH_DumpLimits (void *prm, const struct _ITC_QueueItem *qitem, void *pay, unsigned int len)
	Callback function for the "enable/disable actions on an ADC" command.

---

Detailed Description

Structures associated with CCSDS commands to subsystem LIH \ This file was auto-generated on Wed 27 Aug 2008 03:10:36 PM PDT \ LCAT version: V1-23-1.

Warning:

Machine generated code - NEVER edit by hand

---

Enumeration Type Documentation

enum _LIH_Apid654Fcodes

Function code enumerations for apid 0x654.

Enumerator:

LIH_NOOP_FCODE	APID 0x654 function code 0
LIH_LOADLIMITS_FCODE	APID 0x654 function code 1
LIH_ENABLEACTIONS_FCODE	APID 0x654 function code 2
LIH_SETLIMITSADC_FCODE	APID 0x654 function code 3
LIH_SETACTIONSADC_FCODE	APID 0x654 function code 4
LIH_SETNAGTIMESADC_FCODE	APID 0x654 function code 5
LIH_SETPERSISTADC_FCODE	APID 0x654 function code 6
LIH_SETSETTLEADC_FCODE	APID 0x654 function code 7
LIH_DUMPLIMITSADC_FCODE	APID 0x654 function code 8
LIH_DUMPLIMITS_FCODE	APID 0x654 function code 9

enum _LIH_LIHADCACTENABLES

Enumeration of action enables.

Enumerator:

LIH_LIHADCACTENABLES_LIHADCACTNOCHNG	Don't change state of this action
LIH_LIHADCACTENABLES_LIHADCACTENABLE	Enable this action
LIH_LIHADCACTENABLES_LIHADCACTDISABLE	Disable this action

enum _LIH_LIHADCACTMSG

Enumeration of message severity flags.

Enumerator:

LIH_LIHADCACTMSG_LIHACTNOCHNG	Don't change the severity
LIH_LIHADCACTMSG_LIHSEVINFO	Set severity level to information
LIH_LIHADCACTMSG_LIHSEVWARN	Set severity level warning
LIH_LIHADCACTMSG_LIHSEVERROR	Set severity level error
LIH_LIHADCACTMSG_LIHSEVNONE	Disable sending messages

enum _LIH_LIHADCLMTSTATES

Enumeration of ADC limit evaluation states.

Enumerator:

LIH_LIHADCLMTSTATES_LIHUNKNOWNST	ADC was not evaluated against limits
LIH_LIHADCLMTSTATES_LIHREDLOWST	ADC evaluated below low red limit
LIH_LIHADCLMTSTATES_LIHYELLOWLOWST	ADC evaluated below low yellow limit
LIH_LIHADCLMTSTATES_LIHGREENST	ADC evaluted within green limits
LIH_LIHADCLMTSTATES_LIHYELLOWHIGHST	ADC evaluated above high yellow limit
LIH_LIHADCLMTSTATES_LIHREDHIGHST	ADC evaluated above high red limit
LIH_LIHADCLMTSTATES_LIHPURPLEST	ADC evaluated to a non-physical value
LIH_LIHADCLMTSTATES_LIHUNSTABLEST	ADC reading is unstable

enum _LIH_LIHENABLESTATES

A disabled/enabled enumeration.

Enumerator:

LIH_LIHENABLESTATES_LIHENABLE	Enable
LIH_LIHENABLESTATES_LIHDISABLE	Disable

---

Function Documentation

unsigned int LIH_DumpLimits	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the "enable/disable actions on an ADC" command.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

Return value from LIH_limitSendAll()

References _LIH_DumpLimits_Prm::ident, LIH_K_SRC_COMMAND, LIH_limitSendAll(), _LIH_DumpLimits_Pkt::pay, and _LIH_DumpLimits_Prm::reason.

unsigned int LIH_DumpLimitsAdc	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the "enable/disable actions on an ADC" command.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

Return value from LIH_limitSendAdc()

References _LIH_DumpLimitsAdc_Prm::adx, LIH_limitSendAdc(), and _LIH_DumpLimitsAdc_Pkt::pay.

unsigned int LIH_EnableActions	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the "enable/disable actions on an ADC" command.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

Return value from LIH_limitAble()

References LIH_limitAble(), _LIH_EnableActions_Pkt::pay, and _LIH_EnableActions_Prm::state.

unsigned int LIH_LoadLimits	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function to "load a new limits file" command.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

References _LIH_LoadLimits_Prm::fileID, LIH_hcb, LIH_limitCheckCDM(), LIH_limitExternalDefault(), LIH_limitExternalTable(), and _LIH_LoadLimits_Pkt::pay.

unsigned int LIH_Noop	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the "Noop" command.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Return values:

LIH_SUCCESS

Success

unsigned int LIH_SetActionsAdc	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the "set new actions for an ADC" command.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

Return code from LIH_limitAction()

References _LIH_SetActionsAdc_Prm::adx, _LIH_SetActionsAdc_Prm::alert, _LIH_SetActionsAdc_Prm::diag, _LIH_SetActionsAdc_Prm::from, LIH_limitAction(), LIH_limitSendAdc(), _LIH_SetActionsAdc_Prm::msg, _LIH_SetActionsAdc_Pkt::pay, and _LIH_SetActionsAdc_Prm::to.

unsigned int LIH_SetLimitsAdc	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the "set new limits for an ADC" command.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

Return code from LIH_limitLimit()

References _LIH_SetLimitsAdc_Prm::adx, LIH_limitLimit(), LIH_limitSendAdc(), _LIH_SetLimitsAdc_Prm::limit, and _LIH_SetLimitsAdc_Pkt::pay.

unsigned int LIH_SetNagTimesAdc	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the "set new limits for an ADC" command.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

Return code from LIH_limitNag()

References _LIH_SetNagTimesAdc_Prm::adx, LIH_limitNag(), LIH_limitSendAdc(), _LIH_SetNagTimesAdc_Prm::nag, and _LIH_SetNagTimesAdc_Pkt::pay.

unsigned int LIH_SetPersistAdc	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the "set persistence for an ADC" command.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

Return code from LIH_limitPersist()

References _LIH_SetPersistAdc_Prm::adx, LIH_limitPersist(), LIH_limitSendAdc(), _LIH_SetPersistAdc_Pkt::pay, and _LIH_SetPersistAdc_Prm::persist.

unsigned int LIH_SetSettleAdc	(	void *	prm,
		const struct _ITC_QueueItem *	qitem,
		void *	pay,
		unsigned int	len
	)

Callback function for the "set persistence for an ADC" command.

Parameters:

	prm	(in) User context parameter
	qitem	(in) Queue item
	pay	(in) Payload pointer
	len	(in) Payload length

Returns:

Return code from LIH_limitSettle()

References _LIH_SetSettleAdc_Prm::adx, LIH_limitSendAdc(), LIH_limitSettle(), _LIH_SetSettleAdc_Pkt::pay, and _LIH_SetSettleAdc_Prm::settle.