CommsDSL Specification
  • Introduction
  • Version
  • Schema Definition
  • Multiple Files
  • Namespaces
  • Platforms
  • References
  • Properties
  • Numeric Values
  • Boolean Values
  • Names
  • Protocol Versioning
  • Schema
  • Fields
    • Common Properties of Fields
    • enum Field
    • int Field
    • set Field
    • bitfield Field
    • bundle Field
    • string Field
    • data Field
    • list Field
    • float Field
    • ref Field
    • optional Field
    • variant Field
    • Referencing Values of Other Fields
  • Messages
  • Interfaces
  • Aliases
  • Frames
    • Common Properties of Layers
    • payload Layer
    • id Layer
    • size Layer
    • sync Layer
    • checksum Layer
    • value Layer
    • custom Layer
  • Protocol Versioning Summary
  • Appendix
    • Properties of schema
    • Common Properties of Fields
    • Properties of enum Field
    • Properties of int Field
    • Properties of set Field
    • Properties of bitfield Field
    • Properties of bundle Field
    • Properties of string Field
    • Properties of data Field
    • Properties of list Field
    • Properties of float Field
    • Properties of ref Field
    • Properties of optional Field
    • Properties of variant Field
    • Units
    • Properties of message
    • Properties of interface
    • Properties of alias
    • Properties of frame
    • Common Properties of Layers
    • Properties of checksum Layer
    • Properties of value Layer
    • Properties of custom Layer
Powered by GitBook
On this page

Was this helpful?

  1. Appendix

Properties of int Field

PreviousProperties of enum FieldNextProperties of set Field

Last updated 5 years ago

Was this helpful?

The <int> field has all the properties as well as ones listed below. Refer to 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 the field.

length

1

no

length of type

Forced serialization length.

bitLength

1

no

length of type in bits

serOffset

1

no

0

Extra value that needs to be added to the field's value when the latter is being serialized.

signExt

1

no

true

Enable / Disable sign extension of the signed value when length property is used to reduce the default serialization length.

scaling

1

no

1/1

Scaling ratio.

units

1

no

Units of the value.

validRange

1

no

Range of valid values.

validValue

1

no

Valid value.

validMin

1

no

Valid minimal value. All the numbers above it are considered to be valid.

validMax

1

no

Valid maximal value. All the numbers below it are considered to be valid.

validCheckVersion

1

no

false

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

displayDecimals

1

no

0

Indicates to GUI analysis tools to display this field as floating point value with specified number of digits after the fraction point.

displayOffset

1

no

0

Indicates to GUI analysis tools to add specified offset value to a field's value when displaying it.

nonUniqueSpecialsAllowed

2

no

false

Allow non unique <special>-s.

displaySpecials

2

no

true

Control displaying <special> values in analysis tools.

Properties of <special> Child Element of <int> Field

Property Name

Allowed type / value

DSL Version

Required

Default Value

Description

name

1

yes

Name of the value.

val

1

yes

Numeric value.

description

string

1

no

Human readable description of the value.

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.

displayName

string

2

no

Name to display in various analysis tools.

or

endian of

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

" / "

"[ , ]"

string

common
<int> Field
numeric
name
schema
unsigned
unsigned
<bitfield>
numeric
bool
numeric
numeric
units
numeric
numeric
numeric
numeric
numeric
bool
numeric
numeric
bool
bool
name
numeric
unsigned
unsigned