PDComm.GemCommandDefinition
Class
Defines one remote command that the equipment validates on receipt.
public sealed record GemCommandDefinitionParameters
| Name | Description |
|---|---|
Name | The remote command name (RCMD): a nonempty ASCII item, or a scalar integer item from -128 through 255. Names must be unique. The item is read only during configuration. |
Parameters | The parameter definitions. Parameter names must be unique within the command. |
RequireOnlineRemote | Whether the command is accepted only in the online remote control state. Otherwise validation rejects it with HCACK 2 (cannot perform now). |
CompletionEvent | The optional collection event ID (CEID) returned in GemCommandReply.CompletionEvent when the reply carries HCACK 0 or 4. It must be one of the event IDs configured with GemEquipment.ConfigureReports. |
Members
GemCommandDefinition
Constructor
Defines one remote command that the equipment validates on receipt.
public GemCommandDefinition(SecsItem Name, ReadOnlyMemory<GemCommandParameterDefinition> Parameters, bool RequireOnlineRemote, uint? CompletionEvent = null)Parameters
| Name | Description |
|---|---|
Name | The remote command name (RCMD): a nonempty ASCII item, or a scalar integer item from -128 through 255. Names must be unique. The item is read only during configuration. |
Parameters | The parameter definitions. Parameter names must be unique within the command. |
RequireOnlineRemote | Whether the command is accepted only in the online remote control state. Otherwise validation rejects it with HCACK 2 (cannot perform now). |
CompletionEvent | The optional collection event ID (CEID) returned in GemCommandReply.CompletionEvent when the reply carries HCACK 0 or 4. It must be one of the event IDs configured with GemEquipment.ConfigureReports. |
CompletionEvent
Property
The optional collection event ID (CEID) returned in GemCommandReply.CompletionEvent when the reply carries HCACK 0 or 4. It must be one of the event IDs configured with GemEquipment.ConfigureReports.
public uint? CompletionEvent { get; init; }Name
Property
The remote command name (RCMD): a nonempty ASCII item, or a scalar integer item from -128 through 255. Names must be unique. The item is read only during configuration.
public SecsItem Name { get; init; }Parameters
Property
The parameter definitions. Parameter names must be unique within the command.
public ReadOnlyMemory<GemCommandParameterDefinition> Parameters { get; init; }RequireOnlineRemote
Property
Whether the command is accepted only in the online remote control state. Otherwise validation rejects it with HCACK 2 (cannot perform now).
public bool RequireOnlineRemote { get; init; }