pdcomm::GemCommandParameterDefinition

Struct

One parameter (CPNAME) accepted by a remote command definition.

struct GemCommandParameterDefinition

Declared in: #include <pdcomm_gem.hpp>

All SecsItem pointers are borrowed only during the configure call.

Members

format

Field

Required SECS-II format code (PDCOMM_SECS_*). Numeric bounds need an integer format.

uint8_t format

Declared in: #include <pdcomm_gem.hpp>

formatPresent

Field

true when #format restricts the value format.

bool formatPresent

Declared in: #include <pdcomm_gem.hpp>

maxCount

Field

Maximum element count of the value.

size_t maxCount

Declared in: #include <pdcomm_gem.hpp>

maximum

Field

Highest accepted numeric value; used when #maximumPresent is true.

GemInt128 maximum

Declared in: #include <pdcomm_gem.hpp>

maximumPresent

Field

true when #maximum applies.

bool maximumPresent

Declared in: #include <pdcomm_gem.hpp>

minCount

Field

Minimum element count of the value.

size_t minCount

Declared in: #include <pdcomm_gem.hpp>

minimum

Field

Lowest accepted numeric value; used when #minimumPresent is true.

GemInt128 minimum

Declared in: #include <pdcomm_gem.hpp>

minimumPresent

Field

true when #minimum applies.

bool minimumPresent

Declared in: #include <pdcomm_gem.hpp>

name

Field

Parameter name: an ASCII item or an integer scalar item (any I or U format).

const SecsItem *name

Declared in: #include <pdcomm_gem.hpp>

required

Field

true when the host must send this parameter.

bool required

Declared in: #include <pdcomm_gem.hpp>