Alarm Class

Represents an alarm.

Inheritance Hierarchy

System.Object
  TcHmiSrv.Core.Alarm
Namespace:  TcHmiSrv.Core
Assembly:  TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 1.3.0.0

Syntax

C#

public class Alarm : IComparable<Alarm>, 
    ICopyable<Alarm>, IDeepCopyable<Alarm>, IShallowCopyable<Alarm>, 
    IEquatable<Alarm>, ILocalizable

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(Context, String)

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

Properties

 

Name

Description

Alarm Class 3:

AlarmState

Contains the AlarmState of the Alarm.

Alarm Class 4:

ConfirmationState

Contains the AlarmConfirmationState of the Alarm.

Alarm Class 5:

Domain

Contains the domain of the Alarm.

Alarm Class 6:

Id

Contains the unique identifier of the Alarm.

Alarm Class 7:

IsSet

Gets a value that indicates whether the Alarm is set.

Alarm Class 8:

Name

Contains the name of the language variable.

Alarm Class 9:

Parameters

Gets the parameters of the localizable object. The names of the parameters must match the placeholders in the localization string.

Alarm Class 10:

Severity

Contains the Severity of the Alarm.

Alarm Class 11:

TimeCleared

Contains the DateTime when the Alarm was cleared.

Alarm Class 12:

TimeConfirmed

Contains the DateTime when the Alarm was confirmed.

Alarm Class 13:

TimeRaised

Contains the DateTime when the Alarm was raised.

Alarm Class 14:

Type

Gets the ValueType of the localizable object that will be Alarm.

Methods

 

Name

Description

Alarm Class 15:

CompareTo

Compares the current Alarm with another Alarm and returns an integer that indicates whether the current Alarm precedes, follows, or occurs in the same position in the sort order as the other Alarm.

Alarm Class 16:

DeepCopy

Creates a new object that is a deep copy of the current Alarm.

Alarm Class 17:

Equals(Object)

Determines whether the specified Object is equal to the current Alarm. (Overrides Object.Equals(Object).)

Alarm Class 18:

Equals(Alarm)

Indicates whether the current Alarm is equal to another Alarm.

Alarm Class 19:

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

Alarm Class 20:

GetHashCode

Serves as the default hash function. (Overrides Object.GetHashCode..)

Alarm Class 21:

GetType

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

Alarm Class 22:

MemberwiseClone

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

Alarm Class 23:

ShallowCopy

Creates a new Alarm that is a shallow copy of the current Alarm.

Alarm Class 24:

ToString

Returns a String that represents the Name of the current Alarm. (Overrides Object.ToString..)

Operators

 

Name

Description

Alarm Class 25:

Alarm Class 26:

Equality

Determines whether two instances of the Alarm class are equal.

Alarm Class 27:

Alarm Class 28:

GreaterThan

Determines whether the current instance of the Alarm class is greater than another instance.

Alarm Class 29:

Alarm Class 30:

GreaterThanOrEqual

Determines whether the current instance of the Alarm class is greater than or equal to another instance.

Alarm Class 31:

Alarm Class 32:

Inequality

Determines whether two instances of the Alarm class are not equal.

Alarm Class 33:

Alarm Class 34:

LessThan

Determines whether the current instance of the Alarm class is less than another instance.

Alarm Class 35:

Alarm Class 36:

LessThanOrEqual

Determines whether the current instance of the Alarm class is less than or equal to another instance.

Extension Methods

 

Name

Description

Alarm Class 37:

ToJson.

Overloaded.

Returns an unformatted JSON String that represents the current Alarm. (Defined by AlarmExtensions.)

Alarm Class 38:

ToJson(Boolean)

Overloaded.

Returns an unformatted JSON String that represents the current Alarm. (Defined by AlarmExtensions.)

Alarm Class 39:

ToJson(Boolean, Boolean)

Overloaded.

Returns a JSON String that represents the current Alarm. (Defined by AlarmExtensions.)

Reference

TcHmiSrv.Core Namespace