Difference between revisions of "TT:stopDescription"

From wiki.railML.org
Jump to: navigation, search
[checked revision][unchecked revision]
(Clarifying usage of onOff and semantical constraints by adding the table from stopDescription_defaults.xlsx (June 2017).)
Line 16: Line 16:
 
* {{Attr|stopOnRequest}}: This indicates a commercial stop, depending on a certain demand. A stop on request is a special kind of a commercial stop. This attribute is not to be defined if {{Attr|commercial}} is set to {{Attr|false}}. <br> {{Deu|Bedarfshalt: Ein Bedarfshalt ist eine besondere Form des Verkehrshalts. Das Attribut {{Attr|stopOnRequest}} ist nur anzugeben, wenn {{Attr|<nowiki>commercial="true"</nowiki>}} ist.}}
 
* {{Attr|stopOnRequest}}: This indicates a commercial stop, depending on a certain demand. A stop on request is a special kind of a commercial stop. This attribute is not to be defined if {{Attr|commercial}} is set to {{Attr|false}}. <br> {{Deu|Bedarfshalt: Ein Bedarfshalt ist eine besondere Form des Verkehrshalts. Das Attribut {{Attr|stopOnRequest}} ist nur anzugeben, wenn {{Attr|<nowiki>commercial="true"</nowiki>}} ist.}}
  
* {{Attr|onOff}}: This describes, if passengers/goods are not supposed to enter or leave the train. <br> {{Deu|z.B. "Halt nur zum Einsteigen"}} <br> Possible values are:
+
* {{Attr|onOff}}: This describes, if passengers/goods are not supposed to enter or leave the train if it is a commercial stop ({{Attr|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.<br> {{Deu|z.B. "Halt nur zum Einsteigen"}} <br> Possible values are:
{{missing information|user=[[User:Ferri Leberl|Ferri Leberl]] ([[User talk:Ferri Leberl|talk]]) 16:19, 25 April 2018 (CEST)|topic=the semantics of the enumeration items}}
+
:* {{Enum|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.
:* {{Enum|both}}
+
:* {{Enum|on}}: Train stops to be entered only or to receive goods only but not to alight/unload.
:* {{Enum|on}}
+
:* {{Enum|off}}: Train stops to alight only or to unload goods but not to be entered/receive.
:* {{Enum|off}}
+
  
 
* {{Attr|purpose}}: This describes the reason for the stop in a detailed but not predefined way.
 
* {{Attr|purpose}}: This describes the reason for the stop in a detailed but not predefined way.
  
* {{Attr|guaranteedPass}}: {{Intro|2.2}} This indicates a forbidden stop for heavy goods trains, otherwise they would not be able to get off. <br> {{Deu|garantierte Durchfahrt}}
+
* {{Attr|guaranteedPass}}: {{Intro|2.2}} This indicates a forbidden stop for heavy goods trains, otherwise they would not be able to get off. This attribute is only to be used if {{TT:Tag|ocpTT}}.{{Attr|ocpType}} is set to 'pass'.<br> {{Deu|garantierte Durchfahrt}}
  
 
* {{Attr|operationalStopOrdered}}: {{Intro|2.2}} This indicates that the stop is requested by the operator (Train Operating Company), 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 {{Attr|commercial}} is set to {{Attr|true}}. <br> {{Deu|bestellter Betriebshalt: Das Attribut ist nur anzugeben, wenn {{Attr|<nowiki>commercial="false"</nowiki>}} ist.}}
 
* {{Attr|operationalStopOrdered}}: {{Intro|2.2}} This indicates that the stop is requested by the operator (Train Operating Company), 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 {{Attr|commercial}} is set to {{Attr|true}}. <br> {{Deu|bestellter Betriebshalt: Das Attribut ist nur anzugeben, wenn {{Attr|<nowiki>commercial="false"</nowiki>}} ist.}}
Line 61: Line 60:
  
 
* {{Attr|stopPostRef}}: {{RailMLType|tGenericRef}}, optional
 
* {{Attr|stopPostRef}}: {{RailMLType|tGenericRef}}, optional
 +
 +
The following table summarises the semantical constraints between the attributes {{TT:Tag|ocpTT}}.{{Attr|ocpType}}, {{TT:Tag|stopDescription}}.{{Attr|guaranteedPass}}, .{{Attr|commercial}}, .{{Attr|onOff}}, .{{Attr|stopOnRequest}} and  .{{Attr|operationalStopOrdered}}:<br>
 +
[[file:rml_stopDescription_en_constraints.png||semantical constraints of <stopDescription>]]<br>
 +
* Green cells are default values.
 +
* {{Attr|ocpType}}='begin','end' are deprecated from railML 2.2.
 +
* If no {{TT:Tag|stopDescription}} is given, it is either a non-guaranteed pass (1.2) or a stop with undefined properties, depending on the attribute {{Attr|ocpType}}.
 +
* ''The term "commercial" of the attribute in railML traditionally refers to the contractual relationship between TOC and end-customer, not to the contractual relationship between IM and TOC.''
 +
* ''The term "ordered" in the attribute {{Attr|operationalStopOrdered}} refers to the contractual relationship between IM and TOC.''
  
 
|notes =  
 
|notes =  

Revision as of 15:38, 3 September 2018

stopDescription
 


Scheme description / Schemenbeschreibung / Description du schéma

Position of stopDescription in the XML-Tree / Position von stopDescription im XML-Baum / position de stopDescription dans l’aborescence XML

Multiplicity / Anzahl / Multiplicité

[1..1]

Semantics / Bedeutung / Sémantique

The element stopDescription describes data concerning the stop a the certain ocpTT.

Das Element stopDescription beschreibt Daten, die den Halt im aktuellen ocpTT charakterisieren.

Attributes of stopDescription / Attribute von stopDescription / Attributs de 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. 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. 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.
  • guaranteedPass: (introduced with version 2.2) This indicates a forbidden stop for heavy goods trains, otherwise they would not be able to get off. This attribute is only to be used if <ocpTT>.ocpType is set to 'pass'.
    garantierte Durchfahrt
  • operationalStopOrdered: (introduced with version 2.2) This indicates that the stop is requested by the operator (Train Operating Company), 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 / Contraintes syntactiques

  • 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

The following table summarises the semantical constraints between the attributes <ocpTT>.ocpType, <stopDescription>.guaranteedPass, .commercial, .onOff, .stopOnRequest and .operationalStopOrdered:
semantical constraints of <stopDescription>

  • 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 TOC and end-customer, not to the contractual relationship between IM and TOC.
  • The term "ordered" in the attribute operationalStopOrdered refers to the contractual relationship between IM and TOC.

Best practice & Examples / Empfohlene Anwendung & Beispiele / Bonnes pratiques & exemples

General traffic stop | Verkehrshalt

<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

<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

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

Operational stop by TOC | Betriebshalt EVU

<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

<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 / Notes

It is not intended to write different stop types at the same station. Concerning the usualities of railway operation:

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

A stop on request is a special case of a traffic stop.

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.

Es ist nicht vorgesehen, mehrere Haltearten gleichzeitig anzugeben. Entsprechend den Gepflogenheiten im Eisenbahnbetrieb gelten:

  • Wenn Gründe für einen Verkehrs- und einen Betriebshalt gleichzeitig vorliegen, wird ein Verkehrshalt angegeben.
  • Wenn ein Betriebshalt sowohl durch den Infrastrukturbetreiber als auch durch den Fahrzeugbetreiber erforderlich wird, wird er als Betriebshalt durch Fahrzeugbetreiber ausge-wiesen (bestellter Betriebshalt).

Ein Bedarfshalt ist eine besondere Form des Verkehrshaltes.

Open issues / Offene Punkte/Pedenzen / Questions ouvertes

Not yet described. / Noch nicht beschrieben. / Pas encore décrit.