PDComm.GemFormattedProgramSelectionInfo

Class

Describes the equipment's formatted process program selection at the time of a snapshot.

public sealed record GemFormattedProgramSelectionInfo

Returned by GemFormattedProgramSelectionSnapshot.GetInfo. Selection is local state and never performs physical execution. While nothing is selected, every field except GemFormattedProgramSelectionInfo.SelectionGeneration is 0.

Parameters

Name	Description
`State`	The selection state: `0` empty, `1` ready or `2` stale.
`StaleReason`	Why a stale selection is stale: `1` the store entry was deleted, `2` the entry changed, `3` the connection generation changed, `4` the connection was lost; `0` when the selection is not stale.
`IdFormat`	The SECS-II format code of the selected PPID: `16` (`SecsFormat.Ascii`) or `8` (`SecsFormat.Binary`).
`ValidForExecution`	Whether the selection is ready and can start an execution; `1` when set, otherwise `0`.
`SessionGeneration`	The connection generation in which the program was selected.
`StoreRevision`	The program store revision when the program was selected.
`EntryGeneration`	The generation of the selected store entry when the program was selected.
`SelectionGeneration`	The current selection generation.
`CommandCount`	The number of commands in the selected program.

Members

`GemFormattedProgramSelectionInfo`

Constructor

Describes the equipment's formatted process program selection at the time of a snapshot.

public GemFormattedProgramSelectionInfo(uint State, uint StaleReason, byte IdFormat, byte ValidForExecution, ulong SessionGeneration, ulong StoreRevision, ulong EntryGeneration, ulong SelectionGeneration, nuint CommandCount)

Parameters

Name	Description
`State`	The selection state: `0` empty, `1` ready or `2` stale.
`StaleReason`	Why a stale selection is stale: `1` the store entry was deleted, `2` the entry changed, `3` the connection generation changed, `4` the connection was lost; `0` when the selection is not stale.
`IdFormat`	The SECS-II format code of the selected PPID: `16` (`SecsFormat.Ascii`) or `8` (`SecsFormat.Binary`).
`ValidForExecution`	Whether the selection is ready and can start an execution; `1` when set, otherwise `0`.
`SessionGeneration`	The connection generation in which the program was selected.
`StoreRevision`	The program store revision when the program was selected.
`EntryGeneration`	The generation of the selected store entry when the program was selected.
`SelectionGeneration`	The current selection generation.
`CommandCount`	The number of commands in the selected program.

`CommandCount`

Property

The number of commands in the selected program.

public nuint CommandCount { get; init; }

`EntryGeneration`

Property

The generation of the selected store entry when the program was selected.

public ulong EntryGeneration { get; init; }

`IdFormat`

Property

The SECS-II format code of the selected PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).

public byte IdFormat { get; init; }

`SelectionGeneration`

Property

The current selection generation.

public ulong SelectionGeneration { get; init; }

`SessionGeneration`

Property

The connection generation in which the program was selected.

public ulong SessionGeneration { get; init; }

`StaleReason`

Property

Why a stale selection is stale: 1 the store entry was deleted, 2 the entry changed, 3 the connection generation changed, 4 the connection was lost; 0 when the selection is not stale.

public uint StaleReason { get; init; }

`State`

Property

The selection state: 0 empty, 1 ready or 2 stale.

public uint State { get; init; }

`StoreRevision`

Property

The program store revision when the program was selected.

public ulong StoreRevision { get; init; }

`ValidForExecution`

Property

Whether the selection is ready and can start an execution; 1 when set, otherwise 0.

public byte ValidForExecution { get; init; }