PDComm.GemFormattedProgramDryRunIssueInfo

Class

Describes one issue of a formatted process program dry run report.

public sealed record GemFormattedProgramDryRunIssueInfo

Returned by GemFormattedProgramDryRunReport.GetIssueInfo. GemFormattedProgramDryRunIssueInfo.PresenceMask tells which optional fields hold a value; an absent field is 0.

Parameters

Name	Description
`Code`	The issue code: `1` capability missing, `2` model mismatch, `3` software revision mismatch, `4` command count exceeded, `5` encoded bytes exceeded, `6` unknown ASCII command, `7` required command missing, `8` unsigned command code unmapped, `9` dependency semantics not evaluated, `10` program parameter semantics not evaluated, `11` capability parameter semantics not evaluated.
`Outcome`	The outcome the issue contributes: `1` indeterminate or `2` reject; see `GemFormattedProgramDryRunOutcome`.
`PresenceMask`	Bit flags of the optional fields: `1` `GemFormattedProgramDryRunIssueInfo.CommandIndex`, `2` `GemFormattedProgramDryRunIssueInfo.FieldIndex`, `4` `GemFormattedProgramDryRunIssueInfo.Observed`, `8` `GemFormattedProgramDryRunIssueInfo.Expected`.
`CommandIndex`	The zero-based command index: a command of the program for codes `6`, `8` and `10`, a command of the capability catalog for codes `7`, `9` and `11`.
`FieldIndex`	The zero-based field index; policy version `1` never sets it.
`Observed`	The observed value: the program's command count for code `4`, its encoded size in bytes for code `5`, and the command's parameter count for codes `10` and `11`.
`Expected`	The expected maximum: CMDMAX for code `4` and BYTMAX for code `5`.

Members

`GemFormattedProgramDryRunIssueInfo`

Constructor

Describes one issue of a formatted process program dry run report.

public GemFormattedProgramDryRunIssueInfo(uint Code, uint Outcome, uint PresenceMask, nuint CommandIndex, nuint FieldIndex, ulong Observed, ulong Expected)

Returned by GemFormattedProgramDryRunReport.GetIssueInfo. GemFormattedProgramDryRunIssueInfo.PresenceMask tells which optional fields hold a value; an absent field is 0.

Parameters

Name	Description
`Code`	The issue code: `1` capability missing, `2` model mismatch, `3` software revision mismatch, `4` command count exceeded, `5` encoded bytes exceeded, `6` unknown ASCII command, `7` required command missing, `8` unsigned command code unmapped, `9` dependency semantics not evaluated, `10` program parameter semantics not evaluated, `11` capability parameter semantics not evaluated.
`Outcome`	The outcome the issue contributes: `1` indeterminate or `2` reject; see `GemFormattedProgramDryRunOutcome`.
`PresenceMask`	Bit flags of the optional fields: `1` `GemFormattedProgramDryRunIssueInfo.CommandIndex`, `2` `GemFormattedProgramDryRunIssueInfo.FieldIndex`, `4` `GemFormattedProgramDryRunIssueInfo.Observed`, `8` `GemFormattedProgramDryRunIssueInfo.Expected`.
`CommandIndex`	The zero-based command index: a command of the program for codes `6`, `8` and `10`, a command of the capability catalog for codes `7`, `9` and `11`.
`FieldIndex`	The zero-based field index; policy version `1` never sets it.
`Observed`	The observed value: the program's command count for code `4`, its encoded size in bytes for code `5`, and the command's parameter count for codes `10` and `11`.
`Expected`	The expected maximum: CMDMAX for code `4` and BYTMAX for code `5`.

`Code`

Property

The issue code: 1 capability missing, 2 model mismatch, 3 software revision mismatch, 4 command count exceeded, 5 encoded bytes exceeded, 6 unknown ASCII command, 7 required command missing, 8 unsigned command code unmapped, 9 dependency semantics not evaluated, 10 program parameter semantics not evaluated, 11 capability parameter semantics not evaluated.

public uint Code { get; init; }

`CommandIndex`

Property

The zero-based command index: a command of the program for codes 6, 8 and 10, a command of the capability catalog for codes 7, 9 and 11.

public nuint CommandIndex { get; init; }

`Expected`

Property

The expected maximum: CMDMAX for code 4 and BYTMAX for code 5.

public ulong Expected { get; init; }

`FieldIndex`

Property

The zero-based field index; policy version 1 never sets it.

public nuint FieldIndex { get; init; }

`Observed`

Property

The observed value: the program's command count for code 4, its encoded size in bytes for code 5, and the command's parameter count for codes 10 and 11.

public ulong Observed { get; init; }

`Outcome`

Property

The outcome the issue contributes: 1 indeterminate or 2 reject; see GemFormattedProgramDryRunOutcome.

public uint Outcome { get; init; }

`PresenceMask`

Property

Bit flags of the optional fields: 1 GemFormattedProgramDryRunIssueInfo.CommandIndex, 2 GemFormattedProgramDryRunIssueInfo.FieldIndex, 4 GemFormattedProgramDryRunIssueInfo.Observed, 8 GemFormattedProgramDryRunIssueInfo.Expected.

public uint PresenceMask { get; init; }