Table of Contents

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 string

The unique identifier for the alarm.

siteUrl string

The URL associated with the alarm.

profile AlarmProfile

The profile associated with the alarm.

state AlarmState

The current status of the alarm.

startDate DateTime

The start date of the alarm.

endDate DateTime?

The end date of the alarm, if applicable.

excursionExtreme Measurement

The extreme measurement value during the excursion, if applicable.

excursionType ExcursionType?

The type of excursion, if applicable.

lastValue Measurement

The 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

string

AlarmState

Gets the current state of the alarm.

public AlarmState AlarmState { get; }

Property Value

AlarmState

EndDate

Gets the end date of the alarm, if applicable.

public DateTime? EndDate { get; }

Property Value

DateTime?

ExcursionExtreme

Gets the extreme measurement value during the excursion, if applicable.

public Measurement? ExcursionExtreme { get; }

Property Value

Measurement

ExcursionType

Gets the type of excursion, if applicable.

public ExcursionType? ExcursionType { get; }

Property Value

ExcursionType?

LastValue

Gets the last measurement value recorded.

public Measurement? LastValue { get; }

Property Value

Measurement

LastValueDate

Gets the date of the last recorded measurement value.

public DateTime? LastValueDate { get; }

Property Value

DateTime?

Profile

Gets the profile associated with the alarm.

public AlarmProfile Profile { get; }

Property Value

AlarmProfile

SiteUrl

Gets the URL associated with the alarm.

public string SiteUrl { get; }

Property Value

string

StartDate

Gets the start date of the alarm.

public DateTime StartDate { get; }

Property Value

DateTime