PDComm.GemCommandResultInfo

Struct

Describes a remote command request received by the equipment (S2F41) or a remote command reply received by the host (S2F42).

public readonly record struct GemCommandResultInfo

Request information always describes the validation on receipt, even after the reply is sent.

Parameters

Name	Description
`ParameterCount`	The number of parameters in the received request, or 0 for a reply.
`IssueCount`	For a request, the number of parameter issues found by validation on receipt; for a reply, the number of received parameter acknowledgements (CPACK entries).
`IsRequest`	`true` for an equipment-side S2F41 request; `false` for a host-side S2F42 reply.
`ValidationAccepted`	Whether the built-in validation accepted the request on receipt. Always `false` for a reply.
`ValidationAcknowledgement`	For a request, the HCACK chosen by validation on receipt: 0 when accepted, otherwise 1, 2 or 3. For a reply, the HCACK received from the equipment.
`CompletionEvent`	The completion collection event ID (CEID) of an accepted request, or `null`.
`Responded`	Whether `GemEquipment.RespondCommand` has sent the S2F42 reply. Always `false` for a reply.

Members

`GemCommandResultInfo`

Constructor

Describes a remote command request received by the equipment (S2F41) or a remote command reply received by the host (S2F42).

public GemCommandResultInfo(nuint ParameterCount, nuint IssueCount, bool IsRequest, bool ValidationAccepted, byte ValidationAcknowledgement, uint? CompletionEvent, bool Responded)

Request information always describes the validation on receipt, even after the reply is sent.

Parameters

Name	Description
`ParameterCount`	The number of parameters in the received request, or 0 for a reply.
`IssueCount`	For a request, the number of parameter issues found by validation on receipt; for a reply, the number of received parameter acknowledgements (CPACK entries).
`IsRequest`	`true` for an equipment-side S2F41 request; `false` for a host-side S2F42 reply.
`ValidationAccepted`	Whether the built-in validation accepted the request on receipt. Always `false` for a reply.
`ValidationAcknowledgement`	For a request, the HCACK chosen by validation on receipt: 0 when accepted, otherwise 1, 2 or 3. For a reply, the HCACK received from the equipment.
`CompletionEvent`	The completion collection event ID (CEID) of an accepted request, or `null`.
`Responded`	Whether `GemEquipment.RespondCommand` has sent the S2F42 reply. Always `false` for a reply.

`CompletionEvent`

Property

The completion collection event ID (CEID) of an accepted request, or null.

public uint? CompletionEvent { get; init; }

`IsRequest`

Property

true for an equipment-side S2F41 request; false for a host-side S2F42 reply.

public bool IsRequest { get; init; }

`IssueCount`

Property

For a request, the number of parameter issues found by validation on receipt; for a reply, the number of received parameter acknowledgements (CPACK entries).

public nuint IssueCount { get; init; }

`ParameterCount`

Property

The number of parameters in the received request, or 0 for a reply.

public nuint ParameterCount { get; init; }

`Responded`

Property

Whether GemEquipment.RespondCommand has sent the S2F42 reply. Always false for a reply.

public bool Responded { get; init; }

`ValidationAccepted`

Property

Whether the built-in validation accepted the request on receipt. Always false for a reply.

public bool ValidationAccepted { get; init; }

`ValidationAcknowledgement`

Property

For a request, the HCACK chosen by validation on receipt: 0 when accepted, otherwise 1, 2 or 3. For a reply, the HCACK received from the equipment.

public byte ValidationAcknowledgement { get; init; }