Skip to content
Start free evaluation

pdcomm::dryRunFormattedProgram

Function

Analyses the selected formatted program against the equipment's capability catalog.

inline GemFormattedProgramDryRunReport dryRunFormattedProgram(GemEquipment &endpoint, const GemFormattedProgramSelectionToken &token, const PdcommGemFormattedProgramDryRunOptions &options)

Declared in: #include <pdcomm_gem_formatted_program_dry_runs.hpp>

The selection must still be ready (see validateFormattedProgramSelection()). Without a capability catalog the report contains a capability-missing finding and an indeterminate outcome.

Parameters

NameDescription
endpointEquipment endpoint with formatted program requests configured.
tokenToken returned by selectFormattedProgram().
optionsOptions built with gemFormattedProgramDryRunOptions().

Returns

An owned report.

Notes

  • Throws pdcomm::Error: PDCOMM_STALE_TOKEN when the selection is cleared, different or stale; PDCOMM_INVALID_STATE on a host or without a store; PDCOMM_INVALID_ARGUMENT for invalid options or an unsupported policy; PDCOMM_LIMIT_EXCEEDED when maxIssues or maxProgramEncodedBytes is exceeded.