Alarm Class

Represents an alarm.

Inheritance Hierarchy

System.Object
  TcHmiSrv.IObject
    TcHmiSrv.Localizable
      TcHmiSrv.Alarm
Namespace:  TcHmiSrv
Assembly:  TcHmiSrvExtNet (in TcHmiSrvExtNet.dll) Version: 3.0.0.0

Syntax

C#

public class Alarm : Localizable, IEquatable<Alarm>

The Alarm type exposes the following members.

Constructors

 

Name

Description

Alarm Class 1:

Alarm.

Initializes a new instance of the Alarm class.

Alarm Class 2:

Alarm(Alarm)

Initializes a new instance of the Alarm class based on another Alarm.

Alarm Class 3:

Alarm(Context, String)

Initializes a new instance of the Alarm class with the specified Context and name.

Properties

 

Name

Description

Alarm Class 4:

AlarmState

Gets or sets the AlarmState of the Alarm.

Alarm Class 5:

ConfirmationState

Gets or sets the AlarmConfirmationState of the Alarm.

Alarm Class 6:

Domain

Gets or sets the domain that triggered the Alarm.

Alarm Class 7:

Id

Gets or sets the unique ID of the Alarm.

Alarm Class 8:

IsSet

Gets a value that indicates whether the Alarm is set.

Alarm Class 9:

Name

Gets or sets the name of the Alarm.

Alarm Class 10:

Parameters

Gets the parameters of the Alarm.

Alarm Class 11:

Severity

Gets or sets the Severity of the Alarm.

Alarm Class 12:

TimeCleared

Gets or sets the time the Alarm was cleared.

Alarm Class 13:

TimeConfirmed

Gets or sets the time the Alarm was confirmed.

Alarm Class 14:

TimeRaised

Gets or sets the time the Alarm was raised.

Alarm Class 15:

Type

Gets the type of the Alarm. (ValueType_Alarm)

Methods

 

Name

Description

Alarm Class 16:

alarm_state

Obsolete.

Gets the AlarmState of the Alarm.

Alarm Class 17:

Dispose.

(Inherited from IObject.)

Alarm Class 18:

Dispose(Boolean)

Releases the unmanaged resources used by the Alarm and optionally releases the managed resources (Overrides Localizable.Dispose(Boolean).)

Alarm Class 19:

Equals(Alarm)

Indicates whether the current Alarm is equal to another Alarm.

Alarm Class 20:

Equals(Object)

Determines whether the specified object is equal to the current object. (Inherited from Object.)

Alarm Class 21:

Finalize

(Inherited from IObject.)

Alarm Class 22:

GetHashCode

Serves as the default hash function. (Inherited from Object.)

Alarm Class 23:

GetType

Gets the Type of the current instance. (Inherited from Object.)

Alarm Class 24:

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Alarm Class 25:

swap

Exchanges the values of two instances of the Alarm class.

Alarm Class 26:

ToString

Returns a string that represents the current object. (Inherited from Object.)

Operators

 

Name

Description

Alarm Class 27:

Alarm Class 28:

Equality

Determines whether the specified Alarm is equal to the current Alarm.

Alarm Class 29:

Alarm Class 30:

Inequality

Determines whether the specified Alarm is not equal to the current Alarm.

Reference

TcHmiSrv Namespace