pdcomm::stepFormattedProgramExecution

Function

Requests the next command of a running execution as a step action.

inline GemFormattedProgramExecutionAction stepFormattedProgramExecution(GemEquipment &endpoint, const GemFormattedProgramExecutionToken &token)

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

The state becomes ..._STEP_PENDING. While a step is pending, calling it again returns the same step action.

Parameters

Name	Description
endpoint	Equipment endpoint that runs the execution.
token	Token of the execution.

Returns

The step action with the command to apply.

Notes

• Throws pdcomm::Error: PDCOMM_INVALID_STATE when the execution is not running or no commands remain; PDCOMM_STALE_TOKEN for a stale token.