Difference between revisions of "TT:category"

From wiki.railML.org
Jump to: navigation, search
[checked revision][checked revision]
(Definition of TrainCategory Usage added (courtesy of Rufat Mammadov))
(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)
Line 42: Line 42:
  
 
*{{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 =  
 
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang="xml">

Revision as of 16:46, 11 November 2019

category
 


Scheme description / Schemenbeschreibung / Description du schéma

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

Multiplicity / Anzahl / Multiplicité

[1..∞]

Semantics / Bedeutung / Sémantique

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.
 
Please, be aware of the semantic constraint(s)!

Attributes of category / Attribute von category / Attributs de 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.
    Maschineninterpretierbare Zeichenkette (z.B. Abkürzung), die zur Identifizierung des Objekts auch bei Austauschpartnern verwendet wird, wobei spezifische Eindeutigkeitsbeschränkungen gelten können.
  • 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.) 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).

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.
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.

  • 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 / Contraintes syntactiques

  • 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 (_)
  • trainUsage optional

Semantic Constraints / Semantische Beschränkungen / Contraintes semantiques

Private-cloud-icon.png Proposed Semantic Constraint "TT:011":
 
Es besteht eine semantische Beziehung zwischen den Attributen trainUsage und deadRun. Eine entsprechende Empfehlung zur Verwendung und zu Einschränkungen der zulässigen Kombinationen soll hier dokumentiert werden. WIP.
 
Proposed on October 21st 2019
Please, recognize our guidelines on semantic constraints

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

<category id="cat01" name="THA" description="Thalys" trainUsage="passenger" categoryPriority="1"/>

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

Notes / Anmerkungen / Notes

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

Open issues / Offene Punkte/Pedenzen / Questions ouvertes

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