TT:stopDescription ocpTT ocpsTT trainPart

From railML 2 Wiki
Revision as of 18:55, 6 May 2020 by RailML Coord Timetable (talk | contribs) (tried to clarify the semantics of stop on request to document that stop on request can also be used for freight trains)
Jump to navigation Jump to search


stopDescription
 


Scheme description / Schemenbeschreibung

Position of stopDescription in the XML-Tree / Position von stopDescription im XML-Baum

Multiplicity / Anzahl

[0..1]

Semantics / Bedeutung

The element stopDescription describes data concerning the stop (or pass) at the parent ocpTT.

Das Element stopDescription beschreibt Daten, die den Halt (oder die Durchfahrt) im aktuellen ocpTT charakterisieren.
 
Please, be aware of the semantic constraint(s)!

Attributes of stopDescription / Attribute von stopDescription

  • commercial: This characterizes the stop as either commercial or operational stop.
    Verkehrshalt / Betriebshalt
  • stopOnRequest: This indicates a commercial stop, depending on a certain demand, such as passengers or goods waiting for the train to stop. A stop on request is a special kind of a commercial stop. This attribute is not to be defined if commercial is set to false.
    Bedarfshalt: Ein Bedarfshalt ist eine besondere Form des Verkehrshalts. An einem mit stopOnRequest="true" markierten Stop wird nur gehalten, sofern ein entsprechender Bedarf festgestellt wird, also etwa ein- oder aussteigende Fahrgäste, bzw. zu ladende oder zu entladende Fracht. Das Attribut stopOnRequest ist nur anzugeben, wenn commercial="true" ist.
  • onOff: This describes, if passengers/goods are not supposed to enter or leave the train if it is a commercial stop (commercial="true"). The attribute is used for passenger information and with the operational background to encode whether a train may possibly depart before the scheduled time. Concerning semantical constraints, see below.
    z.B. "Halt nur zum Einsteigen"
    Possible values are:
  • both: Train stops to alight as well as to be entered. This is the normal case for most of the commercial stops and therefore the default value.
  • on: Train stops to be entered only or to receive goods only but not to alight/unload.
  • off: Train stops to alight only or to unload goods but not to be entered/receive.
  • purpose: This describes the reason for the stop in a detailed but not predefined way.
    Please be aware that this attribute is only intended to forward simple remarks/explanations from one end-user to another end-user. It is not to be used to contain computer-processable data, nor shall it be parsed by programmes in any way. In case of semantical overlaps or discrepancies especially to <stopActivities> (introduced with version 2.4), any processable <stopActivity> has priority over possible humanly interpretable “purposes”. However, purpose is used to give further (but not computer-processable) information in case of the <stopActivity> type=”misc”.
💡 Please take into account our references to human-intepretable data fields.

Bitte berücksichtigen Sie unsere Hinweise zu menschen-intepretierbaren Datenfeldern.


  • guaranteedPass: (introduced with version 2.2) The train shall pass through this operating point and must not come to a stop for operational reasons (occupied block section, train crossing, ...). Not to be confused with emergency brake override sections. This is used, for example, for heavy goods trains, as they would otherwise not be able to restart due to the high load at this operating point. This attribute is only to be used if <ocpTT>.ocpType is set to "pass".
    Der Zug sollte an dieser Betriebsstelle zwingend durchfahren und nicht aus betrieblichen Gründen (belegter Blockabschnitt, Zugkreuzung, ...) zum Halten kommen. Nicht zu Verwechseln mit einem Notbremsüberbrückungs-Abschnitt. Dies wird zum Beispiel bei schweren Güterzügen verwendet, da diese wegen der hohen Last an dieser Betriebsstelle sonst nicht wieder anfahren könnten (garantierte Durchfahrt). Dieses Attribut ist nur zu verwenden, wenn <ocpTT>.ocpTType auf "pass" gesetzt ist.
  • operationalStopOrdered: (introduced with version 2.2) This indicates that the stop is requested by the train operator (Railway Undertaking), i. e. it is not a commercial stop concerning traffic (not for passengers, not for payload) but anyway the stop is ordered for operational reasons of the operator. This attribute is not to be defined if commercial is set to true.
    bestellter Betriebshalt: Das Attribut ist nur anzugeben, wenn commercial="false" ist.
  • operatingPeriodRef: This refers to the id attribute of the associated <operatingPeriod> element.
    Used to reduce the operating days of the stop compared to the operating days of the train part. If not defined, the stop applies to all operating days of the parent train part.
  • stopPostRef: This refers to the id attribute of the associated <stopPost> element.
    (introduced with version 2.2)
  • xs:anyAttribute: This provides an extension point for non-railML® attributes in a foreign namespace. How to use it?

Syntactic Constraints / Syntaktische Beschränkungen

  • stopOnRequest: xs:boolean, optional, commercial="true" should be set
  • onOff: restriction of xs:string (both, on, off), optional
  • operationalStopOrdered: xs:boolean, optional, commercial="false" should be set

Semantic Constraints / Semantische Beschränkungen

Private-cloud-icon.png Semantic Constraint "TT:006":
 
The following table summarises the semantical constraints between the attributes <ocpTT>.ocpType, <stopDescription>.guaranteedPass, .commercial, .onOff, .stopOnRequest and .operationalStopOrdered:

RailML 2 stopDescription constraints.png

  • Green cells are default values.
  • ocpType='begin','end' are deprecated from railML 2.2.
  • If no <stopDescription> is given, it is either a non-guaranteed pass (1.2) or a stop with undefined properties, depending on the attribute ocpType.
  • The term "commercial" of the attribute in railML traditionally refers to the contractual relationship between RU and end-customer, not to the contractual relationship between IM and RU.
  • The term "ordered" in the attribute operationalStopOrdered refers to the contractual relationship between IM and RU.
     
    Proposed on September 3rd 2018
    Approved on June 20th 2019
    FIXME: add Link to discussion!
    Please, recognize our guidelines on semantic constraints

Best practice & Examples / Empfohlene Anwendung & Beispiele

More than one stop type at the same station

The current modeling only allows one stop type per <stopDescription>. If there is more than one stop type in practice, the following priorities should be used:

  • If there are reasons for both a traffic stop and an operational stop, only a traffic stop shall be declared.
  • If an operational stop becomes necessary by the IM as well as by by the RU, it will be declared as an operational stop by the RU (ordered operational stop).

Die aktuelle Modellierung erlaubt nur jeweils eine Halteart pro <stopDescription>. Liegt in der Praxis mehr als eine Haltart vor, so sollen folgende Priorisierungen genutzt werden:

  • Wenn Gründe für einen Verkehrs- und einen Betriebshalt gleichzeitig vorliegen, wird nur ein Verkehrshalt angegeben.
  • Wenn ein Betriebshalt sowohl durch den Eisenbahninfrastrukturbetreiber als auch durch das Eisenbahnverkehrsunternehmen erforderlich wird, wird er als Betriebshalt durch das Eisenbahnverkehrsunternehmen ausgewiesen (bestellter Betriebshalt).

Examples

General traffic stop | Verkehrshalt

This example corresponds to line 2.2 of the semantic constraint "TT:006" (see above).
Dieses Beispiel entspricht der Zeile 2.2 aus der Semantischen Beschränkung "TT:006" (siehe oben).

<ocpTT ocpRef='…' ocpType='stop'>
  <times scope='scheduled' arrival='12:30:32' departure='12:31:02'/>
  <stopDescription commercial='true' stopOnRequest='false'/>
</ocpTT>

Stop on request / on demand | Bedarfshalt

This example corresponds to line 2.1 of the semantic constraint "TT:006" (see above).
Dieses Beispiel entspricht der Zeile 2.1 aus der Semantischen Beschränkung "TT:006" (siehe oben).

<ocpTT ocpRef='…' ocpType='stop'>
  <times scope='scheduled' arrival='13:33:26' departure='13:33:56'/>
  <stopDescription commercial='true' stopOnRequest='true'/>
</ocpTT>

Operational stop infrastructure, by IM | Betriebshalt EIU

This example corresponds to line 2.8 of the semantic constraint "TT:006" (see above).
Dieses Beispiel entspricht der Zeile 2.8 aus der Semantischen Beschränkung "TT:006" (siehe oben).

<ocpTT ocpRef='…' ocpType='stop'>
  <times scope='scheduled' arrival='12:51:25' departure='12:51:55'/>
  <stopDescription commercial='false' operationalStopOrdered='false'/>
</ocpTT>

Operational stop by RU | Betriebshalt EVU

This example corresponds to line 2.7 of the semantic constraint "TT:006" (see above).
Dieses Beispiel entspricht der Zeile 2.7 aus der Semantischen Beschränkung "TT:006" (siehe oben).

<ocpTT ocpRef='…' ocpType='stop'>
  <times scope='scheduled' arrival='12:45:52' departure='12:59:18'/>
  <stopDescription commercial='false' operationalStopOrdered='true'/>
</ocpTT>

Stop to alight only | Halt nur zum Aussteigen

This example corresponds to line 2.6 of the semantic constraint "TT:006" (see above).
Dieses Beispiel entspricht der Zeile 2.6 aus der Semantischen Beschränkung "TT:006" (siehe oben).

<ocpTT ocpRef='…' ocpType='stop'>
  <times scope='scheduled' arrival='12:58:23' departure='13:00:23'/>
  <stopDescription commercial='true' stopOnRequest='false' on-Off='off'/>
</ocpTT>

Notes / Anmerkungen

If a stop does not apply to all operating days of the train - i. e. the train runs through at several days - the attribute operatingPeriodRef can be used to reduce the operating days of the stop against the operating days of the train. However, be aware that other given attributes as run times, supplements etc. become incorrect by this practice. Also, it can only be used to change between a certain stop and run through but not to switch between two different stop types depending on the days of operation. Therefore, many applications would probably split the train into two instead of using operatingPeriodRef.

Open issues / Offene Punkte/Pendenzen

Not yet described. / Noch nicht beschrieben.