parameter_status.h File Reference

Defines the trek::ParameterStatus class. More...

#include "trek_data_defines.h"

Classes
class	trek::ParameterStatus
	This class describes the status associated with a parameter value. More...

Macros
#define	SET_LEVEL_5_HIGH_LIMIT_MASK   0x80000000
	Bit mask for the level 5 high limit.
#define	SET_LEVEL_4_HIGH_LIMIT_MASK   0x40000000
	Bit mask for the level 4 high limit.
#define	SET_LEVEL_3_HIGH_LIMIT_MASK   0x20000000
	Bit mask for the level 3 high limit.
#define	SET_LEVEL_2_HIGH_LIMIT_MASK   0x10000000
	Bit mask for the level 2 high limit.
#define	SET_LEVEL_1_HIGH_LIMIT_MASK   0x08000000
	Bit mask for the level 1 high limit.
#define	SET_LEVEL_5_LOW_LIMIT_MASK   0x04000000
	Bit mask for the level 5 low limit.
#define	SET_LEVEL_4_LOW_LIMIT_MASK   0x02000000
	Bit mask for the level 4 low limit.
#define	SET_LEVEL_3_LOW_LIMIT_MASK   0x01000000
	Bit mask for the level 3 low limit.
#define	SET_LEVEL_2_LOW_LIMIT_MASK   0x00800000
	Bit mask for the level 2 low limit.
#define	SET_LEVEL_1_LOW_LIMIT_MASK   0x00400000
	Bit mask for the level 1 low limit.
#define	SET_LEVEL_5_DELTA_LIMIT_MASK   0x00200000
	Bit mask for the level 5 delta limit.
#define	SET_LEVEL_4_DELTA_LIMIT_MASK   0x00100000
	Bit mask for the level 4 delta limit.
#define	SET_LEVEL_3_DELTA_LIMIT_MASK   0x00080000
	Bit mask for the level 3 delta limit.
#define	SET_LEVEL_2_DELTA_LIMIT_MASK   0x00040000
	Bit mask for the level 2 delta limit.
#define	SET_LEVEL_1_DELTA_LIMIT_MASK   0x00020000
	Bit mask for the level 1 delta limit.
#define	SET_EXPECTED_STATE_ERROR_MASK   0x00010000
	Bit mask for an expected state error.
#define	SET_LOW_RANGE_MASK   0x00000800
	Bit mask for the low range error.
#define	SET_HIGH_RANGE_MASK   0x00000400
	Bit mask for the high range error.
#define	SET_CAL_ILLEGAL_DATATYPE_MASK   0x00000200
	Bit mask for illegal data type.
#define	SET_CAL_GENERAL_ERROR_MASK   0x00000100
	Bit mask for a general calibrator error.
#define	SET_DQ_CHECKSUM_ERROR_MASK   0x00000080
	Bit mask for a bad checksum error.
#define	SET_DQ_BAD_LENGTH_ERROR_MASK   0x00000040
	Bit mask for a bad length error.
#define	SET_PROCESSING_ERROR_MASK   0x00000020
	Bit mask for processing errors.
#define	SET_DATA_LOSS_POSSIBLE_MASK   0x00000010
	Bit mask for possible loss of data.
#define	SET_CAL_SWITCH_ERROR_MASK   0x00000008
	Bit mask for a calibration switch error.
#define	SET_ALARM_SWITCH_ERROR_MASK   0x00000004
	Bit mask for an alarm switch error.
#define	SET_CONV_ERROR_MASK   0x00000002
	Bit mask for a conversion error.
#define	SET_STALE_MASK   0x00000001
	Bit mask for stale data.
#define	HIGH_LIMIT_MASK   0xf8000000
	Bit mask any high limit error.
#define	LOW_LIMIT_MASK   0x07c00000
	Bit mask any low limit error.
#define	DELTA_LIMIT_MASK   0x003e0000
	Bit mask any delta limit error.
#define	ALL_LIMIT_MASK   0xfffe0000
	Bit mask any limit error.
#define	ENUMERATION_ALARM_MASK   0x0001f000
	Bit mask any enumeration alarms error.
#define	RANGE_ERROR_MASK   0x00000c00
	Bit mask any range error.
#define	LEVEL_5_HIGH_LIMIT_STATUS_CHAR   "*"
	Status character displayed when a level 5 high limit error occurs.
#define	LEVEL_4_HIGH_LIMIT_STATUS_CHAR   "H"
	Status character displayed when a level 4 high limit error occurs.
#define	LEVEL_3_HIGH_LIMIT_STATUS_CHAR   "^"
	Status character displayed when a level 3 high limit error occurs.
#define	LEVEL_2_HIGH_LIMIT_STATUS_CHAR   "+"
	Status character displayed when a level 2 high limit error occurs.
#define	LEVEL_1_HIGH_LIMIT_STATUS_CHAR   "&"
	Status character displayed when a level 1 high limit error occurs.
#define	LEVEL_5_LOW_LIMIT_STATUS_CHAR   "$"
	Status character displayed when a level 5 low limit error occurs.
#define	LEVEL_4_LOW_LIMIT_STATUS_CHAR   "L"
	Status character displayed when a level 4 low limit error occurs.
#define	LEVEL_3_LOW_LIMIT_STATUS_CHAR   "v"
	Status character displayed when a level 3 low limit error occurs.
#define	LEVEL_2_LOW_LIMIT_STATUS_CHAR   "-"
	Status character displayed when a level 2 low limit error occurs.
#define	LEVEL_1_LOW_LIMIT_STATUS_CHAR   "0"
	Status character displayed when a level 1 low limit error occurs.
#define	LEVEL_5_DELTA_LIMIT_STATUS_CHAR   "Q"
	Status character displayed when a level 5 delta limit error occurs.
#define	LEVEL_4_DELTA_LIMIT_STATUS_CHAR   "D"
	Status character displayed when a level 4 delta limit error occurs.
#define	LEVEL_3_DELTA_LIMIT_STATUS_CHAR   "d"
	Status character displayed when a level 3 delta limit error occurs.
#define	LEVEL_2_DELTA_LIMIT_STATUS_CHAR   "#"
	Status character displayed when a level 2 delta limit error occurs.
#define	LEVEL_1_DELTA_LIMIT_STATUS_CHAR   "@"
	Status character displayed when a level 1 delta limit error occurs.
#define	EXPECTED_STATE_ERROR_CHAR   "E"
	Status character displayed when an expected state error occurs.
#define	LOW_RANGE_STATUS_CHAR   "r"
	Status character displayed when a low range error occurs.
#define	HIGH_RANGE_STATUS_CHAR   "R"
	Status character displayed when a high range error occurs.
#define	CAL_ILLEGAL_DATATYPE_STATUS_CHAR   "t"
	Status character displayed when an illegal data type error occurs (indicates that an integer value cannot be accurately represented as a double)
#define	CAL_GENERAL_ERROR_STATUS_CHAR   "c"
	Status character displayed when a general calibration error occurs.
#define	CONVERSION_ERROR_STATUS_CHAR   "C"
	Status character displayed when a conversion error occurs.
#define	DQ_CHECKSUM_ERROR_STATUS_CHAR   "k"
	Status character displayed when a bad checksum is detected.
#define	DQ_BAD_LENGTH_ERROR_STATUS_CHAR   "l"
	Status character displayed when a bad length is detected.
#define	PROCESSING_ERROR_STATUS_CHAR   "p"
	Status character displayed when a processing error occurs.
#define	DATA_LOSS_POSSIBLE_STATUS_CHAR   "?"
	Status character displayed when a possible loss of data occurs.
#define	CAL_SWITCH_ERROR_STATUS_CHAR   "K"
	Status character displayed when a calibration switch error occurs.
#define	ALARM_SWITCH_ERROR_STATUS_CHAR   "X"
	Status character displayed when an alarm switch error occurs.
#define	STALE_STATUS_CHAR   "S"
	Status character displayed when data is stale; value already retrieved.

Detailed Description

Defines the trek::ParameterStatus class.