Properties of enum Field

The <enum> field has all the common properties as well as ones listed below. Refer to <enum> Field chapter for detailed description.

Property Name

Allowed type / value

DSL Version

Required

Default Value

Description

type

"int8", "uint8", "int16", "uint16", "int32", "uint32", "int64", "uint64", "intvar", "uintvar"

1

yes

Underlying primitive type.

defaultValue

1

no

0

Default value. Must fit the underlying type.

endian

"big" or "little"

1

no

endian of schema

Endian of the field.

length

1

no

length of type

Forced serialization length.

bitLength

1

no

length of type in bits

Serialization length in bits, applicable only to a member of <bitfield>.

hexAssign

1

no

false

Assign generated enum values using hexadecimal numbers.

nonUniqueAllowed

1

no

false

Allow non unique <validValue>-es.

validCheckVersion

1

no

false

Take into account protocol version when generating code for field's value validity check.

Properties of <validValue> Child Element of <enum> Field

Property Name

Allowed type / value

DSL Version

Required

Default Value

Description

name

name string

1

yes

Name of the value.

val

1

yes

Numeric value.

description

string

1

no

Human readable description of the value.

displayName

string

1

no

Human readable name of the value to display in various analysis tools.

sinceVersion

1

no

0

Version of the protocol in which value was introduced.

deprecated

1

no

max unsigned

Version of the protocol in which value was deprecated. Must be greater than value of sinceVersion.

Last updated

Was this helpful?