TT:topologyReference: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
mNo edit summary
No edit summary
Line 8: Line 8:
The {{TT:Doc|topologyReference}} element {{Intro|2. 4}} can be used to refer the underlying topology, which was used to determine the train running path and calculate the runtimes. Specifying the topology register and an optional time period, the attribute {{Attr|entry}} is used to refer to the external version / variant within the topology register. This assumes that the reading system also knows the topology register and can interpret the version / variant definition. When specifying multiple topology references, these must have a disjoint time period and, combined together, cover at least the operating days of the train.
The {{TT:Doc|topologyReference}} element {{Intro|2. 4}} can be used to refer the underlying topology, which was used to determine the train running path and calculate the runtimes. Specifying the topology register and an optional time period, the attribute {{Attr|entry}} is used to refer to the external version / variant within the topology register. This assumes that the reading system also knows the topology register and can interpret the version / variant definition. When specifying multiple topology references, these must have a disjoint time period and, combined together, cover at least the operating days of the train.


{{deu|Mit dem {{TT:Doc|topologyReference}} Element kann für einen Zug die zugrundeliegende Topologie, welche für die Ermittlung des Fahrweges und Berechnung der Fahrzeiten verwendet wurde, referenziert werden. Unter Angabe des Topologie-Registers sowie einer optionalen Zeitperiode wird mit dem Attribut {{Attr|entry}} die Version / Variante innerhalb der externen Topologie referenziert. Dies setzt voraus, dass das lesende System das Topologie-Register ebenfalls kennt und die Version / Variante interpretieren kann. Bei der Angabe mehrerer Referenzen müssen diese einen disjunkten Zeitraum haben sowie in der Kombination mindestens die Betriebstage des Zuges abdecken.}}
{{deu|Mit dem {{TT:Doc|topologyReference}} Element kann für einen Zug die zugrundeliegende Topologie, welche für die Ermittlung des Fahrweges und Berechnung der Fahrzeiten verwendet wurde, referenziert werden. Unter Angabe des Topologie-Registers sowie einer optionalen Zeitperiode wird mit dem Attribut {{Attr|entry}} die Version / Variante innerhalb der externen Topologie referenziert. Dies setzt voraus, dass das lesende System das Topologie-Register ebenfalls kennt und die Version / Variante interpretieren kann. Bei der Angabe mehrerer Referenzen müssen diese einen disjunkten Zeitraum haben sowie in der Kombination mindestens die Betriebstage des Zuges abdecken. {{intro|2.4}}}}


|parent = {{TT:Tag|trainPartSequence}}
|parent = {{TT:Tag|trainPartSequence}}

Revision as of 11:00, 25 October 2017

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.

Missinginformation.png In this article there is information missing with respect to referencing from parent element trainPartSequence. Please help improving the railML® wiki by filling the gaps. Possibly, you will find further details on the discussion pageCoordination (talk) 09:11, 23 October 2017 (CET)


topologyReference
 


Scheme description / Schemenbeschreibung

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

Multiplicity / Anzahl

[1..1]

Semantics / Bedeutung

The topologyReference element (introduced with version 2. 4) can be used to refer the underlying topology, which was used to determine the train running path and calculate the runtimes. Specifying the topology register and an optional time period, the attribute entry is used to refer to the external version / variant within the topology register. This assumes that the reading system also knows the topology register and can interpret the version / variant definition. When specifying multiple topology references, these must have a disjoint time period and, combined together, cover at least the operating days of the train.

Mit dem topologyReference Element kann für einen Zug die zugrundeliegende Topologie, welche für die Ermittlung des Fahrweges und Berechnung der Fahrzeiten verwendet wurde, referenziert werden. Unter Angabe des Topologie-Registers sowie einer optionalen Zeitperiode wird mit dem Attribut entry die Version / Variante innerhalb der externen Topologie referenziert. Dies setzt voraus, dass das lesende System das Topologie-Register ebenfalls kennt und die Version / Variante interpretieren kann. Bei der Angabe mehrerer Referenzen müssen diese einen disjunkten Zeitraum haben sowie in der Kombination mindestens die Betriebstage des Zuges abdecken. (introduced with version 2.4)

Attributes of topologyReference / Attribute von topologyReference

  • topologyRegister: A string value for defining the catalogue, index, or directory where the external topology reference comes from or refers to. Attribute register is used to link a topologyReference with the codelist TopologyRegisters.xml. See below for a list of the currently registered catalogues.
  • entry: Contains the external key of the referred register.
  • startDate: Begin of the validity period for the topology reference.
  • endDate: End of validity period for the topology reference.
  • xs:anyAttribute: This provides an extension point for non-railML® attributes in a foreign namespace. How to use it?

Syntactic Constraints / Syntaktische Beschränkungen

  • topologyRegister xs:string, required: For short-time or internal purposes new string value entries can be used additional to that of railML's XSD. But for official data exchange between two software programs it is _strongly_ recommended that each new 'register' entry has to be 'registered' at the Scheme Coordinator and included into the codelist TopologyRegisters.xml.
  • entry: xs:string, required: May be a string or a number depending on the 'register'. This means, some 'register' entries require a pure numeric number and do not allow characters or other signs. This is not forced by railML so far.
  • startDate: xs:date, optional
  • endDate: xs:date, optional

Best practice & Examples / Empfohlene Anwendung & Beispiele

The following trainPartSequence has tow references in the UNO topology register. The first one refrences the external topology version used to determine the train running path and calculate the runtimes from 1 February to 31 August 2017 of the train operating days. The second reference points to the external version used for the operating days from 1 September to 31 December 2017.

Thus, for the train operating days from 1 February to 31 August 2017 the UNO topology version "20170101-18:30:00" is used. For the operating days from 1 September to 31 Decenber 2017 the UNO version "20170801-12:00:00" is referenced.

<trainPartSequence sequence="1">
    <trainPartRef ref="train-part-1" />
    <topologyReference topologyRegister="UNO" entry="20170101-18:30:00" startDate="2017-02-01" endDate="2017-08-31" />
    <topologyReference topologyRegister="UNO" entry="20170801-12:00:00" startDate="2017-09-01" endDate="2017-12-31" />
</trainPartSequence>

Notes / Anmerkungen

Currently predefined 'register' enumeration entries:

  • UNO Central topology database for railway systems (source: Swiss Federal Railways).

Open issues / Offene Punkte/Pendenzen

Not yet described. / Noch nicht beschrieben.