PDComm.GemFormattedProgramCapabilityCommand

Class

One command entry of the equipment's process capabilities catalog, sent in S7F22.

public sealed record GemFormattedProgramCapabilityCommand

GemFormattedProgramCapabilityOptions bounds the dependency values per list and in total, and the parameters per command and in total. The dependency values are stored and sent as given; a dry run reports them as indeterminate without evaluating them.

Parameters

Name	Description
Code	The command code (CCODE): ASCII text of at most GemFormattedProgramCapabilityOptions.MaxCommandCodeBytes bytes.
Name	The command name (CNAME): ASCII text of at most 16 bytes.
Required	Whether a program must contain the command (RQCMD); it is sent as a Boolean item.
BlockDefinition	The block definition (BLKDEF): -1, 0 or 1; it is sent as an I1 item.
BeforeDependencies	The before-dependency values (BCDS); they are sent as a U2 array.
ImmediateBeforeDependencies	The immediately-before dependency values (IBCDS); they are sent as a U2 array.
NonBeforeDependencies	The not-before dependency values (NBCDS); they are sent as a U2 array.
AfterDependency	The after-dependency value (ACDS); it is sent as a single U2 value.
ImmediateAfterDependencies	The immediately-after dependency values (IACDS); they are sent as a U2 array.
NonAfterDependencies	The not-after dependency values (NACDS); they are sent as a U2 array.
Parameters	The parameter descriptors in wire order: each one is a list item with 4, 5 or 9 elements.

Members

GemFormattedProgramCapabilityCommand

Constructor

One command entry of the equipment's process capabilities catalog, sent in S7F22.

public GemFormattedProgramCapabilityCommand(string Code, string Name, bool Required, sbyte BlockDefinition, IReadOnlyList<ushort> BeforeDependencies, IReadOnlyList<ushort> ImmediateBeforeDependencies, IReadOnlyList<ushort> NonBeforeDependencies, ushort AfterDependency, IReadOnlyList<ushort> ImmediateAfterDependencies, IReadOnlyList<ushort> NonAfterDependencies, IReadOnlyList<SecsItem> Parameters)

GemFormattedProgramCapabilityOptions bounds the dependency values per list and in total, and the parameters per command and in total. The dependency values are stored and sent as given; a dry run reports them as indeterminate without evaluating them.

Parameters

Name	Description
Code	The command code (CCODE): ASCII text of at most GemFormattedProgramCapabilityOptions.MaxCommandCodeBytes bytes.
Name	The command name (CNAME): ASCII text of at most 16 bytes.
Required	Whether a program must contain the command (RQCMD); it is sent as a Boolean item.
BlockDefinition	The block definition (BLKDEF): -1, 0 or 1; it is sent as an I1 item.
BeforeDependencies	The before-dependency values (BCDS); they are sent as a U2 array.
ImmediateBeforeDependencies	The immediately-before dependency values (IBCDS); they are sent as a U2 array.
NonBeforeDependencies	The not-before dependency values (NBCDS); they are sent as a U2 array.
AfterDependency	The after-dependency value (ACDS); it is sent as a single U2 value.
ImmediateAfterDependencies	The immediately-after dependency values (IACDS); they are sent as a U2 array.
NonAfterDependencies	The not-after dependency values (NACDS); they are sent as a U2 array.
Parameters	The parameter descriptors in wire order: each one is a list item with 4, 5 or 9 elements.

AfterDependency

Property

The after-dependency value (ACDS); it is sent as a single U2 value.

public ushort AfterDependency { get; init; }

BeforeDependencies

Property

The before-dependency values (BCDS); they are sent as a U2 array.

public IReadOnlyList<ushort> BeforeDependencies { get; init; }

BlockDefinition

Property

The block definition (BLKDEF): -1, 0 or 1; it is sent as an I1 item.

public sbyte BlockDefinition { get; init; }

Code

Property

The command code (CCODE): ASCII text of at most GemFormattedProgramCapabilityOptions.MaxCommandCodeBytes bytes.

public string Code { get; init; }

ImmediateAfterDependencies

Property

The immediately-after dependency values (IACDS); they are sent as a U2 array.

public IReadOnlyList<ushort> ImmediateAfterDependencies { get; init; }

ImmediateBeforeDependencies

Property

The immediately-before dependency values (IBCDS); they are sent as a U2 array.

public IReadOnlyList<ushort> ImmediateBeforeDependencies { get; init; }

Name

Property

The command name (CNAME): ASCII text of at most 16 bytes.

public string Name { get; init; }

NonAfterDependencies

Property

The not-after dependency values (NACDS); they are sent as a U2 array.

public IReadOnlyList<ushort> NonAfterDependencies { get; init; }

NonBeforeDependencies

Property

The not-before dependency values (NBCDS); they are sent as a U2 array.

public IReadOnlyList<ushort> NonBeforeDependencies { get; init; }

Parameters

Property

The parameter descriptors in wire order: each one is a list item with 4, 5 or 9 elements.

public IReadOnlyList<SecsItem> Parameters { get; init; }

Required

Property

Whether a program must contain the command (RQCMD); it is sent as a Boolean item.

public bool Required { get; init; }