PDComm.GemFormattedProgramCapabilityOptions

Class

Limits for the S7F21/S7F22 process capabilities exchange and the equipment's capability catalog.

public sealed record GemFormattedProgramCapabilityOptions

Pass the options to GemFormattedPrograms.ConfigureCapabilities, or set GemFormattedProgramConfiguration.Capabilities, once while the endpoint is stopped; a second configuration fails with PdcommStatus.InvalidState. A limit marked as nonzero fails configuration with PdcommStatus.InvalidArgument when it is zero. The other limits are not checked for zero; a zero limit admits only content that needs none of that resource. Values are application policy, not standard defaults. The content limits bound the catalog that GemFormattedPrograms.ReplaceCapabilities stores and the S7F22 data that the host accepts.

Parameters

Name	Description
MaxCommands	The largest number of commands in the capability data.
MaxCommandCodeBytes	The longest command code (CCODE), in bytes.
MaxParametersPerCommand	The largest number of parameter descriptions in one command.
MaxTotalParameters	The largest number of parameter descriptions across all commands.
MaxDependenciesPerField	The largest number of values in one dependency list of a command (BCDS, IBCDS, NBCDS, IACDS or NACDS).
MaxTotalDependencies	The largest number of dependency values across all commands; the single ACDS value of each command counts as one.
MaxTotalParameterBytes	The largest total encoded size, in bytes, of all parameter descriptions.
MaxCapabilityBytes	The largest encoded size, in bytes, of the whole S7F22 capability data.
MaxPending	The largest number of primaries this endpoint sent that still wait for their reply; a further send fails with PdcommStatus.LimitExceeded. Must be nonzero.
MaxReceived	The largest number of received primaries that wait for this endpoint's response; a further primary is reported as an GemResultKind.Unhandled result. Must be nonzero.
MaxResults	The number of completed transactions the endpoint retains; the oldest is discarded when full. Must be nonzero.
MaxHistory	The number of completed transaction identities the endpoint remembers to reject a replayed reply or a repeated response; the oldest is forgotten when full. Must be nonzero.

Members

GemFormattedProgramCapabilityOptions

Constructor

Limits for the S7F21/S7F22 process capabilities exchange and the equipment's capability catalog.

public GemFormattedProgramCapabilityOptions(nuint MaxCommands, nuint MaxCommandCodeBytes, nuint MaxParametersPerCommand, nuint MaxTotalParameters, nuint MaxDependenciesPerField, nuint MaxTotalDependencies, nuint MaxTotalParameterBytes, nuint MaxCapabilityBytes, nuint MaxPending, nuint MaxReceived, nuint MaxResults, nuint MaxHistory)

Pass the options to GemFormattedPrograms.ConfigureCapabilities, or set GemFormattedProgramConfiguration.Capabilities, once while the endpoint is stopped; a second configuration fails with PdcommStatus.InvalidState. A limit marked as nonzero fails configuration with PdcommStatus.InvalidArgument when it is zero. The other limits are not checked for zero; a zero limit admits only content that needs none of that resource. Values are application policy, not standard defaults. The content limits bound the catalog that GemFormattedPrograms.ReplaceCapabilities stores and the S7F22 data that the host accepts.

Parameters

Name	Description
MaxCommands	The largest number of commands in the capability data.
MaxCommandCodeBytes	The longest command code (CCODE), in bytes.
MaxParametersPerCommand	The largest number of parameter descriptions in one command.
MaxTotalParameters	The largest number of parameter descriptions across all commands.
MaxDependenciesPerField	The largest number of values in one dependency list of a command (BCDS, IBCDS, NBCDS, IACDS or NACDS).
MaxTotalDependencies	The largest number of dependency values across all commands; the single ACDS value of each command counts as one.
MaxTotalParameterBytes	The largest total encoded size, in bytes, of all parameter descriptions.
MaxCapabilityBytes	The largest encoded size, in bytes, of the whole S7F22 capability data.
MaxPending	The largest number of primaries this endpoint sent that still wait for their reply; a further send fails with PdcommStatus.LimitExceeded. Must be nonzero.
MaxReceived	The largest number of received primaries that wait for this endpoint's response; a further primary is reported as an GemResultKind.Unhandled result. Must be nonzero.
MaxResults	The number of completed transactions the endpoint retains; the oldest is discarded when full. Must be nonzero.
MaxHistory	The number of completed transaction identities the endpoint remembers to reject a replayed reply or a repeated response; the oldest is forgotten when full. Must be nonzero.

MaxCapabilityBytes

Property

The largest encoded size, in bytes, of the whole S7F22 capability data.

public nuint MaxCapabilityBytes { get; init; }

MaxCommandCodeBytes

Property

The longest command code (CCODE), in bytes.

public nuint MaxCommandCodeBytes { get; init; }

MaxCommands

Property

The largest number of commands in the capability data.

public nuint MaxCommands { get; init; }

MaxDependenciesPerField

Property

The largest number of values in one dependency list of a command (BCDS, IBCDS, NBCDS, IACDS or NACDS).

public nuint MaxDependenciesPerField { get; init; }

MaxHistory

Property

The number of completed transaction identities the endpoint remembers to reject a replayed reply or a repeated response; the oldest is forgotten when full. Must be nonzero.

public nuint MaxHistory { get; init; }

MaxParametersPerCommand

Property

The largest number of parameter descriptions in one command.

public nuint MaxParametersPerCommand { get; init; }

MaxPending

Property

The largest number of primaries this endpoint sent that still wait for their reply; a further send fails with PdcommStatus.LimitExceeded. Must be nonzero.

public nuint MaxPending { get; init; }

MaxReceived

Property

The largest number of received primaries that wait for this endpoint's response; a further primary is reported as an GemResultKind.Unhandled result. Must be nonzero.

public nuint MaxReceived { get; init; }

MaxResults

Property

The number of completed transactions the endpoint retains; the oldest is discarded when full. Must be nonzero.

public nuint MaxResults { get; init; }

MaxTotalDependencies

Property

The largest number of dependency values across all commands; the single ACDS value of each command counts as one.

public nuint MaxTotalDependencies { get; init; }

MaxTotalParameterBytes

Property

The largest total encoded size, in bytes, of all parameter descriptions.

public nuint MaxTotalParameterBytes { get; init; }

MaxTotalParameters

Property

The largest number of parameter descriptions across all commands.

public nuint MaxTotalParameters { get; init; }