Struct Alert
An alert a reading raised.
public readonly record struct Alert : IEquatable<Alert>
- Implements
- Inherited Members
Remarks
Only the value belonging to Kind is set.
Constructors
Alert(AlertKind, float?, uint?, float?)
An alert a reading raised.
public Alert(AlertKind Kind, float? Reading, uint? Samples, float? Rate)
Parameters
KindAlertKindWhich threshold the reading crossed.
Readingfloat?The offending reading, for an out-of-range alert.
Samplesuint?The samples until empty, for a running-out alert.
Ratefloat?The change since the previous sample, for a changing-fast alert.
Remarks
Only the value belonging to Kind is set.
Properties
Kind
Which threshold the reading crossed.
public AlertKind Kind { get; init; }
Property Value
Rate
The change since the previous sample, for a changing-fast alert.
public float? Rate { get; init; }
Property Value
Reading
The offending reading, for an out-of-range alert.
public float? Reading { get; init; }
Property Value
Samples
The samples until empty, for a running-out alert.
public uint? Samples { get; init; }
Property Value
- uint?