43 #ifndef _CL_ALARM_DEFINITIONS_H_
44 #define _CL_ALARM_DEFINITIONS_H_
51 #include <clVersion.h>
69 #define ClAlarmEventName "CL_ALARM_EVENT_CHANNEL"
75 #define CL_ALARM_EVENT 1
Typical defines found in any software project.
Header file of all MetaData data structures.
struct ClAlarmPendingAlmList ClAlarmPendingAlmListT
Structure to contain the information about the pending alarms.
ClUint32T ClAlarmHandleT
The type of the handle for identifying the raised alarm.
Definition: clAlarmDefinitions.h:131
struct ClAlarmComponentResAlarms ClAlarmComponentResAlarmsT
The structure captures the alarm profile of all alarms that are modeled for each resource in the comp...
ClAlarmPendingAlmInfoT * ClAlarmPendingAlmInfoPtrT
Pointer type for ClAlarmPendingAlmInfoT.
Definition: clAlarmDefinitions.h:815
ClAlarmRuleRelationT
The enum enumerates the possible relationships between two alarms.
Definition: clAlarmDefinitions.h:646
ClAlarmProbableCauseT
This enumeration defines all the probable causes of the alarm based on the categories.
Definition: clAlarmDefinitions.h:189
ClAlarmStateT
The enumeration to depict the state of the alarm that is into.
Definition: clAlarmDefinitions.h:509
ClAlarmSeverityTypeT
Enumeration to depict the severity of the alarm which is specified while modeling and also while publ...
Definition: clAlarmDefinitions.h:142
ClUint32T ClAlarmSpecificProblemT
The type of an identifier to the specific problem of the alarm.
Definition: clAlarmDefinitions.h:126
ClAlarmCategoryTypeT
Enumeration defining the categories of alarms support by alarm server.
Definition: clAlarmDefinitions.h:81
ClAlarmPendingAlmListT * ClAlarmPendingAlmListPtrT
Pointer type for ClAlarmPendingAlmListT.
Definition: clAlarmDefinitions.h:840
ClAlarmInfoT * ClAlarmInfoPtrT
Pointer type for ClAlarmInfoT.
Definition: clAlarmDefinitions.h:604
ClAlarmFetchModeT
Enums for alarm fetch mode.
Definition: clAlarmDefinitions.h:628
struct ClAlarmPendingAlmInfo ClAlarmPendingAlmInfoT
Structure to contain the pending alarm information.
struct ClAlarmProfile ClAlarmProfileT
This structure is used to store the alarm related attributes including the category,...
@ CL_ALARM_RULE_NO_RELATION
If there is only one alarm, then there is no relationship that must be determined.
Definition: clAlarmDefinitions.h:654
@ CL_ALARM_RULE_LOGICAL_OR
The alarm is raised or cleared, if at least one of the alarms (specified in the modeling) exist.
Definition: clAlarmDefinitions.h:659
@ CL_ALARM_RULE_RELATION_INVALID
There is no valid relation between the alarms (specified in the modeling).
Definition: clAlarmDefinitions.h:669
@ CL_ALARM_RULE_LOGICAL_AND
The alarm is raised or cleared, only if all the alarms (specified in the modeling) exist.
Definition: clAlarmDefinitions.h:664
@ CL_ALARM_PROB_CAUSE_LEAK_DETECTED
A leak of gas or fluid is detected around equipment.
Definition: clAlarmDefinitions.h:475
@ CL_ALARM_PROB_CAUSE_ENCLOSURE_DOOR_OPEN
Probable cause of alarm is enclosure door is open.
Definition: clAlarmDefinitions.h:500
@ CL_ALARM_PROB_CAUSE_CONGESTION
System is reaching its capacity or approaching it.
Definition: clAlarmDefinitions.h:291
@ CL_ALARM_PROB_CAUSE_FILE_ERROR
Format of the file is incorrect.
Definition: clAlarmDefinitions.h:340
@ CL_ALARM_PROB_CAUSE_PROCESSOR_PROBLEM
Internal machine error has occurred on the a Central processing Unit.
Definition: clAlarmDefinitions.h:381
@ CL_ALARM_PROB_CAUSE_RESOURCE_AT_OR_NEARING_CAPACITY
Probable cause of the alarm is the maximum capacity is already reached or about to be reached.
Definition: clAlarmDefinitions.h:296
@ CL_ALARM_PROB_CAUSE_CORRUPT_DATA
An error has caused the data to be incorrect.
Definition: clAlarmDefinitions.h:315
@ CL_ALARM_PROB_CAUSE_COMMUNICATIONS_SUBSYSTEM_FAILURE
A failure in the subsystem which supports communication over telecommunication links.
Definition: clAlarmDefinitions.h:237
@ CL_ALARM_PROB_CAUSE_CONFIGURATION_OR_CUSTOMIZATION_ERROR
The parameter for configuration or customization are given improperly.
Definition: clAlarmDefinitions.h:361
@ CL_ALARM_PROB_CAUSE_LOSS_OF_SIGNAL
Probable cause for alarms which can occur due to communication related problems between two points.
Definition: clAlarmDefinitions.h:202
@ CL_ALARM_PROB_CAUSE_OUT_OF_MEMORY
There is no program-addressable storage available.
Definition: clAlarmDefinitions.h:345
@ CL_ALARM_PROB_CAUSE_RESPONSE_TIME_EXCESSIVE
Probable causes of alarms caused due to degradation in quality of service.
Definition: clAlarmDefinitions.h:261
@ CL_ALARM_PROB_CAUSE_LOCAL_NODE_TRANSMISSION_ERROR
An error has occured in the transmission between local node and adjacent node.
Definition: clAlarmDefinitions.h:217
@ CL_ALARM_PROB_CAUSE_RECEIVE_FAILURE
Probable cause of alarm is receive failure.
Definition: clAlarmDefinitions.h:406
@ CL_ALARM_PROB_CAUSE_TIMING_PROBLEM
The process which has timing constraints didn't complete with the specified time or has completed but...
Definition: clAlarmDefinitions.h:376
@ CL_ALARM_PROB_CAUSE_PUMP_FAILURE
Error has occured in the pump which is used to trasfer fluid in the equipment.
Definition: clAlarmDefinitions.h:495
@ CL_ALARM_PROB_CAUSE_SOFWARE_PROGRAM_ABNORMALLY_TERMINATED
Probable cause of alarm is software program abnormally terminated.
Definition: clAlarmDefinitions.h:335
@ CL_ALARM_PROB_CAUSE_FLOOD_DETECTED
Probable cause of alarm is flood around equipment.
Definition: clAlarmDefinitions.h:465
@ CL_ALARM_PROB_CAUSE_INPUT_OUTPUT_DEVICE_ERROR
Probable cause of alarm is input output device error.
Definition: clAlarmDefinitions.h:426
@ CL_ALARM_PROB_CAUSE_PERFORMANCE_DEGRADED
Service limit or service aggrement are outside the acceptable limits.
Definition: clAlarmDefinitions.h:286
@ CL_ALARM_ID_INVALID
invalid cause
Definition: clAlarmDefinitions.h:193
@ CL_ALARM_PROB_CAUSE_TRANSMITTER_FAILURE
Probable cause of alarm is transamitter failure.
Definition: clAlarmDefinitions.h:401
@ CL_ALARM_PROB_CAUSE_POWER_PROBLEM
Probable cause alarms caused due to equipment related problems.
Definition: clAlarmDefinitions.h:370
@ CL_ALARM_PROB_CAUSE_STORAGE_CAPACITY_PROBLEM
Probable causes of alarm caused due to software or processing errors.
Definition: clAlarmDefinitions.h:305
@ CL_ALARM_PROB_CAUSE_MULTIPLEXER_PROBLEM
Error occured while multiplexing the communication signal.
Definition: clAlarmDefinitions.h:391
@ CL_ALARM_PROB_CAUSE_FRAMING_ERROR
Error in the bit-groups delimiters within the bit-stream.
Definition: clAlarmDefinitions.h:212
@ CL_ALARM_PROB_CAUSE_TEMPERATURE_UNACCEPTABLE
Probable cause of alarms caused due to environmental changes around the equipment.
Definition: clAlarmDefinitions.h:445
@ CL_ALARM_PROB_CAUSE_PRESSURE_UNACCEPTABLE
The fluid or gas pressure is unacceptable.
Definition: clAlarmDefinitions.h:480
@ CL_ALARM_PROB_CAUSE_DATASET_OR_MODEM_ERROR
An internal error has occured on a dataset or modem.
Definition: clAlarmDefinitions.h:386
@ CL_ALARM_PROB_CAUSE_QUEUE_SIZE_EXCEEDED
The number of items to be processed has exceeded the specified limits.
Definition: clAlarmDefinitions.h:266
@ CL_ALARM_PROB_CAUSE_TOXIC_LEAK_DETECTED
Probable cause of alarm is toxic leak is detected around equipment.
Definition: clAlarmDefinitions.h:470
@ CL_ALARM_PROB_CAUSE_SOFWARE_ERROR
Probable cause of alarm is error in software.
Definition: clAlarmDefinitions.h:325
@ CL_ALARM_PROB_CAUSE_LAN_ERROR
Problem detected in the local area network.
Definition: clAlarmDefinitions.h:247
@ CL_ALARM_PROB_CAUSE_CPU_CYCLES_LIMIT_EXCEEDED
CPU cycles limited has been exceeded its limit.
Definition: clAlarmDefinitions.h:320
@ CL_ALARM_PROB_CAUSE_ADAPTER_ERROR
Probable cause of alarm is adapter error.
Definition: clAlarmDefinitions.h:436
@ CL_ALARM_PROB_CAUSE_HEATING_OR_VENTILATION_OR_COOLING_SYSTEM_PROBLEM
Probable cause of alarm is heating or ventillation or cooling system problem.
Definition: clAlarmDefinitions.h:455
@ CL_ALARM_PROB_CAUSE_RECEIVER_FAILURE
Probable cause of alarm is receiver failure.
Definition: clAlarmDefinitions.h:396
@ CL_ALARM_PROB_CAUSE_COMMUNICATIONS_PROTOCOL_ERROR
The communication protocol has been voilated.
Definition: clAlarmDefinitions.h:242
@ CL_ALARM_PROB_CAUSE_EQUIPMENT_MALFUNCTION
Internal error in equipment malfunction for which no actual cause has been identified.
Definition: clAlarmDefinitions.h:431
@ CL_ALARM_PROB_CAUSE_TRANSMIT_FAILURE
Probable cause of alarm is transmission failure.
Definition: clAlarmDefinitions.h:411
@ CL_ALARM_PROB_CAUSE_DEGRADED_SIGNAL
The quality of the singal has decreased.
Definition: clAlarmDefinitions.h:232
@ CL_ALARM_PROB_CAUSE_THRESHOLD_CROSSED
The limit allowed (or configured) has exceeded.
Definition: clAlarmDefinitions.h:281
@ CL_ALARM_PROB_CAUSE_SOFTWARE_PROGRAM_ERROR
Probable cause of alarm is error in software program error.
Definition: clAlarmDefinitions.h:330
@ CL_ALARM_PROB_CAUSE_DTE
Probable cause of the alarm is data transmission error.
Definition: clAlarmDefinitions.h:252
@ CL_ALARM_PROB_CAUSE_VERSION_MISMATCH
There is a mismatch in the version of two communicating entities.
Definition: clAlarmDefinitions.h:310
@ CL_ALARM_PROB_CAUSE_LOSS_OF_FRAME
An inability to locate the information in bit-delimiters.
Definition: clAlarmDefinitions.h:207
@ CL_ALARM_PROB_CAUSE_INPUT_DEVICE_ERROR
Probable cause of alarm is input device error.
Definition: clAlarmDefinitions.h:421
@ CL_ALARM_PROB_CAUSE_BANDWIDTH_REDUCED
The bandwidth available for transmission has reduced.
Definition: clAlarmDefinitions.h:271
@ CL_ALARM_PROB_CAUSE_HUMIDITY_UNACCEPTABLE
Probable cause of alarm is humidity unacceptable around equipment.
Definition: clAlarmDefinitions.h:450
@ CL_ALARM_PROB_CAUSE_UNDERLYING_RESOURCE_UNAVAILABLE
An entity upon which the reporting object depends has become unreliable.
Definition: clAlarmDefinitions.h:350
@ CL_ALARM_PROB_CAUSE_RETRANSMISSION_RATE_EXCESSIVE
Number of repeat transmission is beyond the allowed limits.
Definition: clAlarmDefinitions.h:276
@ CL_ALARM_PROB_CAUSE_MATERIAL_SUPPLY_EXHAUSTED
Probable cause of alarm is exhaustion of the materail supply.
Definition: clAlarmDefinitions.h:490
@ CL_ALARM_PROB_CAUSE_REMOTE_NODE_TRANSMISSION_ERROR
An error has occurred on the transmission channel beyond the adjacent node.
Definition: clAlarmDefinitions.h:222
@ CL_ALARM_PROB_CAUSE_CALL_ESTABLISHMENT_ERROR
Error occured while establishing the connection.
Definition: clAlarmDefinitions.h:227
@ CL_ALARM_PROB_CAUSE_EXCESSIVE_VIBRATION
The vibration around the equipment has exceeded the limit.
Definition: clAlarmDefinitions.h:485
@ CL_ALARM_PROB_CAUSE_OUTPUT_DEVICE_ERROR
Error has occured on a output device.
Definition: clAlarmDefinitions.h:416
@ CL_ALARM_PROB_CAUSE_APPLICATION_SUBSYSTEM_FAILURE
A failure is detected in the application subsystem failure.
Definition: clAlarmDefinitions.h:356
@ CL_ALARM_PROB_CAUSE_FIRE_DETECTED
Probable cause of alarm is fire around the equipment.
Definition: clAlarmDefinitions.h:460
@ CL_ALARM_STATE_ASSERT
The alarm condition has occured.
Definition: clAlarmDefinitions.h:521
@ CL_ALARM_STATE_UNDER_SOAKING
The alarm state is under soaking.
Definition: clAlarmDefinitions.h:529
@ CL_ALARM_STATE_SUPPRESSED
The alarm state is suppressed.
Definition: clAlarmDefinitions.h:525
@ CL_ALARM_STATE_CLEAR
The alarm condition has cleared.
Definition: clAlarmDefinitions.h:517
@ CL_ALARM_STATE_INVALID
Invalid alarm state.
Definition: clAlarmDefinitions.h:513
@ CL_ALARM_SEVERITY_CLEAR
Alarm with severity level as cleared.
Definition: clAlarmDefinitions.h:177
@ CL_ALARM_SEVERITY_MINOR
Alarm with severity level as minor.
Definition: clAlarmDefinitions.h:162
@ CL_ALARM_SEVERITY_INVALID
Alarm with invalid severity.
Definition: clAlarmDefinitions.h:147
@ CL_ALARM_SEVERITY_INDETERMINATE
Alarm with severity level indeterminate.
Definition: clAlarmDefinitions.h:172
@ CL_ALARM_SEVERITY_CRITICAL
Alarm with severity level as critical.
Definition: clAlarmDefinitions.h:152
@ CL_ALARM_SEVERITY_WARNING
Alarm with severity level warning.
Definition: clAlarmDefinitions.h:167
@ CL_ALARM_SEVERITY_MAJOR
Alarm with severity level as major.
Definition: clAlarmDefinitions.h:157
@ CL_ALARM_CATEGORY_PROCESSING_ERROR
Category for alarms that are related to software or processing error.
Definition: clAlarmDefinitions.h:101
@ CL_ALARM_CATEGORY_ENVIRONMENTAL
Category for alarms that are related to environmental conditions around the equipment.
Definition: clAlarmDefinitions.h:111
@ CL_ALARM_CATEGORY_COMMUNICATIONS
Category for alarms that are related to communication between to points.
Definition: clAlarmDefinitions.h:91
@ CL_ALARM_CATEGORY_EQUIPMENT
Category for alarms that are related to equipment problems.
Definition: clAlarmDefinitions.h:106
@ CL_ALARM_CATEGORY_INVALID
Category for alarms that are not valid.
Definition: clAlarmDefinitions.h:86
@ CL_ALARM_CATEGORY_QUALITY_OF_SERVICE
Category for alarms that are related to degrations in quality of service.
Definition: clAlarmDefinitions.h:96
@ CL_ALARM_POLL
Definition: clAlarmDefinitions.h:639
@ CL_ALARM_REPORT
There are two ways to get alarm notification for the alarm client:
Definition: clAlarmDefinitions.h:634
ClInt64T ClTimeT
Time duration specified in nanoseconds.
Definition: clCommon.h:154
ClInt32T ClCorClassTypeT
The type of an identifier for the COR class.
Definition: clCorMetaData.h:201
A name.
Definition: clCommon.h:197
The ClAlarmInfoT data structure is used to store the entire list of alarm attributes that include pro...
Definition: clAlarmDefinitions.h:544
ClTimeT eventTime
Time stamp of the alarm being raised.
Definition: clAlarmDefinitions.h:587
ClAlarmCategoryTypeT category
Category of the alarm.
Definition: clAlarmDefinitions.h:571
ClUint32T len
Length of the additional data about the alarm.
Definition: clAlarmDefinitions.h:592
ClAlarmSpecificProblemT specificProblem
Specific-Problem of the alarm.
Definition: clAlarmDefinitions.h:577
ClCorMOIdT moId
Resource on which the alarm occurred.
Definition: clAlarmDefinitions.h:558
ClAlarmSeverityTypeT severity
Severity of the alarm.
Definition: clAlarmDefinitions.h:582
ClAlarmStateT alarmState
Flag to indicate if the alarm was for assert or for clear.
Definition: clAlarmDefinitions.h:566
ClAlarmProbableCauseT probCause
Probable cause of the alarm.
Definition: clAlarmDefinitions.h:548
ClNameT compName
Component name of the resource on which the alarm occurred.
Definition: clAlarmDefinitions.h:553
The ClAlarmHandleInfoT data structure is used to store the handle and the information of the alarm.
Definition: clAlarmDefinitions.h:612
ClAlarmHandleT alarmHandle
Unique alarm handle identifying an alarm.
Definition: clAlarmDefinitions.h:616
ClAlarmInfoT alarmInfo
Alarm Information.
Definition: clAlarmDefinitions.h:620
This structure contains the information about the alarm configured.
Definition: clAlarmDefinitions.h:677
ClAlarmSpecificProblemT specificProblem
The specific problem of the alarm participating in the generation rule.
Definition: clAlarmDefinitions.h:686
ClAlarmProbableCauseT probableCause
The probable cause of the alarm participating in the alarm rule.
Definition: clAlarmDefinitions.h:681
This structure specifies the alarm rule relation and the alarms IDs (probable cause) that participate...
Definition: clAlarmDefinitions.h:697
ClAlarmRuleEntryT * alarmIds
The structure containing the probable cause and specific problem of the alarms participating in the a...
Definition: clAlarmDefinitions.h:709
ClAlarmRuleRelationT relation
Alarm rule relation is a relationship between alarms.
Definition: clAlarmDefinitions.h:703
This structure is used to store the alarm related attributes including the category,...
Definition: clAlarmDefinitions.h:721
ClAlarmSpecificProblemT specificProblem
specific problem for the alarm.
Definition: clAlarmDefinitions.h:767
ClUint32T clearSoakingTime
Soaking-time for the alarm to be cleared.
Definition: clAlarmDefinitions.h:752
ClAlarmRuleInfoT * suppressionRule
suppressionRule for the alarm.
Definition: clAlarmDefinitions.h:762
ClUint32T assertSoakingTime
Soaking-time for the alarm to be asserted.
Definition: clAlarmDefinitions.h:747
ClAlarmProbableCauseT probCause
Probable Cause of the alarm.
Definition: clAlarmDefinitions.h:732
ClAlarmSeverityTypeT severity
severity of the alarm.
Definition: clAlarmDefinitions.h:737
ClAlarmFetchModeT fetchMode
Indicates whether the alarm needs to be polled or not.
Definition: clAlarmDefinitions.h:742
ClAlarmCategoryTypeT category
category to which the alarm belongs.
Definition: clAlarmDefinitions.h:727
ClAlarmRuleInfoT * generationRule
generationRule for the alarm.
Definition: clAlarmDefinitions.h:757
The structure captures the alarm profile of all alarms that are modeled for each resource in the comp...
Definition: clAlarmDefinitions.h:776
ClUint32T pollingTime
The frequency at which the resource will be polled for the current status of all of its alarms.
Definition: clAlarmDefinitions.h:787
ClAlarmProfileT * MoAlarms
Pointer to ClAlarmProfileT structures of all alarms for the resource.
Definition: clAlarmDefinitions.h:793
ClCorClassTypeT moClassID
Resource MOID for which the alarm profiles are provided in the MoAlarms.
Definition: clAlarmDefinitions.h:781
Structure to contain the pending alarm information.
Definition: clAlarmDefinitions.h:800
ClAlarmInfoPtrT pAlarmInfo
Pointer to the pending alarm information.
Definition: clAlarmDefinitions.h:809
ClAlarmHandleT alarmHandle
Pending alarm handle.
Definition: clAlarmDefinitions.h:804
Structure to contain the information about the pending alarms.
Definition: clAlarmDefinitions.h:821
ClUint32T noOfPendingAlarm
The element will store the number of pending alarms present in the pAlarmList array.
Definition: clAlarmDefinitions.h:827
ClAlarmPendingAlmInfoPtrT pAlarmList
The pointer to the structure which will store the pointer to array of ClAlarmHandleInfoT structure co...
Definition: clAlarmDefinitions.h:834
The structure ClCorMOId contains MoId of the object, which is the address of the COR object.
Definition: clCorMetaData.h:918