TGML Status Conversion: <ConvertStatus>
ConvertStatus specifies how the status of a server variable (signal) value is to be converted to a TGML element attribute value. A ConvertStatus element belongs to the immediate parent Bind element.
ConvertStatus is executed when the status of the value is different from “normal”, which means when the status value is 0, 1 or 3. For more information, see the TGML Appendix A: User-Defined Descriptions of Custom Attributes section.
ConvertStatus can be combined with other converters (for example, ConvertValue and ConvertRange) but the converters are executed in the same order as they are specified. The ConvertStatus should be placed last if it is combined with other converters.
Attribute | Type | Description |
---|---|---|
Error |
String (untyped) |
The attribute value that is to be set when the status is 0 (Error). The type is determined by the bound Attribute (referenced by the Bind element). |
Stored |
String (untyped) |
The attribute value that is to be set when the status is 1 (Stored value). The type is determined by the bound Attribute (referenced by the Bind element). |
Forced |
String (untyped) |
The attribute value that is to be set when the status is 3 (Forced value). The type is determined by the bound Attribute (referenced by the Bind element). |