PDComm.GemResultInfo

Struct

Represents the summary of a GemResult.

public readonly record struct GemResultInfo

Parameters

Name	Description
`Kind`	How the transport event was processed.
`Outcome`	What GEM processing concluded.
`RequestKind`	The GEM transaction the result belongs to; zero when the result is not tied to a known transaction.
`Code`	The failure detail: an `HsmsFailureReason` value or `GemError.Aborted` for `GemResultKind.Failed`, a `GemError` value for `GemResultKind.InvalidResponse` and `GemResultKind.Unhandled`, and zero otherwise.
`Acknowledgement`	The SEMI acknowledgement code carried or sent with the message (for example COMMACK, ONLACK or ACKC5), or `null` when the outcome has none.
`ReplySent`	`true` when GEM processing sent a reply to the received primary.
`Token`	The HSMS token of the request or of the received primary.
`EntryCount`	The number of entries in the result, such as status values or names, report query reports or values, alarms, command parameters or program IDs; zero when the result has no entries.
`State`	The GEM state of the endpoint after the event was processed.

Members

`GemResultInfo`

Constructor

Represents the summary of a GemResult.

public GemResultInfo(GemResultKind Kind, GemOutcome Outcome, GemRequestKind RequestKind, uint Code, byte? Acknowledgement, bool ReplySent, HsmsToken Token, nuint EntryCount, GemState State)

Parameters

Name	Description
`Kind`	How the transport event was processed.
`Outcome`	What GEM processing concluded.
`RequestKind`	The GEM transaction the result belongs to; zero when the result is not tied to a known transaction.
`Code`	The failure detail: an `HsmsFailureReason` value or `GemError.Aborted` for `GemResultKind.Failed`, a `GemError` value for `GemResultKind.InvalidResponse` and `GemResultKind.Unhandled`, and zero otherwise.
`Acknowledgement`	The SEMI acknowledgement code carried or sent with the message (for example COMMACK, ONLACK or ACKC5), or `null` when the outcome has none.
`ReplySent`	`true` when GEM processing sent a reply to the received primary.
`Token`	The HSMS token of the request or of the received primary.
`EntryCount`	The number of entries in the result, such as status values or names, report query reports or values, alarms, command parameters or program IDs; zero when the result has no entries.
`State`	The GEM state of the endpoint after the event was processed.

`Acknowledgement`

Property

The SEMI acknowledgement code carried or sent with the message (for example COMMACK, ONLACK or ACKC5), or null when the outcome has none.

public byte? Acknowledgement { get; init; }

`Code`

Property

The failure detail: an HsmsFailureReason value or GemError.Aborted for GemResultKind.Failed, a GemError value for GemResultKind.InvalidResponse and GemResultKind.Unhandled, and zero otherwise.

public uint Code { get; init; }

`EntryCount`

Property

The number of entries in the result, such as status values or names, report query reports or values, alarms, command parameters or program IDs; zero when the result has no entries.

public nuint EntryCount { get; init; }

`Kind`

Property

How the transport event was processed.

public GemResultKind Kind { get; init; }

`Outcome`

Property

What GEM processing concluded.

public GemOutcome Outcome { get; init; }

`ReplySent`

Property

true when GEM processing sent a reply to the received primary.

public bool ReplySent { get; init; }

`RequestKind`

Property

The GEM transaction the result belongs to; zero when the result is not tied to a known transaction.

public GemRequestKind RequestKind { get; init; }

`State`

Property

The GEM state of the endpoint after the event was processed.

public GemState State { get; init; }

`Token`

Property

The HSMS token of the request or of the received primary.

public HsmsToken Token { get; init; }