PDComm.GemFormattedProgramDryRunInfo

Class

Summarizes a formatted process program dry run report.

public sealed record GemFormattedProgramDryRunInfo

Returned by GemFormattedProgramDryRunReport.GetInfo. The generation and revision fields record the selection and capability catalog the report evaluated; GemFormattedPrograms.StartExecution accepts the report only while they still match.

Parameters

Name	Description
Outcome	The overall outcome, the most severe outcome of all issues: 0 pass, 1 indeterminate or 2 reject; see GemFormattedProgramDryRunOutcome.
PolicyVersion	The policy version the report was evaluated with.
IdFormat	The SECS-II format code of the evaluated program's PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).
CapabilityPresent	Whether the equipment's capability catalog held data; without it the report has an indeterminate capability-missing issue. 1 when set, otherwise 0.
EndpointId	The process-local identity of the endpoint that produced the report.
SessionGeneration	The connection generation in which the evaluated program was selected.
StoreRevision	The program store revision captured when the program was selected.
EntryGeneration	The store entry generation captured when the program was selected.
SelectionGeneration	The selection generation of the evaluated selection.
CapabilityRevision	The revision of the capability catalog the program was compared with.
EncodedBytes	The encoded size, in bytes, of the evaluated program (its S7F23 body).
CommandCount	The number of commands in the evaluated program.
IssueCount	The number of issues; read each with GemFormattedProgramDryRunReport.GetIssueInfo.

Members

GemFormattedProgramDryRunInfo

Constructor

Summarizes a formatted process program dry run report.

public GemFormattedProgramDryRunInfo(uint Outcome, uint PolicyVersion, byte IdFormat, byte CapabilityPresent, ulong EndpointId, ulong SessionGeneration, ulong StoreRevision, ulong EntryGeneration, ulong SelectionGeneration, ulong CapabilityRevision, nuint EncodedBytes, nuint CommandCount, nuint IssueCount)

Returned by GemFormattedProgramDryRunReport.GetInfo. The generation and revision fields record the selection and capability catalog the report evaluated; GemFormattedPrograms.StartExecution accepts the report only while they still match.

Parameters

Name	Description
Outcome	The overall outcome, the most severe outcome of all issues: 0 pass, 1 indeterminate or 2 reject; see GemFormattedProgramDryRunOutcome.
PolicyVersion	The policy version the report was evaluated with.
IdFormat	The SECS-II format code of the evaluated program's PPID: 16 (SecsFormat.Ascii) or 8 (SecsFormat.Binary).
CapabilityPresent	Whether the equipment's capability catalog held data; without it the report has an indeterminate capability-missing issue. 1 when set, otherwise 0.
EndpointId	The process-local identity of the endpoint that produced the report.
SessionGeneration	The connection generation in which the evaluated program was selected.
StoreRevision	The program store revision captured when the program was selected.
EntryGeneration	The store entry generation captured when the program was selected.
SelectionGeneration	The selection generation of the evaluated selection.
CapabilityRevision	The revision of the capability catalog the program was compared with.
EncodedBytes	The encoded size, in bytes, of the evaluated program (its S7F23 body).
CommandCount	The number of commands in the evaluated program.
IssueCount	The number of issues; read each with GemFormattedProgramDryRunReport.GetIssueInfo.

CapabilityPresent

Property

Whether the equipment's capability catalog held data; without it the report has an indeterminate capability-missing issue. 1 when set, otherwise 0.

public byte CapabilityPresent { get; init; }

CapabilityRevision

Property

The revision of the capability catalog the program was compared with.

public ulong CapabilityRevision { get; init; }

CommandCount

Property

The number of commands in the evaluated program.

public nuint CommandCount { get; init; }

EncodedBytes

Property

The encoded size, in bytes, of the evaluated program (its S7F23 body).

public nuint EncodedBytes { get; init; }

EndpointId

Property

The process-local identity of the endpoint that produced the report.

public ulong EndpointId { get; init; }

EntryGeneration

Property

The store entry generation captured when the program was selected.

public ulong EntryGeneration { get; init; }

IdFormat

Property

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

public byte IdFormat { get; init; }

IssueCount

Property

The number of issues; read each with GemFormattedProgramDryRunReport.GetIssueInfo.

public nuint IssueCount { get; init; }

Outcome

Property

The overall outcome, the most severe outcome of all issues: 0 pass, 1 indeterminate or 2 reject; see GemFormattedProgramDryRunOutcome.

public uint Outcome { get; init; }

PolicyVersion

Property

The policy version the report was evaluated with.

public uint PolicyVersion { get; init; }

SelectionGeneration

Property

The selection generation of the evaluated selection.

public ulong SelectionGeneration { get; init; }

SessionGeneration

Property

The connection generation in which the evaluated program was selected.

public ulong SessionGeneration { get; init; }

StoreRevision

Property

The program store revision captured when the program was selected.

public ulong StoreRevision { get; init; }