Gemstone Timeseries Library
Alarm Class
Represents an alarm that tests the values of
an incoming signal to determine the state of alarm.
Definition
Namespace: Gemstone.Timeseries
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.136 -- Release Build+045677775a56d15698be6ced5ce5213063e47102
Assembly: Gemstone.Timeseries (in Gemstone.Timeseries.dll) Version: 1.0.136 -- Release Build+045677775a56d15698be6ced5ce5213063e47102
C#
[SerializableAttribute]
public class Alarm : ICloneableVB
<SerializableAttribute>
Public Class Alarm
Implements ICloneableC++
[SerializableAttribute]
public ref class Alarm : ICloneableJavaScript
Gemstone.Timeseries.Alarm = function();
Type.createClass(
'Gemstone.Timeseries.Alarm',
null,
ICloneable);- Inheritance
- Object Alarm
- Implements
- ICloneable
Constructors
| Alarm | Creates a new instance of the Alarm class. |
| Alarm(AlarmOperation) | Creates a new instance of the Alarm class. |
Properties
| ActiveTags | Gets the latest set of measurement keys that cause the Alarm to be raised. |
| Cause | Gets the most recent frame that caused the alarm to be raised. |
| Combination | Gets or sets the combination logic of the alarm. |
| CreateAssociatedMeasurement | Gets or sets flag to indicate that a measurement should be created for this alarm. |
| 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. |
| Enabled | Gets and Sets Enabled flag |
| 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. |
| InputMeasurementKeys | Gets or sets the identification the measurements used to trigger 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 the measurements generated for alarm events. |
| State | Gets or sets the current state of the alarm (raised or cleared). |
| TagName | Gets or sets the tag name of the alarm. |
| Timeout | Gets or sets the Timeout in seconds at which the alarm stops if no data comes in. |
| 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
| 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 frame to determine whether the alarm should be raised or cleared. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |