PDComm.GemFormattedProgramConfiguration

Class

The set of formatted process program services to enable on a GEM endpoint; a null option skips its service.

public sealed record GemFormattedProgramConfiguration

Pass the configuration to GemHostWorker.StartWithFormattedProgramsAsync or GemEquipmentWorker.StartWithFormattedProgramsAsync, or call GemFormattedProgramConfiguration.Configure on a stopped endpoint.

Parameters

Name	Description
VerificationReports	The options for the S7F27/S7F28 verification report service, passed to GemFormattedPrograms.ConfigureVerificationReports.
Transfers	The options for the S7F23/S7F24 formatted program send service, passed to GemFormattedPrograms.ConfigureTransfers.
Queries	The options for the S7F25/S7F26 formatted program request service and the equipment's local store, selection and execution tracking, passed to GemFormattedPrograms.ConfigureQueries.
VerificationRequests	The options for the S7F31/S7F32 verification request service, passed to GemFormattedPrograms.ConfigureVerificationRequests.
Capabilities	The options for the S7F21/S7F22 process capabilities service, passed to GemFormattedPrograms.ConfigureCapabilities.
VerificationNegotiation	The options for the S7F29/S7F30 verification negotiation, passed to GemFormattedPrograms.ConfigureVerificationNegotiation.

Members

GemFormattedProgramConfiguration

Constructor

The set of formatted process program services to enable on a GEM endpoint; a null option skips its service.

public GemFormattedProgramConfiguration(GemFormattedProgramOptions? VerificationReports = null, GemFormattedProgramTransferOptions? Transfers = null, GemFormattedProgramQueryOptions? Queries = null, GemFormattedProgramVerificationRequestOptions? VerificationRequests = null, GemFormattedProgramCapabilityOptions? Capabilities = null, GemFormattedProgramVerificationNegotiationOptions? VerificationNegotiation = null)

Pass the configuration to GemHostWorker.StartWithFormattedProgramsAsync or GemEquipmentWorker.StartWithFormattedProgramsAsync, or call GemFormattedProgramConfiguration.Configure on a stopped endpoint.

Parameters

Name	Description
VerificationReports	The options for the S7F27/S7F28 verification report service, passed to GemFormattedPrograms.ConfigureVerificationReports.
Transfers	The options for the S7F23/S7F24 formatted program send service, passed to GemFormattedPrograms.ConfigureTransfers.
Queries	The options for the S7F25/S7F26 formatted program request service and the equipment's local store, selection and execution tracking, passed to GemFormattedPrograms.ConfigureQueries.
VerificationRequests	The options for the S7F31/S7F32 verification request service, passed to GemFormattedPrograms.ConfigureVerificationRequests.
Capabilities	The options for the S7F21/S7F22 process capabilities service, passed to GemFormattedPrograms.ConfigureCapabilities.
VerificationNegotiation	The options for the S7F29/S7F30 verification negotiation, passed to GemFormattedPrograms.ConfigureVerificationNegotiation.

Configure

Method

Configures every service whose options are set on a stopped endpoint.

public void Configure(GemEndpoint endpoint)

The services are configured in the order verification reports, transfers, queries, verification requests, capabilities and verification negotiation. The call is not atomic: when one service fails, the services configured before it stay configured.

Parameters

Name	Description
endpoint	The stopped host or equipment endpoint to configure.

Notes

• Throws NotSupportedException: The loaded native library does not export the formatted process program functions.
• Throws ObjectDisposedException: endpoint was disposed.
• Throws PdcommException: A configuration call failed, for example because the endpoint is not stopped or a service is already configured.

Capabilities

Property

The options for the S7F21/S7F22 process capabilities service, passed to GemFormattedPrograms.ConfigureCapabilities.

public GemFormattedProgramCapabilityOptions? Capabilities { get; init; }

Queries

Property

The options for the S7F25/S7F26 formatted program request service and the equipment's local store, selection and execution tracking, passed to GemFormattedPrograms.ConfigureQueries.

public GemFormattedProgramQueryOptions? Queries { get; init; }

Transfers

Property

The options for the S7F23/S7F24 formatted program send service, passed to GemFormattedPrograms.ConfigureTransfers.

public GemFormattedProgramTransferOptions? Transfers { get; init; }

VerificationNegotiation

Property

The options for the S7F29/S7F30 verification negotiation, passed to GemFormattedPrograms.ConfigureVerificationNegotiation.

public GemFormattedProgramVerificationNegotiationOptions? VerificationNegotiation { get; init; }

VerificationReports

Property

The options for the S7F27/S7F28 verification report service, passed to GemFormattedPrograms.ConfigureVerificationReports.

public GemFormattedProgramOptions? VerificationReports { get; init; }

VerificationRequests

Property

The options for the S7F31/S7F32 verification request service, passed to GemFormattedPrograms.ConfigureVerificationRequests.

public GemFormattedProgramVerificationRequestOptions? VerificationRequests { get; init; }