SerializableAlarm Class

Represents a serializable Alarm that can be serialized using XmlSerializer, DataContractSerializer or DataContractJsonSerializer.

Inheritance Hierarchy

SystemObject
DataQualityMonitoring.ServicesSerializableAlarm

Namespace: DataQualityMonitoring.Services
Assembly: DataQualityMonitoring (in DataQualityMonitoring.dll) Version: 2.4.181-beta

Syntax

[XmlTypeAttribute("Alarm")]
[DataContractAttribute(Name = "Alarm", Namespace = "")]
public class SerializableAlarm

<XmlTypeAttribute("Alarm")>
<DataContractAttribute(Name := "Alarm", Namespace := "")>
Public Class SerializableAlarm

[XmlTypeAttribute(L"Alarm")]
[DataContractAttribute(Name = L"Alarm", Namespace = L"")]
public ref class SerializableAlarm

[<XmlTypeAttribute("Alarm")>]
[<DataContractAttribute(Name = "Alarm", Namespace = "")>]
type SerializableAlarm = class end

DataQualityMonitoring.Services.SerializableAlarm = function();

Type.createClass(
	'DataQualityMonitoring.Services.SerializableAlarm');

The SerializableAlarm type exposes the following members.

Constructors

	Name	Description
	SerializableAlarm	Creates a new instance of the SerializableAlarm class.
	SerializableAlarm(Alarm)	Creates a new instance of the SerializableAlarm class.

Properties

	Name	Description
	Delay	Gets or sets the amount of time that the signal must be exhibiting alarming behavior before the alarm is raised.
	Description	Gets or sets the description of the alarm.
	Hysteresis	Gets or sets the hysteresis used when clearing alarms.
	ID	Gets or sets the identification number of the alarm.
	Operation	Gets or sets the operation to be performed when testing values from the incoming signal.
	SetPoint	Gets or sets the value to be compared against the signal to determine whether to raise the alarm.
	Severity	Gets or sets the severity of the alarm.
	SignalID	Gets or sets the identification number of the signal whose value is monitored by the alarm.
	State	Gets or sets the state of the alarm (raised or cleared).
	TagName	Gets or sets the tag name of the alarm.
	TimeRaised	Gets or sets the time at which the alarm was raised.
	Tolerance	Gets or sets a tolerance window around the SetPoint to use when comparing against the value of the signal.
	ValueAtTimeRaised	Gets or sets the value of the signal at the time that the alarm was raised.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from 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. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)