PDComm.GemFormattedProgramExecutionInfo

Class

Summarizes the equipment's formatted process program execution at the time of a snapshot.

public sealed record GemFormattedProgramExecutionInfo

Returned by GemFormattedProgramExecutionSnapshot.GetInfo. The execution is local state that the application drives and reports; the library performs no equipment I/O. GemFormattedProgramExecutionInfo.PresenceMask tells which optional fields hold a value. Absent fields, and every field while no execution exists, are 0.

Parameters

Name	Description
State	The GemFormattedProgramExecutionState code, 0 empty to 9 outcome unknown; the states from 5 on are terminal.
PresenceMask	Bit flags: 1 an action is pending, 2 the application reported a terminal outcome with GemFormattedPrograms.CompleteExecution, 4 that report has detail bytes.
PendingKind	The kind of the pending action: 0 none, 1 start, 2 step or 3 cancel.
DryRunOutcome	The GemFormattedProgramDryRunOutcome code of the dry run the execution started from.
PolicyVersion	The dry run policy version the execution started from.
ApplicationReportKind	The GemFormattedProgramTerminalOutcome code of the application report, or 0 when there is none.
CapabilityPresent	Whether the starting dry run had capability data; 1 when set, otherwise 0.
IdFormat	The SECS-II format code of the executed program's PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).
EndpointId	The process-local identity of the endpoint that runs the execution.
SessionGeneration	The connection generation in which the execution started.
StoreRevision	The program store revision captured when the executed program was selected.
EntryGeneration	The store entry generation captured when the executed program was selected.
SelectionGeneration	The selection generation of the selection the execution started from.
CapabilityRevision	The capability catalog revision of the starting dry run.
ExecutionGeneration	The execution number.
PendingActionSequence	The sequence number of the pending action.
ApplicationReportId	The report ID that the application passed with its terminal report.
CommandCount	The number of commands in the executed program.
NextCommandIndex	The zero-based index of the next command to step; it advances when a step action is reported as applied.
ApplicationDetailLength	The length, in bytes, of the detail of the application report; read it with GemFormattedProgramExecutionSnapshot.GetApplicationDetailBytes.

Members

GemFormattedProgramExecutionInfo

Constructor

Summarizes the equipment's formatted process program execution at the time of a snapshot.

public GemFormattedProgramExecutionInfo(uint State, uint PresenceMask, uint PendingKind, uint DryRunOutcome, uint PolicyVersion, uint ApplicationReportKind, byte CapabilityPresent, byte IdFormat, ulong EndpointId, ulong SessionGeneration, ulong StoreRevision, ulong EntryGeneration, ulong SelectionGeneration, ulong CapabilityRevision, ulong ExecutionGeneration, ulong PendingActionSequence, ulong ApplicationReportId, nuint CommandCount, nuint NextCommandIndex, nuint ApplicationDetailLength)

Returned by GemFormattedProgramExecutionSnapshot.GetInfo. The execution is local state that the application drives and reports; the library performs no equipment I/O. GemFormattedProgramExecutionInfo.PresenceMask tells which optional fields hold a value. Absent fields, and every field while no execution exists, are 0.

Parameters

Name	Description
State	The GemFormattedProgramExecutionState code, 0 empty to 9 outcome unknown; the states from 5 on are terminal.
PresenceMask	Bit flags: 1 an action is pending, 2 the application reported a terminal outcome with GemFormattedPrograms.CompleteExecution, 4 that report has detail bytes.
PendingKind	The kind of the pending action: 0 none, 1 start, 2 step or 3 cancel.
DryRunOutcome	The GemFormattedProgramDryRunOutcome code of the dry run the execution started from.
PolicyVersion	The dry run policy version the execution started from.
ApplicationReportKind	The GemFormattedProgramTerminalOutcome code of the application report, or 0 when there is none.
CapabilityPresent	Whether the starting dry run had capability data; 1 when set, otherwise 0.
IdFormat	The SECS-II format code of the executed program's PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).
EndpointId	The process-local identity of the endpoint that runs the execution.
SessionGeneration	The connection generation in which the execution started.
StoreRevision	The program store revision captured when the executed program was selected.
EntryGeneration	The store entry generation captured when the executed program was selected.
SelectionGeneration	The selection generation of the selection the execution started from.
CapabilityRevision	The capability catalog revision of the starting dry run.
ExecutionGeneration	The execution number.
PendingActionSequence	The sequence number of the pending action.
ApplicationReportId	The report ID that the application passed with its terminal report.
CommandCount	The number of commands in the executed program.
NextCommandIndex	The zero-based index of the next command to step; it advances when a step action is reported as applied.
ApplicationDetailLength	The length, in bytes, of the detail of the application report; read it with GemFormattedProgramExecutionSnapshot.GetApplicationDetailBytes.

ApplicationDetailLength

Property

The length, in bytes, of the detail of the application report; read it with GemFormattedProgramExecutionSnapshot.GetApplicationDetailBytes.

public nuint ApplicationDetailLength { get; init; }

ApplicationReportId

Property

The report ID that the application passed with its terminal report.

public ulong ApplicationReportId { get; init; }

ApplicationReportKind

Property

The GemFormattedProgramTerminalOutcome code of the application report, or 0 when there is none.

public uint ApplicationReportKind { get; init; }

CapabilityPresent

Property

Whether the starting dry run had capability data; 1 when set, otherwise 0.

public byte CapabilityPresent { get; init; }

CapabilityRevision

Property

The capability catalog revision of the starting dry run.

public ulong CapabilityRevision { get; init; }

CommandCount

Property

The number of commands in the executed program.

public nuint CommandCount { get; init; }

DryRunOutcome

Property

The GemFormattedProgramDryRunOutcome code of the dry run the execution started from.

public uint DryRunOutcome { get; init; }

EndpointId

Property

The process-local identity of the endpoint that runs the execution.

public ulong EndpointId { get; init; }

EntryGeneration

Property

The store entry generation captured when the executed program was selected.

public ulong EntryGeneration { get; init; }

ExecutionGeneration

Property

The execution number.

public ulong ExecutionGeneration { get; init; }

IdFormat

Property

The SECS-II format code of the executed program's PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).

public byte IdFormat { get; init; }

NextCommandIndex

Property

The zero-based index of the next command to step; it advances when a step action is reported as applied.

public nuint NextCommandIndex { get; init; }

PendingActionSequence

Property

The sequence number of the pending action.

public ulong PendingActionSequence { get; init; }

PendingKind

Property

The kind of the pending action: 0 none, 1 start, 2 step or 3 cancel.

public uint PendingKind { get; init; }

PolicyVersion

Property

The dry run policy version the execution started from.

public uint PolicyVersion { get; init; }

PresenceMask

Property

Bit flags: 1 an action is pending, 2 the application reported a terminal outcome with GemFormattedPrograms.CompleteExecution, 4 that report has detail bytes.

public uint PresenceMask { get; init; }

SelectionGeneration

Property

The selection generation of the selection the execution started from.

public ulong SelectionGeneration { get; init; }

SessionGeneration

Property

The connection generation in which the execution started.

public ulong SessionGeneration { get; init; }

State

Property

The GemFormattedProgramExecutionState code, 0 empty to 9 outcome unknown; the states from 5 on are terminal.

public uint State { get; init; }

StoreRevision

Property

The program store revision captured when the executed program was selected.

public ulong StoreRevision { get; init; }