IL:combinedRoute

From railML 3 Wiki

Introduction

Documentation

Syntax

Autoexport from the XML-Schema for element IL:combinedRoute of railML® version 3.2
Documentation a concatenation of single routes providing a continuous path for traffic movement
Subschema interlocking
Parents* combinedRoutes
Children belongsToOperationalPoint (0..*), comboEntry (1..1), comboExit (1..1), containsRoute (1..*), designator (0..*), hasCommand (0..*), hasIndication (0..*), objectName (0..*)
Attributes:
  • priorityRank: Gives the priority of the path in case there are several possible paths between entry and exit. The highest priority is 0. (optional; xs:nonNegativeInteger),

  • elementNumber: element number of the object for internal referencing in the engineering 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.

Autoexport from the XML-Schema for element IL:combinedRoute of railML® version 3.1
Documentation a concatenation of single routes providing a continuous path for traffic movement
Subschema interlocking
Parents* combinedRoutes
Children any (0..*), comboEntry (1..1), comboExit (1..1), containsRoute (1..*), designator (0..1)
Attributes:
  • id: unique identifier (optional; xs:ID; 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.


Changes 3.1→3.2

The children have changed.

The attributes have been changed.

Semantics

Best Practice / Examples

In order to reduce operational effort it is possible to define route combinations that are established by one operator command. The routes of one combination have to be all of the same type and direction. The list of single routes in the combination shall form a continuous path from the <comboEntry> to the <comboExit>.

  • @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.
  • @priorityRank – The positive integer gives the priority of this path for all routes between the same entry and exit of the route combination. The highest priority is 0. It is omitted if there is no alternative path.
  • <designator> - A coded name as per a specified register for the asset.
  • <objectName> - A name for the asset in a given language.
  • <belongsToOperationalPoint> - The reference to an <operationalPoint> this ... belongs to from operational point of view.
  • <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>.
  • <comboEntry> – This is the reference to the start element of first route in the combination.
  • <comboExit> – This is the reference to the destination element of the last route in the combination.
  • <containsRoute> – This is the reference to the single route contained in the combination. All route must have the same type. It is preferable that the list of contained routes in the right order from start to end. However, this cannot be enforced by railML.

CombinedRoute.png

The above shown sequence of two routes from Sig1 to Sig3 is used for the example of a combined route.

<combinedRoute id="crt01" priorityRank="0">
        <designator register="_SimpleRegister" entry="crt_sig01_sig03"/>
        <comboEntry ref="sig01"/>
        <comboExit ref="sig03"/>
        <containsRoute ref="rt_sig01_sig02"/>
        <containsRoute ref="rt_sig02_sig03"/>
</combinedRoute>

Additional Information

Notes

With railML3.2 the base type of @priorityRank was changed with the permissable range starting now from 0.

Open Issues