Alarm Class

Represents an alarm that tests the values of an incoming signal to determine the state of alarm.

Inheritance Hierarchy

SystemObject
GSF.TimeSeriesAlarm

Namespace: GSF.TimeSeries
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.181-beta

Syntax

[SerializableAttribute]
public class Alarm : ICloneable

<SerializableAttribute>
Public Class Alarm
	Implements ICloneable

[SerializableAttribute]
public ref class Alarm : ICloneable

[<SerializableAttribute>]
type Alarm = 
    class
        interface ICloneable
    end

GSF.TimeSeries.Alarm = function();

Type.createClass(
	'GSF.TimeSeries.Alarm',
	null,
	ICloneable);

The Alarm type exposes the following members.

Constructors

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

Properties

	Name	Description
	AssociatedMeasurementID	Gets or sets the identification number of the measurements generated for alarm events.
	Cause	Gets the most recent measurement that caused the alarm to be raised.
	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. This value is only relevant in greater than (or equal) and less than (or equal) operations.
	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. This value is irrelevant for the Flatline operation.
	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 current state of the alarm (raised or cleared).
	TagName	Gets or sets the tag name of the alarm.
	TimeRaised	Gets or sets the timestamp of the most recent measurement that caused the alarm to be raised.
	Tolerance	Gets or sets a tolerance window around the SetPoint to use when comparing against the value of the signal. This value is only relevant for the Equal and NotEqual operations.

Methods

	Name	Description
	Clone	Creates a new alarm that is a copy of the current instance.
	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)
	Test	Tests the value of the given measurement to determine whether the alarm should be raised or cleared.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)