clAlarmDefinitions.h File Reference

Header File of Alarm related Definitions. More...

#include <clCommon.h>
#include <clVersion.h>
#include <clCorMetaData.h>

Go to the source code of this file.

Classes
struct	ClAlarmComponentResAlarms
	The structure captures the alarm profile of all alarms that are modeled for each resource in the component. More...
struct	ClAlarmHandleInfoT
	The ClAlarmHandleInfoT data structure is used to store the handle and the information of the alarm. More...
struct	ClAlarmInfoT
	The ClAlarmInfoT data structure is used to store the entire list of alarm attributes that include probable cause, MOID, category, sub-category, severity, and event time along with additional information of the alarm. More...
struct	ClAlarmPendingAlmInfo
	Structure to contain the pending alarm information. More...
struct	ClAlarmPendingAlmList
	Structure to contain the information about the pending alarms. More...
struct	ClAlarmProfile
	This structure is used to store the alarm related attributes including the category, sub-category, severity, soaking time for assert and clear, probable cause of alarm, and the generation and suppression rule for alarm. More...
struct	ClAlarmRuleEntryT
	This structure contains the information about the alarm configured. More...
struct	ClAlarmRuleInfoT
	This structure specifies the alarm rule relation and the alarms IDs (probable cause) that participate in the alarm rule. More...

Macros
#define	CL_ALARM_EVENT   1
	Event Type to be specifed while subscribing for the events published by alarm server.
#define	ClAlarmEventName   "CL_ALARM_EVENT_CHANNEL"
	ID to specify whether the alarm is invalid or not.

Typedefs
typedef struct ClAlarmComponentResAlarms	ClAlarmComponentResAlarmsT
	The structure captures the alarm profile of all alarms that are modeled for each resource in the component.
typedef ClUint32T	ClAlarmHandleT
	The type of the handle for identifying the raised alarm.
typedef ClAlarmInfoT *	ClAlarmInfoPtrT
	Pointer type for ClAlarmInfoT.
typedef ClAlarmPendingAlmInfoT *	ClAlarmPendingAlmInfoPtrT
	Pointer type for ClAlarmPendingAlmInfoT.
typedef struct ClAlarmPendingAlmInfo	ClAlarmPendingAlmInfoT
	Structure to contain the pending alarm information.
typedef ClAlarmPendingAlmListT *	ClAlarmPendingAlmListPtrT
	Pointer type for ClAlarmPendingAlmListT.
typedef struct ClAlarmPendingAlmList	ClAlarmPendingAlmListT
	Structure to contain the information about the pending alarms.
typedef struct ClAlarmProfile	ClAlarmProfileT
	This structure is used to store the alarm related attributes including the category, sub-category, severity, soaking time for assert and clear, probable cause of alarm, and the generation and suppression rule for alarm.
typedef ClUint32T	ClAlarmSpecificProblemT
	The type of an identifier to the specific problem of the alarm.

Enumerations
enum	ClAlarmCategoryTypeT {   CL_ALARM_CATEGORY_INVALID = 0,   CL_ALARM_CATEGORY_COMMUNICATIONS = 1,   CL_ALARM_CATEGORY_QUALITY_OF_SERVICE = 2,   CL_ALARM_CATEGORY_PROCESSING_ERROR = 3,   CL_ALARM_CATEGORY_EQUIPMENT = 4,   CL_ALARM_CATEGORY_ENVIRONMENTAL = 5 }
	Enumeration defining the categories of alarms support by alarm server. More...
enum	ClAlarmFetchModeT {   CL_ALARM_REPORT = 0,   CL_ALARM_POLL }
	Enums for alarm fetch mode. More...
enum	ClAlarmProbableCauseT {   CL_ALARM_ID_INVALID = 0,   CL_ALARM_PROB_CAUSE_LOSS_OF_SIGNAL = 1,   CL_ALARM_PROB_CAUSE_LOSS_OF_FRAME,   CL_ALARM_PROB_CAUSE_FRAMING_ERROR,   CL_ALARM_PROB_CAUSE_LOCAL_NODE_TRANSMISSION_ERROR,   CL_ALARM_PROB_CAUSE_REMOTE_NODE_TRANSMISSION_ERROR,   CL_ALARM_PROB_CAUSE_CALL_ESTABLISHMENT_ERROR,   CL_ALARM_PROB_CAUSE_DEGRADED_SIGNAL,   CL_ALARM_PROB_CAUSE_COMMUNICATIONS_SUBSYSTEM_FAILURE,   CL_ALARM_PROB_CAUSE_COMMUNICATIONS_PROTOCOL_ERROR,   CL_ALARM_PROB_CAUSE_LAN_ERROR,   CL_ALARM_PROB_CAUSE_DTE,   CL_ALARM_PROB_CAUSE_RESPONSE_TIME_EXCESSIVE,   CL_ALARM_PROB_CAUSE_QUEUE_SIZE_EXCEEDED,   CL_ALARM_PROB_CAUSE_BANDWIDTH_REDUCED,   CL_ALARM_PROB_CAUSE_RETRANSMISSION_RATE_EXCESSIVE,   CL_ALARM_PROB_CAUSE_THRESHOLD_CROSSED,   CL_ALARM_PROB_CAUSE_PERFORMANCE_DEGRADED,   CL_ALARM_PROB_CAUSE_CONGESTION,   CL_ALARM_PROB_CAUSE_RESOURCE_AT_OR_NEARING_CAPACITY,   CL_ALARM_PROB_CAUSE_STORAGE_CAPACITY_PROBLEM,   CL_ALARM_PROB_CAUSE_VERSION_MISMATCH,   CL_ALARM_PROB_CAUSE_CORRUPT_DATA,   CL_ALARM_PROB_CAUSE_CPU_CYCLES_LIMIT_EXCEEDED,   CL_ALARM_PROB_CAUSE_SOFWARE_ERROR,   CL_ALARM_PROB_CAUSE_SOFTWARE_PROGRAM_ERROR,   CL_ALARM_PROB_CAUSE_SOFWARE_PROGRAM_ABNORMALLY_TERMINATED,   CL_ALARM_PROB_CAUSE_FILE_ERROR,   CL_ALARM_PROB_CAUSE_OUT_OF_MEMORY,   CL_ALARM_PROB_CAUSE_UNDERLYING_RESOURCE_UNAVAILABLE,   CL_ALARM_PROB_CAUSE_APPLICATION_SUBSYSTEM_FAILURE,   CL_ALARM_PROB_CAUSE_CONFIGURATION_OR_CUSTOMIZATION_ERROR,   CL_ALARM_PROB_CAUSE_POWER_PROBLEM,   CL_ALARM_PROB_CAUSE_TIMING_PROBLEM,   CL_ALARM_PROB_CAUSE_PROCESSOR_PROBLEM,   CL_ALARM_PROB_CAUSE_DATASET_OR_MODEM_ERROR,   CL_ALARM_PROB_CAUSE_MULTIPLEXER_PROBLEM,   CL_ALARM_PROB_CAUSE_RECEIVER_FAILURE,   CL_ALARM_PROB_CAUSE_TRANSMITTER_FAILURE,   CL_ALARM_PROB_CAUSE_RECEIVE_FAILURE,   CL_ALARM_PROB_CAUSE_TRANSMIT_FAILURE,   CL_ALARM_PROB_CAUSE_OUTPUT_DEVICE_ERROR,   CL_ALARM_PROB_CAUSE_INPUT_DEVICE_ERROR,   CL_ALARM_PROB_CAUSE_INPUT_OUTPUT_DEVICE_ERROR,   CL_ALARM_PROB_CAUSE_EQUIPMENT_MALFUNCTION,   CL_ALARM_PROB_CAUSE_ADAPTER_ERROR,   CL_ALARM_PROB_CAUSE_TEMPERATURE_UNACCEPTABLE,   CL_ALARM_PROB_CAUSE_HUMIDITY_UNACCEPTABLE,   CL_ALARM_PROB_CAUSE_HEATING_OR_VENTILATION_OR_COOLING_SYSTEM_PROBLEM,   CL_ALARM_PROB_CAUSE_FIRE_DETECTED,   CL_ALARM_PROB_CAUSE_FLOOD_DETECTED,   CL_ALARM_PROB_CAUSE_TOXIC_LEAK_DETECTED,   CL_ALARM_PROB_CAUSE_LEAK_DETECTED,   CL_ALARM_PROB_CAUSE_PRESSURE_UNACCEPTABLE,   CL_ALARM_PROB_CAUSE_EXCESSIVE_VIBRATION,   CL_ALARM_PROB_CAUSE_MATERIAL_SUPPLY_EXHAUSTED,   CL_ALARM_PROB_CAUSE_PUMP_FAILURE,   CL_ALARM_PROB_CAUSE_ENCLOSURE_DOOR_OPEN }
	This enumeration defines all the probable causes of the alarm based on the categories. More...
enum	ClAlarmRuleRelationT {   CL_ALARM_RULE_NO_RELATION = 0,   CL_ALARM_RULE_LOGICAL_OR,   CL_ALARM_RULE_LOGICAL_AND,   CL_ALARM_RULE_RELATION_INVALID }
	The enum enumerates the possible relationships between two alarms. More...
enum	ClAlarmSeverityTypeT {   CL_ALARM_SEVERITY_INVALID = 0,   CL_ALARM_SEVERITY_CRITICAL = 1,   CL_ALARM_SEVERITY_MAJOR = 2,   CL_ALARM_SEVERITY_MINOR = 3,   CL_ALARM_SEVERITY_WARNING = 4,   CL_ALARM_SEVERITY_INDETERMINATE = 5,   CL_ALARM_SEVERITY_CLEAR = 6 }
	Enumeration to depict the severity of the alarm which is specified while modeling and also while publishing the alarm. More...
enum	ClAlarmStateT {   CL_ALARM_STATE_INVALID = -1,   CL_ALARM_STATE_CLEAR = 0,   CL_ALARM_STATE_ASSERT = 1,   CL_ALARM_STATE_SUPPRESSED = 2,   CL_ALARM_STATE_UNDER_SOAKING = 3 }
	The enumeration to depict the state of the alarm that is into. More...

Detailed Description

Header File of Alarm related Definitions.