PDComm.GemAlarmDefinition

Struct

Defines one equipment alarm for GemEquipment.ConfigureAlarms.

public readonly record struct GemAlarmDefinition

Parameters

Name	Description
`Id`	The alarm ID (ALID). IDs must be unique within the store.
`Category`	The alarm category, 1 through 63. It is sent in the low bits of the alarm code (ALCD); bit 8 of ALCD carries the active state.
`Text`	The alarm text (ALTX). It must contain only ASCII characters and be at most the smaller of `GemAlarmOptions.MaxTextBytes` and 120 bytes. An empty text is allowed.
`SetEvent`	The optional collection event ID (CEID) that `GemEquipment.ObserveAlarm` returns when the alarm becomes active. It must be one of the event IDs configured with `GemEquipment.ConfigureReports`.
`ClearEvent`	The optional collection event ID (CEID) that `GemEquipment.ObserveAlarm` returns when the alarm clears. It must be one of the configured report event IDs.

Members

`GemAlarmDefinition`

Constructor

Defines one equipment alarm for GemEquipment.ConfigureAlarms.

public GemAlarmDefinition(uint Id, byte Category, string Text, uint? SetEvent = null, uint? ClearEvent = null)

Parameters

Name	Description
`Id`	The alarm ID (ALID). IDs must be unique within the store.
`Category`	The alarm category, 1 through 63. It is sent in the low bits of the alarm code (ALCD); bit 8 of ALCD carries the active state.
`Text`	The alarm text (ALTX). It must contain only ASCII characters and be at most the smaller of `GemAlarmOptions.MaxTextBytes` and 120 bytes. An empty text is allowed.
`SetEvent`	The optional collection event ID (CEID) that `GemEquipment.ObserveAlarm` returns when the alarm becomes active. It must be one of the event IDs configured with `GemEquipment.ConfigureReports`.
`ClearEvent`	The optional collection event ID (CEID) that `GemEquipment.ObserveAlarm` returns when the alarm clears. It must be one of the configured report event IDs.

`Category`

Property

The alarm category, 1 through 63. It is sent in the low bits of the alarm code (ALCD); bit 8 of ALCD carries the active state.

public byte Category { get; init; }

`ClearEvent`

Property

The optional collection event ID (CEID) that GemEquipment.ObserveAlarm returns when the alarm clears. It must be one of the configured report event IDs.

public uint? ClearEvent { get; init; }

`Id`

Property

The alarm ID (ALID). IDs must be unique within the store.

public uint Id { get; init; }

`SetEvent`

Property

The optional collection event ID (CEID) that GemEquipment.ObserveAlarm returns when the alarm becomes active. It must be one of the event IDs configured with GemEquipment.ConfigureReports.

public uint? SetEvent { get; init; }

`Text`

Property

The alarm text (ALTX). It must contain only ASCII characters and be at most the smaller of GemAlarmOptions.MaxTextBytes and 120 bytes. An empty text is allowed.

public string Text { get; init; }