IL:trainNumberField

Documentation

Syntax

Autoexport from the XML-Schema for element IL:trainNumberField of railML® version 3.2 UML-visualization of IL
Documentation	virtual logical object used for indication of train numbers/IDs on HMI
Subschema	interlocking
Parents*	trainNumberFields
Children	designator (0..*), hasCommand (0..*), hasIndication (0..*), primaryInStack (0..1)
Attributes: numberInStack: the number of this train number field in the stack starting with 1 for primary field (optional; xs:positiveInteger), orientation: the orientation the pile is stacked horizontally/vertically (optional; xs:string) Possible values: horizontal vertical, deleteOnLeave: Flag, whether the content of the train number field is deleted when the track element becomes empty (optional; xs:boolean), isAtBorder: Flag, whether this train number field is at a border, i.e. no next neighbouring train number field. This is only useful for the primary field as all others shall follow the primary one. (optional; xs:boolean), usedForDirection: Direction dependent use of the train number field. The direction is in relation to the underlaying netElement. (optional; xs:string) Possible values: both reverse normal, elementNumber: number of the element in the set of interlocking data (optional; xs:nonNegativeInteger), id: unique identifier (obligatory; xs:string; patterns: (urn:uuid:)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|\{[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\})
*Notice: Elements may have different parent elements. As a consequence they may be used in different contexts. Please, consider this as well as a user of this wiki as when developing this documentation further. Aspects that are only relevant with respect to one of several parents should be explained exclusively in the documentation of the respective parent element.

This element does not appear in railML^® 3.1. It is available only in railML^® 3.2. Do not hesitate to contact railML.org for further questions.

Changes 3.1→3.2

Introduced with version 3.2

Best Practice / Examples

For the management of train traffic each train gets a number as kind of ID. This number is presented on the HMI of any controller to the operator for dispatching purpose. Thus the HMI has special graphic objects which can be filled with the related train number. This kind of object is called trainNumberField. Typically such fields are connected to tvdSection where the occupation status controls the movement of the train number through the network. In case there shall be more than one number shown at the time several fields can be grouped at one location as a stack.

• @elementNumber - A positive integer number unique within one <signalBox> to index the element in internal lists of engineering data.
• @id - The unique identifier used to reference this element within railML.
• @numberInStack - The order number of this field within the stack starting with 1.
• @orientation - The orientation of the graphical represantation of the field stack - horizontal or vertical.
• @deleteOnLeave - The flag, whether this field is deleted when the train (occupation) leaves the related section.
• @isAtBorder - The flag, whether the field and the entire stack is located at a border, i.e. there is at one side no neighbouring section visible.
• @usedForDirection - The direction for which the field is used. This can be either both, reverse or normal. The direction value is related to the orientation of the underlaying netElement.

• <hasCommand> - The reference to any predefined operator command, which can be used with this element. For details refer to <hasOperatorCommand>.
• <hasIndication> - The reference to any predefined indication on HMI, which is used with this element. For details refer to <hasHmiIndication>.
• <primaryInStack> - The reference to the primary field in this stack.

<rail3:trainNumberField deleteOnLeave="true" elementNumber="0" id="" isAtBorder="true" numberInStack="1" orientation="horizontal" usedForDirection="both">
	<rail3:designator description="" entry="" register=""/>
	<rail3:hasCommand entityCode="" ref=""/>
	<rail3:hasIndication entityCode="" ref=""/>
	<rail3:primaryInStack ref=""/>
</rail3:trainNumberField>