Dev:changes/2.4

From railML 2 Wiki
Jump to navigation Jump to search

Sunrise.png This article contains information that is only valid for a future railML® version. The article refers to version 2.4, whereas the current railML® version is 2.5.
RailML Trademark RGB V2.png
XML Railway exchange format
https://railML.org
Latest release: 2.5
(September 1st, 2021)
 
Main Menu
 
Subschemas
XML tree
UML diagrams
Use cases
Versions & Changes

railML schema changes between railML® 2.3 and railML® 2.4

This site is intended to collect the schema changes between railML® 2.3 and railML® 2.4 by topics, that influence the XML output. As it starts as a stub please refer to

For changes with other version upgrades see Dev:changes.

Timetable Subschema

Element <stopDescription> has been expanded by the children <stopActivities>

Fact: The new element <stopActivities> can be used to group <stopActivity>-elements which describe the purposes of a stop more detailed. The detailed purpose of a stop is described in the attribute type of a <stopActivity>. For the possible values for attribute type, a list of values has been drawn up to illustrate the most common holding purposes of various companies.
Recommendation: Use the new <stopActivity>-elements to describe the detailed purposes of a stop. Use if possible the standard values for the attribute type of <stopActivity>-elements.
ocpTT element sample:
<ocpTT offset="383.220001" alignment="center" ocpType="begin" ocpRef="ocp-35154097">
	<times scope="published" departure="00:22:00"/>
	<sectionTT>
		<trackRef ref="gleiskante1027"/>
		<runTimes minimalTime="PT84S"/>
	</sectionTT>
	<stopDescription onOff="both" commercial="true">
		<stopTimes minimalTime="PT180S"/>
		<stopActivities>
			<stopActivity type="reverse"/>
			<stopActivity type="crewChange"/>
		</stopActivities>
	</stopDescription>
</ocpTT>
Updated XSD file(s): timetableTypes.xsd
New attributes:
  • /ocpTT/stopDescription/stopActivities/stopActivity@type
New elements:
  • /ocpTT/stopDescription/stopActivities
  • /ocpTT/stopDescription/stopActivities/stopActivity

Element <trainPartSequence> has been expanded by the children <topologyReference>

Fact: With the new <topologyReference> element, the underlying topology used to determine the route and calculate journey times can be referenced. A <topologyReference> can be set for a <trainPartSequence>. By specifying the attributes register and entry, the version(s) and/or variant(s) to be used are referenced within the external topology. This presupposes that the reading system also knows the topology register and can interpret the version(s)/variant(s). If the validity periods are not uniquely defined by the specifications register and entry, they must be specified using the attributes startDate and EndDate. If several references are specified, they must have disjoint validity periods and, in combination, cover at least the operating days of the train.
train element sample:
<train type="operational" id="train-1455532037" processStatus="actual">
    <trainPartSequence sequence="1">
        <trainPartRef ref="train-part-1" />
        <topologyReference register="UNO" entry="183000-01012017" startDate="2017-02-01" endDate="2017-08-31" />
        <topologyReference register="UNO" entry="120000-08012017" startDate="2017-09-01" endDate="2017-12-31" />
    </trainPartSequence>
</train>
Updated XSD file(s): timetableTypes.xsd
New attributes:
  • /train/trainPartSequence/topologyReference@register
  • /train/trainPartSequence/topologyReference@entry
  • /train/trainPartSequence/topologyReference@startDate
  • /train/trainPartSequence/topologyReference@endDate
New elements:
  • /train/trainPartSequence/topologyReference

Element <train> has been expanded by the children <replacements>

Fact: The new <replacements> element is used to group <replacementOf> elements within <train> elements. Using the element <replacementOf> a relationship is defined between the train described in the XML tree and a train that has been cancelled or partially cancelled. The meaning of the relationship is that the train described in the XML tree replaces the cancelled train or the cancelled parts of a train (specified by <uniqueTrainKey> or <tafTapTsiTrainID>) on the specified operating days (specified by <operatingPeriodRef>)
train element sample:
<train id="train-zug-BLSP-90111-001" 
    trainNumber="90111" 
    additionalTrainNumber="1" 
    cancellation="false"
    processStatus="actual"
    description="Bern-Muensingen-Thun">
     <trainPartSequence sequence="1">
          <trainPartRef ref="trainPart1001"/>
     </trainPartSequence>
     <replacements>
         <replacementOf>
             <operatingPeriodRef ref="operating-period-KW47-MoFr-18" />
             <uniqueTrainKey trainNumber="111" scope="primary" additionalTrainNumber="1" />
         </replacementOf>
     </replacements>
</train>
Updated XSD file(s):
  • timetable.xsd
  • timetableTypes.xsd
New attributes:
  • /train/replacements/replacementOf/operatingPeriodRef@ref
  • /train/replacements/replacementOf/uniqueTrainKey @trainNumber
  • /train/replacements/replacementOf/uniqueTrainKey@scope
  • /train/replacements/replacementOf/uniqueTrainKey@additionalTrainNumber
  • /train/replacements/replacementOf/tafTapTsiTrainID@objectType
  • /train/replacements/replacementOf/tafTapTsiTrainID@companyCode
  • /train/replacements/replacementOf/tafTapTsiTrainID@core
  • /train/replacements/replacementOf/tafTapTsiTrainID@variant
  • /train/replacements/replacementOf/tafTapTsiTrainID@timetableYear
New elements:
  • /train/replacements
  • /train/replacements/replacementOf
  • /train/replacements/replacementOf/operatingPeriodRef
  • /train/replacements/replacementOf/uniqueTrainKey
  • /train/replacements/replacementOf/tafTapTsiTrainID

Infrastructure Subschema

OCP example added to wiki page <ocp>

Fact: OCP example Pulsnitz (from example file East Saxony) has been added to railML wiki page IS:ocp
Related Development Tickets: https://trac.railml.org/ticket/112 (external link)

<lineDescr> and <trackDescr> DEPRECATED

Fact: <lineDescr> and <trackDescr> are marked DEPRECATED with version 2.4
Reason: The elements are not being used
Recommendation: For additional description of line or track, please use the attributes <track>@description and <line>@description
Related Development Tickets: https://trac.railml.org/ticket/112 (link to the railML® website)
Updated attribute(s):

<signal>@sigSystem

Fact: <signal>@sigSystem is currently not used by railML community and thus is marked DEPRECATED with version 2.4
Related Development Tickets: https://trac.railml.org/ticket/162 (link to the railML® website)

Specification of <balise>@staticTelegram changed

Fact: The string data type is combined with a pattern for the HEX format: [0-9a-fA-F]*
Reason: The attribute shall be used to represent the binary balise telegram as HEX string
Related Development Tickets: https://trac.railml.org/ticket/163 (link to the railML® website)
Updated attribute(s): <balise>@staticTelegram

New child element <maxTrainCurrent> for <electrificationChange> and <electrification>

Fact: New child elements <maxTrainCurrent> for <electrificationChange> and <electrification>:

attributes @maxCurrent [A], @type [driving/standstill], @validFor [train/pantograph] and @##any for specific constraints

Related Development Tickets: https://trac.railml.org/ticket/319 (link to the railML® website)
New element(s):
Updated element(s):

Several Attributes of Template:IS:TAG DEPRECATED

Fact: <signal>@maskableRoute, <signal>>@maskableATC, <signal>@sight, <signal>@distNearestDangerPoint are currently not used by railML community and thus are marked DEPRECATED with version 2.4
Related Development Tickets: https://trac.railml.org/ticket/322 (link to the railML® website)
Updated attribute(s):
Updated element(s): <signal>

several default values in <levelCrossing> removed

Fact: Default values for <levelCrossing> attributes @length, @angle and @protection removed
Reason: Current implementation of a level crossing contains some attributes with default values that are source of errors
Related Development Tickets: https://trac.railml.org/ticket/323 (link to the railML® website)
Updated attribute(s):
Updated element(s): <levelCrossing>

<track>@mainDir DEPRECATED

Fact: <track>@mainDir is currently not used by railML community and thus is marked DEPRECATED with version 2.4
Recommendation: Meaning and usage of the attribute shall be reviewed for implementation in railML 3.x
Related Development Tickets: https://trac.railml.org/ticket/324 (link to the railML® website)
Updated attribute(s): <track>@mainDir
Updated element(s): <track>