Struct Alert

Namespace

Pamoja.Profile

Assembly

Pamoja.Profile.dll

An alert a reading raised.

public readonly record struct Alert : IEquatable<Alert>

Implements

IEquatable<Alert>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

Only the value belonging to Kind is set.

Constructors

Alert(AlertKind, float?, uint?, float?, string?, float?)

An alert a reading raised.

public Alert(AlertKind Kind, float? Reading, uint? Samples, float? Rate, string? Code = null, float? Value = null)

Parameters

Kind AlertKind

Which threshold the reading crossed.

Reading float?

The offending reading, for an out-of-range or invalid-reading alert.

Samples uint?

The samples until empty, for a running-out alert.

Rate float?

The change since the previous sample, for a changing-fast alert.

Code string

The condition's name, for a custom alert.

Value float?

The measurement behind the condition, for a custom alert.

Remarks

Only the value belonging to Kind is set.

Properties

Code

The condition's name, for a custom alert.

public string? Code { get; init; }

Property Value

string

Kind

Which threshold the reading crossed.

public AlertKind Kind { get; init; }

Property Value

AlertKind

Rate

The change since the previous sample, for a changing-fast alert.

public float? Rate { get; init; }

Property Value

float?

Reading

The offending reading, for an out-of-range or invalid-reading alert.

public float? Reading { get; init; }

Property Value

float?

Samples

The samples until empty, for a running-out alert.

public uint? Samples { get; init; }

Property Value

uint?

Value

The measurement behind the condition, for a custom alert.

public float? Value { get; init; }

Property Value

float?