PdcommGemEquipmentOptions

Struct

Options for pdcomm_gem_configure_equipment().

typedef struct PdcommGemEquipmentOptions { ... } PdcommGemEquipmentOptions

Declared in: #include <pdcomm_gem.h>

Members

initial_control

Field

Initial control state.

uint32_t initial_control

Declared in: #include <pdcomm_gem.h>

One of #PDCOMM_GEM_EQUIPMENT_OFFLINE, #PDCOMM_GEM_HOST_OFFLINE, #PDCOMM_GEM_ONLINE_LOCAL, or #PDCOMM_GEM_ONLINE_REMOTE. #PDCOMM_GEM_ATTEMPT_ONLINE is rejected.

item_limits

Field

SECS-II limits for every message the equipment builds or parses.

PdcommSecsLimits item_limits

Declared in: #include <pdcomm_gem.h>

All four limits must be nonzero, and the S1F14 identity reply built from model and software_revision must fit within them.

max_metadata_bytes

Field

Largest total size in bytes of all registered status variable names and units; may be 0.

size_t max_metadata_bytes

Declared in: #include <pdcomm_gem.h>

max_value_bytes

Field

Largest total encoded size in bytes of all registered status variable values; must be nonzero.

size_t max_value_bytes

Declared in: #include <pdcomm_gem.h>

max_variables

Field

Largest number of registered status variables; must be nonzero.

size_t max_variables

Declared in: #include <pdcomm_gem.h>

Storage for this many entries is reserved during configuration.

model

Field

Equipment model type (MDLN) as ASCII bytes, without a terminator; may be NULL when model_length is 0.

const char *model

Declared in: #include <pdcomm_gem.h>

model_length

Field

Number of bytes at model.

size_t model_length

Declared in: #include <pdcomm_gem.h>

online_mode

Field

Online mode, #PDCOMM_GEM_LOCAL or #PDCOMM_GEM_REMOTE: the ON-LINE substate entered when going on-line.

uint32_t online_mode

Declared in: #include <pdcomm_gem.h>

reserved

Field

Reserved; must be 0.

uint32_t reserved

Declared in: #include <pdcomm_gem.h>

software_revision

Field

Software revision (SOFTREV) as ASCII bytes, without a terminator; may be NULL when software_revision_length is 0.

const char *software_revision

Declared in: #include <pdcomm_gem.h>

software_revision_length

Field

Number of bytes at software_revision.

size_t software_revision_length

Declared in: #include <pdcomm_gem.h>

struct_size

Field

Size of this structure in bytes; set to sizeof(PdcommGemEquipmentOptions) or larger.

size_t struct_size

Declared in: #include <pdcomm_gem.h>

version

Field

Options version; must be #PDCOMM_GEM_OPTIONS_VERSION.

uint32_t version

Declared in: #include <pdcomm_gem.h>