Common Properties of Fields
Last updated
Was this helpful?
Last updated
Was this helpful?
Refer to chapter for detailed description.
Property Name
Allowed type / value
DSL Version
Required
Default Value
Description
name
string
1
yes
Name of the field.
description
string
1
no
Human readable description of the field.
reuse
string
1
no
Field definition of which to copy.
displayName
string
1
no
Name of the field to display. If empty, the code generator must use value of property name instead. In order to force empty name to display, use "_" (underscore).
displayReadOnly
1
no
false
Disable modification of the field in visual analysis tool(s).
displayHidden
1
no
false
Don't display field at all in visual analysis tool(s).
sinceVersion
1
no
0
Version of the protocol in which field was introduced. Applicable only to members of the or .
deprecated
1
no
max unsigned
Version of the protocol in which field was deprecated. Must be greater than value of sinceVersion. Applipable only to members of the or .
removed
1
no
false
Indicates whether deprecated field has been removed from being serialized. Applicable only to members of the or .
failOnInvalid
1
no
false
Fail read operation if read value is invalid.
pseudo
1
no
false
In case of true, don't serialize/deserialize this field.
customizable
1
no
false
Mark the field to allow compile time customization regardless of code generator's level of customization.
semanticType
"none", "messageId", "version", "length"
1
no
none
Specify semantic type of the field. It allows code generator to generate special code for special cases. Value "length" was introduced in v2 of this specification.