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 optional Field

PreviousProperties of ref FieldNextProperties of variant Field

Last updated 5 years ago

Was this helpful?

The <optional> 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

field

1

no

Wrapped field.

defaultMode

"tentative", "missing", "exist"

1

no

tentative

Default mode of the field. See also below.

cond

string

1

no

Condition when the field exists.

displayExtModeCtrl

1

no

false

Disable manual update of the mode in GUI analysis tools.

Inner field must be specified using field property or as child XML element.

Extra child XML elements allowed:

XML Element

DSL Version

Description

<field>

1

Wraps member field.

<cond>

1

Condition when field exists.

<and>

1

Logical "and" of conditions.

<or>

1

Logical "or" of conditions.

Default Mode Strings

Mode

Accepted Values (case insensitive)

Tentative

"tentative", "tent", "t"

Missing

"missing", "miss", "m"

Exist

"exist", "exists", "e"

common
<optional> Field
field
bool
Default Mode Strings