You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Similar to <<messages-messages, <message> >>-es
157
-
<<interfaces-interfaces, <interface> >> can also use **copyFieldsFrom**
158
-
<<intro-properties, property>> to copy its field from some other
159
-
<<interfaces-interfaces, <interface> >> or <<fields-bundle, <bundle> >> definition and have all
160
-
the aliases copied by default. The control of such default copying behavior
161
-
is also done by using **copyFieldsAliases**
157
+
[[aliases-copy]]
158
+
=== Copying Fields ===
159
+
When a new <<messages-messages, <message> >> or <<interfaces-interfaces, <interface> >> is defined, it can
160
+
copy all the fields from other already defined <<messages-messages, <message> >>, <<interfaces-interfaces, <interface> >>, or <<fields-bundle, <bundle> >>
Copy file name to clipboardExpand all lines: appendix/bitfield.adoc
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,9 @@ for detailed description.
9
9
|===
10
10
|Property Name|Allowed Type / Value|DSL Version|Required|Default Value ^.^|Description
11
11
12
-
|**endian**|"big" or "little"|1|no|endian of <<schema-schema, schema>>|Endian of the field.|
12
+
|**copyValidCondFrom**|<<intro-references, reference>> string|7|no||<<fields-bitfield, <bitfield> >> field definition from which extra validity condition needs to be copied.
13
+
|**endian**|"big" or "little"|1|no|endian of <<schema-schema, schema>>|Endian of the field.
Copy file name to clipboardExpand all lines: appendix/bundle.adoc
+4-1Lines changed: 4 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,9 @@ for detailed description.
9
9
|===
10
10
|Property Name|Allowed Type / Value|DSL Version|Required|Default Value ^.^|Description
11
11
12
-
|**reuseAliases**|<<intro-boolean, bool>>|3|no|true|Control copy of the defined <<aliases-aliases, aliases>> from reused other <<fields-bundle, <bundle> >> when **reuse** property is used.
12
+
|**copyValidCondFrom**|<<intro-references, reference>> string|7|no||<<fields-bundle, <bundle> >> field definition from which extra validity condition needs to be copied.
13
+
|**reuseAliases**|<<intro-boolean, bool>>|3|no|true|Control copy of the defined <<aliases-aliases, aliases>> from reused other <<fields-bundle, <bundle> >> when **reuse** property is used.
|**length**|<<intro-numeric, unsigned>>|1|no|0|Fixed serialization length. **0** means no length limit. Cannot be used tegether with **lengthPrefix**.
14
15
|**lengthPrefix**|<<fields-fields, field>> or <<intro-references, reference>>|1|no||Prefix field containing length of the data. Cannot be used tegether with **length**.
Copy file name to clipboardExpand all lines: appendix/fields.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,10 +14,9 @@ Refer to <<fields-common, Common Properties of Fields>> chapter for detailed des
14
14
Must be greater than value of **sinceVersion**. +
15
15
Applipable only to members of the <<messages-messages, <message> >> or <<fields-bundle, <bundle> >>.
16
16
|**description**|string|1|no||Human readable description of the field.
17
-
|**displayHidden**|<<intro-boolean, bool>>|1|no|false|Don't display field at all in visual analysis tool(s).
18
17
|**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).
19
-
|**displayReadOnly**|<<intro-boolean, bool>>|1|no|false|Disable modification of the field in visual analysis tool(s).
20
18
|**failOnInvalid**|<<intro-boolean, bool>>|1|no|false|Fail *read* operation if read value is invalid.
19
+
|**fixedValue**|<<intro-boolean, bool>>|7|no|false|Remove an ability to update field's value after the object construction.
21
20
|**forceGen**|<<intro-boolean, bool>>|3|no|false|Force generation of field's code regardless of it's being referenced or not.
22
21
|**lengthOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **length** retrieval.
23
22
|**name**|<<intro-names, name>> string|1|yes||Name of the field.
@@ -32,6 +31,7 @@ Applicable only to members of the <<messages-messages, <message> >> or <<f
32
31
|**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.
33
32
|**sinceVersion**|<<intro-numeric, unsigned>>|1|no|0|Version of the protocol in which field was introduced. +
34
33
Applicable only to members of the <<messages-messages, <message> >> or <<fields-bundle, <bundle> >>.
34
+
|**validateMinLength**|<<intro-numeric, numeric>>|7|no||Specify expected minimal serialization length of the field.
35
35
|**validOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **valid** retrieval.
36
36
|**valueOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **value** operation.
37
37
|**writeOverride**|"any", "replace", "extend", "none"|4|no|any|Control the overriding code for **write** operation.
Copy file name to clipboardExpand all lines: appendix/int.adoc
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,8 @@ for detailed description.
13
13
|**bitLength**|<<intro-numeric, unsigned>>|1|no|length of **type** in bits|Serialization length in bits, applicable only to a member of <<fields-bitfield, <bitfield> >>.
14
14
|**defaultValidValue**|<<intro-numeric, numeric>> or <<intro-names, name>>|4|no||Convenience bunding of the **defaultValue** and **validValue** into a single property.
15
15
|**defaultValue**|<<intro-numeric, numeric>> or <<intro-names, name>>|1|no|0|Default value. Must fit the underlying **type**.
16
-
|**displayDecimals**|<<intro-numeric, numeric>>|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.
17
-
|**displayOffset**|<<intro-numeric, numeric>>|1|no|0|Indicates to GUI analysis tools to add specified offset value to a field's value when displaying it.
18
-
|**displaySpecials**|<<intro-boolean, bool>>|2|no|true|Control displaying **<special>** values in analysis tools.
16
+
|**displayDecimals**|<<intro-numeric, numeric>>|1|no|0|Use specified number of digits after the fraction point when displaying the field's value as floating point.
17
+
|**displayOffset**|<<intro-numeric, numeric>>|1|no|0|Add specified offset value to a field's value when displaying it.
19
18
|**endian**|"big" or "little"|1|no|endian of <<schema-schema, schema>>|Endian of the field.
20
19
|**length**|<<intro-numeric, unsigned>>|1|no|length of **type**|Forced serialization length.
21
20
|**nonUniqueSpecialsAllowed**|<<intro-boolean, bool>>|2|no|false|Allow non unique **<special>**-s.
@@ -39,7 +38,7 @@ for detailed description.
39
38
|**deprecated**|<<intro-numeric, unsigned>>|1|no|max unsigned|Version of the protocol in which value was deprecated. +
40
39
Must be greater than value of **sinceVersion**.
41
40
|**description**|string|1|no||Human readable description of the value.
42
-
|**displayName**|string|2|no||Name to display in various analysis tools.
41
+
|**displayName**|string|2|no||Human readable name of the value.
43
42
|**name**|<<intro-names, name>> string|1|yes||Name of the value.
44
43
|**sinceVersion**|<<intro-numeric, unsigned>>|1|no|0|Version of the protocol in which value was introduced.
Copy file name to clipboardExpand all lines: appendix/interface.adoc
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,9 @@ for detailed description.
12
12
|**copyFieldsFrom**|<<intro-references, reference>> string|1|no||Interface or bundle field definition from which fields need to be copied.
13
13
|**description**|string|1|no||Human readable description of the interface.
14
14
|**name**|<<intro-names, name>> string|1|yes||Name of the interface.
15
+
|**reuse**|<<intro-references, reference>> string|7|no||Interface definition of which to copy.
16
+
|**reuseAliases**|<<intro-boolean, bool>>|7|no|true|Control copy of the defined <<aliases-aliases, aliases>> from reused other <<interfaces-interfaces, <interface> >> when **reuse** property is used.
17
+
|**reuseCode**|<<intro-boolean, bool>>|7|no|false|In case of **reuse** apply **copyCodeFrom** with the same <<intro-references, reference>> string.
15
18
|===
16
19
17
20
@@ -20,7 +23,5 @@ Extra child XML elements allowed:
20
23
[cols="^.^28,^.^10,62", options="header"]
21
24
|===
22
25
|XML Element|DSL Version ^.^|Description
23
-
24
-
|**copyFieldsAliases**|<<intro-boolean, bool>>|3|no|true|Control copy of the defined <<aliases-aliases, aliases>> when **copyFieldsFrom** property is used to copy fields from the other <<interfaces-interfaces, <interface> >> or <<fields-bundle, <bundle> >>.
0 commit comments