pdcomm::GemFormattedProgramSelectionInfo

Struct

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

struct GemFormattedProgramSelectionInfo

Declared in: #include <pdcomm_gem_formatted_program_selections.hpp>

Members

`commandCount`

Field

Commands of the selected program.

size_t commandCount = 0

Declared in: #include <pdcomm_gem_formatted_program_selections.hpp>

`entryGeneration`

Field

Entry generation captured by the selection.

uint64_t entryGeneration = 0

Declared in: #include <pdcomm_gem_formatted_program_selections.hpp>

`idFormat`

Field

SECS-II format code of the selected PPID; 0 when empty.

uint8_t idFormat = 0

Declared in: #include <pdcomm_gem_formatted_program_selections.hpp>

`selectionGeneration`

Field

Selection revision; for an empty selection the current revision.

uint64_t selectionGeneration = 0

Declared in: #include <pdcomm_gem_formatted_program_selections.hpp>

`sessionGeneration`

Field

Connection generation captured by the selection.

uint64_t sessionGeneration = 0

Declared in: #include <pdcomm_gem_formatted_program_selections.hpp>

`staleReason`

Field

Why a selection is stale: PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_NONE, ..._STALE_ENTRY_DELETED, ..._STALE_ENTRY_CHANGED, ..._STALE_SESSION_CHANGED, ..._STALE_DISCONNECTED, ..._STALE_CLEARED or ..._STALE_TOKEN_MISMATCH.

uint32_t staleReason = PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_STALE_NONE

Declared in: #include <pdcomm_gem_formatted_program_selections.hpp>

`state`

Field

PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_EMPTY, ..._READY or ..._STALE.

uint32_t state = PDCOMM_GEM_FORMATTED_PROGRAM_SELECTION_EMPTY

Declared in: #include <pdcomm_gem_formatted_program_selections.hpp>

`storeRevision`

Field

Store revision captured by the selection.

uint64_t storeRevision = 0

Declared in: #include <pdcomm_gem_formatted_program_selections.hpp>

`validForExecution`

Field

true only in the ready state.

bool validForExecution = false

Declared in: #include <pdcomm_gem_formatted_program_selections.hpp>