AlarmHysteresis Property

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.

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

Syntax

C++

JavaScript

Copy

public double? Hysteresis { get; set; }

Public Property Hysteresis As Double?
	Get
	Set

public:
property Nullable<double> Hysteresis {
	Nullable<double> get ();
	void set (Nullable<double> value);
}

member Hysteresis : Nullable<float> with get, set

function get_Hysteresis();
function set_Hysteresis(value);

View Source

Property Value

NullableDouble

Remarks

The hysteresis is an offset that provides padding between the point at which the alarm is raised and the point at which the alarm is cleared. For example, in the case of the GreaterOrEqual operation:

Raised: value >= SetPoint
Cleared: value < SetPoint - Hysteresis

The direction of the offset depends on whether the operation is greater than (or equal) or less than (or equal). The hysteresis must be greater than zero.

Reference

Alarm Class

GSF.TimeSeries Namespace