PDComm.GemState

Struct

Represents a snapshot of the GEM state of an endpoint.

public readonly record struct GemState

Parameters

Name	Description
`Role`	The role of the endpoint.
`Communication`	The GEM communication state.
`Control`	The equipment control state, or `null` for a host.
`OnlineMode`	The equipment on-line mode, or `null` for a host.
`EndpointId`	The process-unique ID of the underlying HSMS endpoint.
`Generation`	The connection generation of the underlying HSMS endpoint.
`PendingCount`	The number of GEM requests waiting for a reply (at most 32).
`PendingIds`	The number of requested IDs held by the pending requests.
`VariableCount`	The number of registered status variables; zero for a host.

Members

`GemState`

Constructor

Represents a snapshot of the GEM state of an endpoint.

public GemState(GemRole Role, GemCommunicationState Communication, GemControlState? Control, GemOnlineMode? OnlineMode, ulong EndpointId, ulong Generation, nuint PendingCount, nuint PendingIds, nuint VariableCount)

Parameters

Name	Description
`Role`	The role of the endpoint.
`Communication`	The GEM communication state.
`Control`	The equipment control state, or `null` for a host.
`OnlineMode`	The equipment on-line mode, or `null` for a host.
`EndpointId`	The process-unique ID of the underlying HSMS endpoint.
`Generation`	The connection generation of the underlying HSMS endpoint.
`PendingCount`	The number of GEM requests waiting for a reply (at most 32).
`PendingIds`	The number of requested IDs held by the pending requests.
`VariableCount`	The number of registered status variables; zero for a host.

`Communication`

Property

The GEM communication state.

public GemCommunicationState Communication { get; init; }

`Control`

Property

The equipment control state, or null for a host.

public GemControlState? Control { get; init; }

`EndpointId`

Property

The process-unique ID of the underlying HSMS endpoint.

public ulong EndpointId { get; init; }

`Generation`

Property

The connection generation of the underlying HSMS endpoint.

public ulong Generation { get; init; }

`OnlineMode`

Property

The equipment on-line mode, or null for a host.

public GemOnlineMode? OnlineMode { get; init; }

`PendingCount`

Property

The number of GEM requests waiting for a reply (at most 32).

public nuint PendingCount { get; init; }

`PendingIds`

Property

The number of requested IDs held by the pending requests.

public nuint PendingIds { get; init; }

`Role`

Property

The role of the endpoint.

public GemRole Role { get; init; }

`VariableCount`

Property

The number of registered status variables; zero for a host.

public nuint VariableCount { get; init; }