Class Alarm
- Namespace
- SenseAnywhere.Sdk.Alarms
- Assembly
- SenseAnywhere.Sdk.dll
Represents an alarm with its associated properties and status.
public sealed class Alarm
- Inheritance
-
Alarm
- Inherited Members
Constructors
Alarm(string, string, AlarmProfile, AlarmState, DateTime, DateTime?, Measurement?, ExcursionType?, Measurement?, DateTime?)
Initializes a new instance of the Alarm class.
public Alarm(string alarmId, string siteUrl, AlarmProfile profile, AlarmState state, DateTime startDate, DateTime? endDate, Measurement? excursionExtreme, ExcursionType? excursionType, Measurement? lastValue, DateTime? lastValueDate)
Parameters
alarmId
stringThe unique identifier for the alarm.
siteUrl
stringThe URL associated with the alarm.
profile
AlarmProfileThe profile associated with the alarm.
state
AlarmStateThe current status of the alarm.
startDate
DateTimeThe start date of the alarm.
endDate
DateTime?The end date of the alarm, if applicable.
excursionExtreme
MeasurementThe extreme measurement value during the excursion, if applicable.
excursionType
ExcursionType?The type of excursion, if applicable.
lastValue
MeasurementThe last measurement value recorded.
lastValueDate
DateTime?The date of the last recorded measurement value.
Properties
AlarmId
Gets the unique identifier for the alarm.
public string AlarmId { get; }
Property Value
AlarmState
Gets the current state of the alarm.
public AlarmState AlarmState { get; }
Property Value
EndDate
Gets the end date of the alarm, if applicable.
public DateTime? EndDate { get; }
Property Value
ExcursionExtreme
Gets the extreme measurement value during the excursion, if applicable.
public Measurement? ExcursionExtreme { get; }
Property Value
ExcursionType
Gets the type of excursion, if applicable.
public ExcursionType? ExcursionType { get; }
Property Value
LastValue
Gets the last measurement value recorded.
public Measurement? LastValue { get; }
Property Value
LastValueDate
Gets the date of the last recorded measurement value.
public DateTime? LastValueDate { get; }
Property Value
Profile
Gets the profile associated with the alarm.
public AlarmProfile Profile { get; }
Property Value
SiteUrl
Gets the URL associated with the alarm.
public string SiteUrl { get; }
Property Value
StartDate
Gets the start date of the alarm.
public DateTime StartDate { get; }