Skip to content
Start free evaluation

pdcomm::GemFormattedProgramExecutionInfo

Struct

State of the equipment's formatted program execution, returned by GemFormattedProgramExecutionSnapshot::info().

struct GemFormattedProgramExecutionInfo

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

Members

applicationDetailLength

Field

Length of the application detail bytes.

size_t applicationDetailLength

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

applicationReportId

Field

Report ID passed to completeFormattedProgramExecution(); valid when its presence bit is set.

uint64_t applicationReportId

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

applicationReportKind

Field

Final report submitted by the application: 0 (none), PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_TERMINAL_COMPLETE, ..._TERMINAL_FAIL or ..._TERMINAL_OUTCOME_UNKNOWN.

uint32_t applicationReportKind

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

capabilityPresent

Field

true when the dry run used a capability catalog.

bool capabilityPresent

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

capabilityRevision

Field

Capability catalog revision of the dry run.

uint64_t capabilityRevision

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

commandCount

Field

Commands of the executed program.

size_t commandCount

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

dryRunOutcome

Field

Outcome of the dry run the execution was started with (PDCOMM_GEM_FORMATTED_PROGRAM_DRY_RUN_*).

uint32_t dryRunOutcome

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

endpointId

Field

Endpoint that runs the execution.

uint64_t endpointId

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

entryGeneration

Field

Entry generation of the selection that was executed.

uint64_t entryGeneration

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

executionGeneration

Field

Execution number.

uint64_t executionGeneration

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

idFormat

Field

SECS-II format code of the executed PPID.

uint8_t idFormat

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

nextCommandIndex

Field

Index of the next command a step would request; equals #commandCount when all commands were applied.

size_t nextCommandIndex

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

pendingActionSequence

Field

Sequence number of the pending action; valid when its presence bit is set.

uint64_t pendingActionSequence

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

pendingKind

Field

Kind of the action waiting for a result (..._ACTION_*), or ..._ACTION_NONE.

uint32_t pendingKind

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

policyVersion

Field

Dry-run policy version of that report.

uint32_t policyVersion

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

presenceMask

Field

Which optional data is present: PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_PENDING_ACTION_PRESENT, ..._APPLICATION_REPORT_PRESENT and ..._APPLICATION_DETAIL_PRESENT bits.

uint32_t presenceMask

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

selectionGeneration

Field

Selection revision that was executed.

uint64_t selectionGeneration

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

sessionGeneration

Field

Connection generation of the execution.

uint64_t sessionGeneration

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

state

Field

Execution state: PDCOMM_GEM_FORMATTED_PROGRAM_EXECUTION_EMPTY, ..._START_PENDING, ..._RUNNING, ..._STEP_PENDING, ..._CANCEL_PENDING, ..._APPLICATION_REJECTED, ..._COMPLETED, ..._FAILED, ..._CANCELLED or ..._OUTCOME_UNKNOWN.

uint32_t state

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>

storeRevision

Field

Store revision of the selection that was executed.

uint64_t storeRevision

Declared in: #include <pdcomm_gem_formatted_program_executions.hpp>