GetAlarm

<< Click to Display Table of Contents >>

 

GetAlarm

GetAlarm()

Returns an object that allows access to specific settings of each type of Alarm. This object allows verifying or changing properties of a certain Alarm at run time. Depending on the type of Alarm, this method returns an object with the properties described on the next tables.

Properties of an Analog Alarm object

Property

Description

Delay Number

Delay time for this Alarm, in milliseconds, when entering and when leaving a condition

Hi Boolean

Enables or disables a verification on this Alarm with a High level of severity

HiAckRequired Boolean

Indicates whether there is a need to acknowledge the High level of severity of this Alarm

HiHi Boolean

Enables or disables a verification on this Alarm with a Very High level of severity

HiHiAckRequired Boolean

Indicates whether there is a need to acknowledge the Very High level of severity of this Alarm

HiHiLimit Number

Limit for the Very High level of severity of this Alarm

HiHiMessageText Text

Text of the message for the Very High level of severity of this Alarm

HiHiSeverity Number

Importance of the Very High level of severity of this Alarm. Possible values for this property are -2: Critical, 0: High, 1: Medium, or 2: Low

HiLimit Number

Limit for the High level of severity of this Alarm

HiMessageText Text

Text of the message for the High level of severity of this Alarm

HiSeverity Number

Importance of the High level of severity of this Alarm. Possible values for this property are -2: Critical, 0: High, 1: Medium, or 2: Low

LevelDeadBand Number

Dead band for limits of this Alarm's level

LevelReturnMessageText Text

Return message of this Alarm

Lo Boolean

Enables or disables a verification on this Alarm with a Low level of severity

LoAckRequired Boolean

Indicates whether there is a need to acknowledge the Low level of severity of this Alarm

LoLimit Number

Limit for the Low level of severity of this Alarm

LoLo Boolean

Enables or disables a verification on this Alarm with a Very Low level of severity

LoLoAckRequired Boolean

Indicates whether there is a need to acknowledge the Very Low level of severity of this Alarm

LoLoLimit Number

Limit for the Very Low level of severity of this Alarm

LoLoMessageText Text

Text of the message for the Very Low level of severity of this Alarm

LoLoSeverity Number

Importance of the Very Low level of severity of this Alarm. Possible values for this property are -2: Critical, 0: High, 1: Medium, or 2: Low

LoMessageText Text

Text of the message for the Low level of severity of this Alarm

LoSeverity Number

Importance of the Low level of severity of this Alarm. Possible values for this property are -2: Critical, 0: High, 1: Medium, or 2: Low

Name Text

Name of this Alarm

 

Properties of a Dead Band Alarm object

Property

Description

DeadBand Boolean

Enables or disables a verification on this Alarm

DeadBandAckRequired Boolean

Indicates whether there is a need to acknowledge this Alarm

DeadBandLimit Number

Limit for this Alarm

DeadBandMessageText Text

Text of the message of this Alarm

DeadBandReturnMessageText Text

Return message of this Alarm

DeadBandSetPoint Text

Limit of dead band of this Alarm. Each time an associated Tag's value exceeds this property's value above or below DeadBandLimit's value, this Alarm occurs

DeadBandSeverity Number

Importance of this Alarm. Possible values for this property are -2: Critical, 0: High, 1: Medium, or 2: Low

Delay Number

Delay time for this Alarm, in milliseconds, when entering and when leaving a condition

Name Text

Name of this Alarm

 

Properties of a Digital Alarm object

Property

Description

Delay Number

Delay time for this Alarm, in milliseconds, when entering and when leaving a condition

Digital Boolean

Enables or disables a verification on this Alarm

DigitalAckRequired Booleano

Indicates whether there is a need to acknowledge this Alarm

DigitalLimit Variant

Limit for this Alarm

DigitalMessageText Text

Text of the message of this Alarm

DigitalReturnMessageText Text

Return message of this Alarm

DigitalSeverity Number

Severity of this Alarm. Possible values for this property are -2: Critical, 0: High, 1: Medium, or 2: Low

Name Name

Name of this Alarm

 

Properties of a Discrete Alarm object

Property

Description

Delay Number

Delay time for this Alarm, in milliseconds, when entering and when leaving a condition

DiscreteReturnMessageText Text

Return message of this Alarm

Name Texto

Name of this Alarm

SubConditions Collection

A collection of Subconditions of this Alarm. Please check the next table for a description of all available properties on the Subcondition objects of that collection, which are accessible using its Item method

 

Properties of a Subcondition object from a Discrete Alarm

Property

Description

AckRequired Boolean

Indicates whether there is a need to acknowledge this Subcondition

Caption Text

Description of this Subcondition

Enabled Boolean

Enables or disables this Subcondition

Kind Enum

Behavior of this Subcondition. Possible values for this property are 0: Alarm, 1: Event, or 2: Return

Limit Variant

Value of the Alarm Source to generate this Subcondition

Message Text

Event message when this Subcondition is active

Name Text

Name of this Subcondition

Severity Number

Importance of this Subcondition. Possible values for this property are -2: Critical, 0: High, 1: Medium, or 2: Low

 

Properties of a Rate of Change Alarm object

Property

Description

Delay Number

Delay time for this Alarm, in milliseconds, when entering and when leaving a condition

Name Text

Name of this Alarm

ROC Boolean

Enables or disables a verification on this Alarm

ROCAckRequired Boolean

Indicates whether there is a need to acknowledge this Alarm

ROCLimit Number

Limit for this Alarm. For this Alarm to occur, it is sufficient that the associated Tag's value exceeds this value in one second

ROCMessageText Text

Text of the message of this Alarm

ROCReturnMessageText Text

Return message of this Alarm

ROCSeverity Number

Importance of this Alarm. Possible values for this property are -2: Critical, 0: High, 1: Medium, or 2: Low

 

The next code contains an example of using this method.

Sub Button1_Click()
  'Click this Button to change the Low severity level
  'of an Analog Alarm
  Set alm = Application.GetObject("Conf1.Area1.Analog1")_
    .GetAlarm()
  alm.LoLimit = 10.2
End Sub

 

NOTE

The properties relative to each type of Alarm can be accessed directly by scripts and Links, as well as viewed on an object's Properties List, so their edition is no longer mandatory via GetAlarm method.

Was this page useful?