IL:trainNumberField

From railML 3 Wiki
Revision as of 16:16, 5 March 2021 by RailML Coord Documentation (talk | contribs) (Created page IL:trainNumberField using XSD2MediaWiki Converter 1.0.6)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Introduction

Documentation

Syntax

Autoexport from the XML-Schema for element IL:trainNumberField of railML® version 3.2
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:
  • 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),

  • 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: the stack of train number fields is orientated on HMI in horizontal manner
  • vertical: the stack of train number fields is orientated on HMI in vertical manner,

  • 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}}); compare: Dev:Identities
*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 within the IL subschema. 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.

Semantics

Best Practice / Examples

Additional Information

Notes

Open Issues