PDComm.GemFormattedProgramSelectionToken

Class

Identifies the equipment's current formatted process program selection.

public sealed record GemFormattedProgramSelectionToken

GemFormattedPrograms.SelectProgram returns it. Pass it unchanged to GemFormattedPrograms.ClearSelection, GemFormattedPrograms.ValidateSelection, GemFormattedPrograms.DryRun and GemFormattedPrograms.StartExecution; a token that does not match the current selection fails with PdcommStatus.StaleToken.

Parameters

Name	Description
`EndpointId`	The process-local identity of the endpoint that made the selection.
`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 selection generation; it increases when a new selection replaces the current one and when the selection is cleared.

Members

`GemFormattedProgramSelectionToken`

Constructor

Identifies the equipment's current formatted process program selection.

public GemFormattedProgramSelectionToken(ulong EndpointId, ulong SessionGeneration, ulong StoreRevision, ulong EntryGeneration, ulong SelectionGeneration)

Parameters

Name	Description
`EndpointId`	The process-local identity of the endpoint that made the selection.
`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 selection generation; it increases when a new selection replaces the current one and when the selection is cleared.

`EndpointId`

Property

The process-local identity of the endpoint that made the selection.

public ulong EndpointId { get; init; }

`EntryGeneration`

Property

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

public ulong EntryGeneration { get; init; }

`SelectionGeneration`

Property

The selection generation; it increases when a new selection replaces the current one and when the selection is cleared.

public ulong SelectionGeneration { get; init; }

`SessionGeneration`

Property

The connection generation in which the program was selected.

public ulong SessionGeneration { get; init; }

`StoreRevision`

Property

The program store revision when the program was selected.

public ulong StoreRevision { get; init; }