Skip to content
Start free evaluation

PDComm.GemAlarmInfo

Struct

Represents the local state and metadata of one configured equipment alarm.

public readonly record struct GemAlarmInfo

Parameters

NameDescription
IdThe alarm ID (ALID).
CategoryThe alarm category, 1 through 63.
ActiveWhether the last observed state of the alarm is active (set).
EnabledWhether alarm reporting is enabled. Alarms start disabled; the host enables them with S5F3.
SetEventThe collection event ID (CEID) mapped to the set transition, if any.
ClearEventThe collection event ID (CEID) mapped to the clear transition, if any.

Members

GemAlarmInfo

Constructor

Represents the local state and metadata of one configured equipment alarm.

public GemAlarmInfo(uint Id, byte Category, bool Active, bool Enabled, uint? SetEvent, uint? ClearEvent)

Parameters

NameDescription
IdThe alarm ID (ALID).
CategoryThe alarm category, 1 through 63.
ActiveWhether the last observed state of the alarm is active (set).
EnabledWhether alarm reporting is enabled. Alarms start disabled; the host enables them with S5F3.
SetEventThe collection event ID (CEID) mapped to the set transition, if any.
ClearEventThe collection event ID (CEID) mapped to the clear transition, if any.

Active

Property

Whether the last observed state of the alarm is active (set).

public bool Active { get; init; }

Category

Property

The alarm category, 1 through 63.

public byte Category { get; init; }

ClearEvent

Property

The collection event ID (CEID) mapped to the clear transition, if any.

public uint? ClearEvent { get; init; }

Enabled

Property

Whether alarm reporting is enabled. Alarms start disabled; the host enables them with S5F3.

public bool Enabled { get; init; }

Id

Property

The alarm ID (ALID).

public uint Id { get; init; }

SetEvent

Property

The collection event ID (CEID) mapped to the set transition, if any.

public uint? SetEvent { get; init; }