Alarm Class

Inheritance Hierarchy

SystemObject
TcHmiSrv.CoreAlarm

Namespace: TcHmiSrv.Core
Assembly: TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 3.1.7447.0+85f9b473a1dd11b8f3e5c9a182fd1901975e46f9

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	Initializes a new instance of the Alarm class.
	Alarm(Context, String)	Initializes a new instance of the Alarm class with the specified Context and name.

Properties

	Name	Description
	AlarmState	Contains the AlarmState of the Alarm.
	ConfirmationState	Contains the AlarmConfirmationState of the Alarm.
	Domain	Contains the domain of the Alarm.
	Id	Contains the unique identifier of the Alarm.
	IsActive	Contains a value that indicates whether the Alarm is active. The active state is automatically generated from the AlarmState and ConfirmationState. You should only use this if you explicitly want to set a different value. The value you have set will be overwritten as soon as the AlarmState or ConfirmationState is changed.
	IsSet	Gets a value that indicates whether the Alarm is set.
	Name	Contains the name of the language variable.
	Parameters	Gets the parameters of the localizable object. The names of the parameters must match the placeholders in the localization string.
	Severity	Contains the Severity of the Alarm.
	TimeCleared	Contains the DateTime when the Alarm was cleared.
	TimeConfirmed	Contains the DateTime when the Alarm was confirmed.
	TimeRaised	Contains the DateTime when the Alarm was raised.
	Type	Gets the ValueType of the localizable object that will be Alarm.

Methods

	Name	Description
	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.
	DeepCopy	Creates a new object that is a deep copy of the current Alarm.
	Equals(Alarm)	Indicates whether the current Alarm is equal to another Alarm.
	Equals(Object)	Determines whether the specified Object is equal to the current Alarm. (Overrides ObjectEquals(Object))
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Overrides ObjectGetHashCode)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ShallowCopy	Creates a new Alarm that is a shallow copy of the current Alarm.
	ToString	Returns a String that represents the Name of the current Alarm. (Overrides ObjectToString)

Operators

	Name	Description
	Equality(Alarm, Alarm)	Determines whether two instances of the Alarm class are equal.
	GreaterThan(Alarm, Alarm)	Determines whether the current instance of the Alarm class is greater than another instance.
	GreaterThanOrEqual(Alarm, Alarm)	Determines whether the current instance of the Alarm class is greater than or equal to another instance.
	Inequality(Alarm, Alarm)	Determines whether two instances of the Alarm class are not equal.
	LessThan(Alarm, Alarm)	Determines whether the current instance of the Alarm class is less than another instance.
	LessThanOrEqual(Alarm, Alarm)	Determines whether the current instance of the Alarm class is less than or equal to another instance.

Extension Methods

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

Version Information

Supported in: 3.1.7447.0, 2.3.7447.0, 1.10.7447.0

Reference

TcHmiSrv.Core Namespace