XML Files Foreword
This topic describes the conventions used throughout the XML Files Description section.
Child elements of root Element0 element
XML elements |
Attributes |
Content |
Number of occurrences |
Description |
Element1 |
|
Elements |
1 |
xxxxxx |
Element2a/E2a |
Immediate |
EMPTY |
0/1 |
xxxxxx |
Element3a/E3a |
ReadOnly |
PCDATA |
Any |
xxxxxx |
"XML elements" column
The element verbose name and its concise alias appear on the same line, and are separated by a /.
Example: Element2a/E2a means that E2a is the concise alias of Element2a.
When several elements are put together in the same line, that means that these elements are mutually exclusive. At most one of these elements may be present in the XML file.
Example: Element3a/E3a Element3b/E3b means that only one of the 4 elements may be present in the XML file.
"Attributes" column
This column shows the attributes of the element, as they appear in a verbose XML file generated by the driver. The attributes can bet set either to true or false (default).
Immediate elements take effect immediately. Non-Immediate elements are "cached parameters". They can be set at any time, but their effect is postponed until the next activation. Note that a read operation returns the previously written value and an error, if any, is reported at next activation.
Writing a ReadOnly element has no effect.
WriteOnly elements are not present when reading an XML file generated by the driver.
"Content" column
Elements means that the element encloses child elements. The children elements are listed further in another table.
EMPTY means that the element does not enclose any content. The opening and closing tags are merged into one tag.
Example: the EMPTY element Element2a would appear as follows in the XML file generated by the driver: <Element2a/>.
PCDATA means that the element encloses parsed character data.
Example: the PCDATA element Element3a would appear as follows in the XML file generated by the driver: <Element3a>123456ABCD</Element3a>.
"Number of occurrences" column
0/1 means that the number of occurrences of the element is 0 or 1 (optional element).
1 means that the number of occurrences of the element is 1 (mandatory element).
Any means that the number of occurrences is 0 or more.
"Description" column
This column gives further information about the element.