C# Class GSF.TimeSeries.Alarm

Represents an alarm that tests the values of an incoming signal to determine the state of alarm.
Show file Open project: GridProtectionAlliance/gsf Class Usage Examples

Public Methods

Method Description
Alarm ( ) : System

Creates a new instance of the Alarm class.
Alarm ( AlarmOperation operation ) : System

Creates a new instance of the Alarm class.
Clone ( ) : Alarm

Creates a new alarm that is a copy of the current instance.
Test ( IMeasurement measurement ) : bool

Tests the value of the given measurement to determine whether the alarm should be raised or cleared.

Private Methods

Method Description
CheckDelay ( IMeasurement measurement, bool raiseCondition ) : bool
ClearIfNotEqual ( IMeasurement measurement ) : bool
ClearIfNotFlatline ( IMeasurement measurement ) : bool
ClearIfNotGreaterOrEqual ( IMeasurement measurement ) : bool
ClearIfNotGreaterThan ( IMeasurement measurement ) : bool
ClearIfNotLessOrEqual ( IMeasurement measurement ) : bool
ClearIfNotLessThan ( IMeasurement measurement ) : bool
ClearIfNotNotEqual ( IMeasurement measurement ) : bool
GetClearTest ( ) : bool>.Func
GetRaiseTest ( ) : bool>.Func
ICloneable ( ) : object

Creates a new object that is a copy of the current instance.
RaiseIfEqual ( IMeasurement measurement ) : bool
RaiseIfFlatline ( IMeasurement measurement ) : bool
RaiseIfGreaterOrEqual ( IMeasurement measurement ) : bool
RaiseIfGreaterThan ( IMeasurement measurement ) : bool
RaiseIfLessOrEqual ( IMeasurement measurement ) : bool
RaiseIfLessThan ( IMeasurement measurement ) : bool
RaiseIfNotEqual ( IMeasurement measurement ) : bool

Method Details

Alarm() public method

Creates a new instance of the Alarm class.
public Alarm ( ) : System
return System

Alarm() public method

Creates a new instance of the Alarm class.
public Alarm ( AlarmOperation operation ) : System
operation AlarmOperation The operation to be performed when testing values from the incoming signal.
return System

Clone() public method

Creates a new alarm that is a copy of the current instance.
public Clone ( ) : Alarm
return Alarm

Test() public method

Tests the value of the given measurement to determine whether the alarm should be raised or cleared.
public Test ( IMeasurement measurement ) : bool
measurement IMeasurement The measurement whose value is to be tested.
return bool