TT:category: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
(added semantic constraint between deadRun and trainUsage. a best practive recomendation is still missing. this shall be added after the discussion in the timetable developer group)
(5 intermediate revisions by 3 users not shown)
Line 22: Line 22:


|ownAttributes =
|ownAttributes =
*{{Attr|trainUsage}}: This defines the purpose of the train journey for service, representation and information applications. ''(Not to be confused with ETCS Operational Train Categories from Annex B of [https://www.era.europa.eu/sites/default/files/activities/docs/appendix_a_ope_tsi_en.pdf Technical Specifications OPE].)'' Possible values are:<br>{{deu|Damit wird der Zweck der Zugfahrt für Service-, Darstellungs- und Informationsanwendungen definiert. ''(Nicht zu verwechseln mit ETCS Operational Train Kategorien aus Anhang B der Technischen Spezifikationen OPE.)''}}
*{{Attr|trainUsage}}: This defines the purpose of the train journey for service, representation and information applications. ''(Not to be confused with ETCS Operational Train Categories from Annex B of {{external|https://www.era.europa.eu/sites/default/files/activities/docs/appendix_a_ope_tsi_en.pdf|Technical Specifications OPE}}.)'' Possible values are:<br>{{deu|Damit wird der Zweck der Zugfahrt für Service-, Darstellungs- und Informationsanwendungen definiert. ''(Nicht zu verwechseln mit ETCS Operational Train Kategorien aus Anhang B der Technischen Spezifikationen OPE.)''}}


:* {{Enum|passenger}}: The train consists of passenger wagons only (independent of the amount of passengers on board; for full and empty trains).<br>{{deu|Der Zug besteht nur aus Personenwagen (unabhängig von der Anzahl der an Bord befindlichen Personen; für Voll- und Leerzüge).}}
:* {{Enum|passenger}}: The train consists of passenger wagons only (independent of the amount of passengers on board; for full and empty trains).<br>{{deu|Der Zug besteht nur aus Personenwagen (unabhängig von der Anzahl der an Bord befindlichen Personen; für Voll- und Leerzüge).}}
Line 28: Line 28:
:* {{Enum|mixed}}: The train consists of both passenger and cargo wagons (independent of the amount of passengers and goods on board).<br>{{deu|Der Zug besteht sowohl aus Personen- als auch aus Güterwagen (unabhängig von der Anzahl der Personen und Güter an Bord).}}
:* {{Enum|mixed}}: The train consists of both passenger and cargo wagons (independent of the amount of passengers and goods on board).<br>{{deu|Der Zug besteht sowohl aus Personen- als auch aus Güterwagen (unabhängig von der Anzahl der Personen und Güter an Bord).}}


Note: Up to railML 2.4 there seems to be no clear definition for some specials train usage purposes, e.g. a train consisting of a single universal locomotive, or a working train like a tamping machine.<br>{{deu|Hinweis: Bis einschließlich railML 2.4 scheint es keine klare Definition für einige besondere Zwecke zu geben, z.B. für einen Zug, der nur aus einer einzigen (Universal-)Lokomotive besteht oder einen Arbeitszug wie eine Stopfmaschine.}}


*{{Attr|deadrun}}: This is true if a train with this category runs empty, for operational purposes only.
*{{Attr|deadrun}}: This is true if a train with this category runs empty, for operational purposes only.
Line 42: Line 41:


*{{Attr|categoryPriority}} {{XsdType|string}}, optional
*{{Attr|categoryPriority}} {{XsdType|string}}, optional
|semcon = {{semcon|Es besteht eine semantische Beziehung zwischen den Attributen {{Attr|trainUsage}} und {{Attr|deadRun}}. Eine entsprechende Empfehlung zur Verwendung und zu Einschränkungen der zulässigen Kombinationen soll hier dokumentiert werden. WIP.|status=proposed|proposed=2019-10-21|id=TT:011}}
 
|example =  
|example =  
=== Data type of the {{@|categoryPriority}} ===
Even if the data type was modeled as {{XsdType|string}} in the past, it is recommended to specify {{Attr|categoryPriority}} as an numerical value (integer and positive; 0 - ∞), the lower the value, the higher the priority. The use according to the schema definition as a character string is still allowed, but the interpretation would then have to be agreed bilaterally between consumer and producer of the data.<br>
{{Deu|Auch wenn der Datentyp in der Vergangenheit als Zeichenkette ({{XsdType|string}}) modelliert wurde, wird empfohlen, für {{Attr|categoryPriority}} numerische Werte (ganzzahlig und positiv; 0 – ∞) anzugeben, wobei ein kleinerer Wert eine höhere Priorität beschreiben würde. Die Verwendung entsprechend der Schemendefinition als Zeichenkette ist weiterhin zulässig, allerdings wäre die Interpretation dann zwischen Konsument und Produzent der Daten bilateral zu vereinbaren.}}
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
<category id="cat00" name="ROY" description="Royal train" trainUsage="passenger" categoryPriority="0"/>
<category id="cat01" name="THA" description="Thalys" trainUsage="passenger" categoryPriority="1"/>
<category id="cat01" name="THA" description="Thalys" trainUsage="passenger" categoryPriority="1"/>
<category id="cat02" name="EC" description="EuroCity" trainUsage="passenger" categoryPriority="5"/>
<category id="cat03" name="IC" description="InterCity" trainUsage="passenger" categoryPriority="5"/>
<category id="cat04" name="R" description="Regional" trainUsage="passenger" categoryPriority="10"/>
<category id="cat05" name="WT" description="WorkTrain" categoryPriority="381"/>
</syntaxhighlight>
</syntaxhighlight>


Line 51: Line 60:


|backHome = TT:elements
|backHome = TT:elements
|openissues=
===Unclear usage of {{@|trainUsage}}===
Up to railML 2.4 there seems to be no clear definition for some specials train usage purposes, e.g. a train consisting of a single universal locomotive, or a working train like a tamping machine.<br>{{deu|Hinweis: Bis einschließlich railML 2.4 scheint es keine klare Definition für einige besondere Zwecke zu geben, z.B. für einen Zug, der nur aus einer einzigen (Universal-)Lokomotive besteht oder einen Arbeitszug wie eine Stopfmaschine.}}
}}
}}

Revision as of 14:05, 18 May 2020


category
 


Scheme description / Schemenbeschreibung

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

Multiplicity / Anzahl

[1..∞]

Semantics / Bedeutung

The Element <category> describes a "train type" or "train category". Depending on the system, these terms are defined quite differently.

Das Element <category> beschreibt einen "Zugtyp", bzw. eine "Zuggattung" oder auch eine "Zugkategorie". Je nach System werden diese Begriffe sehr unterschiedlich definiert.

Attributes of category / Attribute von category

  • id: XML-file-wide unique, machine-interpretable identity, required for later referencing that element internally. For a detailed explanation see Dev:identities.
    XML-Datei-weit eindeutige, maschineninterpretierbare Identität, die für die spätere interne Referenzierung dieses Elements erforderlich ist. Für eine detaillierte Erklärung siehe Dev:identities.
  • code (introduced with version 2.1): Machine-interpretable string (e.g. an abbreviation) used for identification of the object across exchange partners, usecase specific uniqueness constraints may apply. Please see our description of the differences between id, code and human-readable identifiers.
    Maschineninterpretierbare Zeichenkette (z.B. Abkürzung), die zur Identifizierung des Objekts auch bei Austauschpartnern verwendet wird, wobei spezifische Eindeutigkeitsbeschränkungen gelten können. Bitte beachten Sie unsere Erläuterung zu den Unterschieden zwischen id, code and menschenlesbaren Kennzeichnungen.
  • name: Established, human-readable short string, giving the object a name. Not intended for machine interpretation, please see our notice on human interpretable data fields.
    Etablierte, menschenlesbare kurze Zeichenkette, die das Objekt benennt. Nicht zur maschinellen Interpretation bestimmt, siehe Hinweise zu menschenlesbaren Datenfeldern.
  • description: Human-readable, more detailed description as addition to the name. It should give additional explanations or hints to the contents of this element. Not intended for machine interpretation, please see our notice on human interpretable data fields.
    Menschenlesbare, detailliertere Beschreibung als Ergänzung zu name. Sie soll zusätzliche Erläuterungen oder Hinweise auf den Inhalt dieses Elements geben. Nicht zur maschinellen Interpretation bestimmt, siehe Hinweise zu menschenlesbaren Datenfeldern.
  • xml:lang (introduced with version 2.1): This is a unique identifier of language. It uses basically the language standard IETF BCP 47 (external link) which may be different to ISO 639-1 (external link) or ISO 639-2 (external link). For mapping hints see relation to other standards (external link).
    This defines the language used for name and description. Use <additionalName> to provide a name and/or description in other languages.
  • trainUsage: This defines the purpose of the train journey for service, representation and information applications. (Not to be confused with ETCS Operational Train Categories from Annex B of Technical Specifications OPE (external link).) Possible values are:
    Damit wird der Zweck der Zugfahrt für Service-, Darstellungs- und Informationsanwendungen definiert. (Nicht zu verwechseln mit ETCS Operational Train Kategorien aus Anhang B der Technischen Spezifikationen OPE.)
  • passenger: The train consists of passenger wagons only (independent of the amount of passengers on board; for full and empty trains).
    Der Zug besteht nur aus Personenwagen (unabhängig von der Anzahl der an Bord befindlichen Personen; für Voll- und Leerzüge).
  • goods: The train consists of cargo wagons only (independent of the amount of goods on board; for full and empty trains).
    Der Zug besteht nur aus Güterwagen (unabhängig von der Menge der an Bord befindlichen Güter; für Voll- und Leerzüge).
  • mixed: The train consists of both passenger and cargo wagons (independent of the amount of passengers and goods on board).
    Der Zug besteht sowohl aus Personen- als auch aus Güterwagen (unabhängig von der Anzahl der Personen und Güter an Bord).


  • deadrun: This is true if a train with this category runs empty, for operational purposes only.
  • categoryPriority: It describes the importance of a category in relationship to other categories (e.g. passengers higher than goods, or privileged long distance trains).

Syntactic Constraints / Syntaktische Beschränkungen

  • id: xs:ID, required
    a string, starting with a letter (a..zA..Z) or an underscore (_),
    followed by a non-colonized and non-spaced string consisting of letters, digits, points (.), dashes (-) or underscores (_)
  • code: xs:string, optional
  • name: xs:string, optional
  • description: xs:string, optional
  • xml:lang: xs:language, language identification, optional
  • trainUsage optional

Best practice & Examples / Empfohlene Anwendung & Beispiele

Data type of the @categoryPriority

Even if the data type was modeled as xs:string in the past, it is recommended to specify categoryPriority as an numerical value (integer and positive; 0 - ∞), the lower the value, the higher the priority. The use according to the schema definition as a character string is still allowed, but the interpretation would then have to be agreed bilaterally between consumer and producer of the data.
Auch wenn der Datentyp in der Vergangenheit als Zeichenkette (xs:string) modelliert wurde, wird empfohlen, für categoryPriority numerische Werte (ganzzahlig und positiv; 0 – ∞) anzugeben, wobei ein kleinerer Wert eine höhere Priorität beschreiben würde. Die Verwendung entsprechend der Schemendefinition als Zeichenkette ist weiterhin zulässig, allerdings wäre die Interpretation dann zwischen Konsument und Produzent der Daten bilateral zu vereinbaren.

<category id="cat00" name="ROY" description="Royal train" trainUsage="passenger" categoryPriority="0"/>
<category id="cat01" name="THA" description="Thalys" trainUsage="passenger" categoryPriority="1"/>
<category id="cat02" name="EC" description="EuroCity" trainUsage="passenger" categoryPriority="5"/>
<category id="cat03" name="IC" description="InterCity" trainUsage="passenger" categoryPriority="5"/>
<category id="cat04" name="R" description="Regional" trainUsage="passenger" categoryPriority="10"/>
<category id="cat05" name="WT" description="WorkTrain" categoryPriority="381"/>

see also Train types, categories, products, and passenger usage

Notes / Anmerkungen

Not yet described. / Noch nicht beschrieben.

Open issues / Offene Punkte/Pendenzen

Unclear usage of @trainUsage

Up to railML 2.4 there seems to be no clear definition for some specials train usage purposes, e.g. a train consisting of a single universal locomotive, or a working train like a tamping machine.
Hinweis: Bis einschließlich railML 2.4 scheint es keine klare Definition für einige besondere Zwecke zu geben, z.B. für einen Zug, der nur aus einer einzigen (Universal-)Lokomotive besteht oder einen Arbeitszug wie eine Stopfmaschine.