PDComm.GemEnhancedCommandResultInfo
Struct
Describes an enhanced remote command request received by the equipment (S2F49) or an enhanced remote command reply received by the host (S2F50).
public readonly record struct GemEnhancedCommandResultInfoRequest 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 | The number of outer entries of the parameter acknowledgement list: the validation errors found on receipt for a request (0 when accepted), or the received entries for a reply. |
DataId | The data ID (DATAID) of the request, or 0 for a reply. |
IsRequest | true for an equipment-side S2F49 request; false for a host-side S2F50 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, 3 or 6. 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.RespondEnhancedCommand has sent the S2F50 reply. Always false for a reply. |
Members
GemEnhancedCommandResultInfo
Constructor
Describes an enhanced remote command request received by the equipment (S2F49) or an enhanced remote command reply received by the host (S2F50).
public GemEnhancedCommandResultInfo(nuint ParameterCount, nuint IssueCount, uint DataId, 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 | The number of outer entries of the parameter acknowledgement list: the validation errors found on receipt for a request (0 when accepted), or the received entries for a reply. |
DataId | The data ID (DATAID) of the request, or 0 for a reply. |
IsRequest | true for an equipment-side S2F49 request; false for a host-side S2F50 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, 3 or 6. 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.RespondEnhancedCommand has sent the S2F50 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; }DataId
Property
The data ID (DATAID) of the request, or 0 for a reply.
public uint DataId { get; init; }IsRequest
Property
true for an equipment-side S2F49 request; false for a host-side S2F50 reply.
public bool IsRequest { get; init; }IssueCount
Property
The number of outer entries of the parameter acknowledgement list: the validation errors found on receipt for a request (0 when accepted), or the received entries for a reply.
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.RespondEnhancedCommand has sent the S2F50 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, 3 or 6. For a reply, the HCACK received from the equipment.
public byte ValidationAcknowledgement { get; init; }