TT:blockPart: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
m (notes for empty runs)
(any element added, added "introduced with version 2.1" template for child element "additionalName")
Line 10: Line 10:


|childs =  
|childs =  
{{TT:Tag|additionalName|blockPart}}
{{TT:Tag|additionalName|blockPart}} {{intro|2.1}}, {{any}} {{intro|2.1}}


|inheritedAttributes =  
|inheritedAttributes =  

Revision as of 16:22, 10 February 2016


blockPart
 


Scheme description / Schemenbeschreibung

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

Multiplicity / Anzahl

[1..1]

Semantics / Bedeutung

The element <blockPart> contains all data, which are related to an atomic particle of a block.

In dem Element <blockPart> werden alle Informationen für einen atomaren Bestandteil eines Umlaufs (blocks) beschrieben.

Attributes of blockPart / Attribute von blockPart

  • 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.
  • begin:
  • beginDay:
  • end:
  • endDay:
  • startOcpRef: This refers to the id attribute of the associated <ocp> element.
    This is the ocp where the vehicle should start the current task.
  • endOcpRef: This refers to the id attribute of the associated <ocp> element.
    This is the ocp where the vehicle should terminate the current task.
  • trainPartRef: This refers to the id attribute of the associated <trainPart> element.
  • operatingPeriodRef: This refers to the id attribute of the associated <operatingPeriod> element.
    This operatingPeriod constraints the dates the current task is to be fulfilled.
  • mission: Possible values are:
  • timetable
  • fullRun
  • emptyRun
  • outOfOrder
  • fillIn
  • preheating
  • refuel
  • shunting
  • depotrun
  • standBy
  • cleaning
  • maintenance
  • inspection
  • other:anything: Any value that does not fit any value from the previous enumeration list, fulfilling the constraint: at minimum two characters, whitespace is not allowed. Please, apply Dev:usingAny accordingly.

The following characteristics of blockPart are allowed:

  • blockPart as a reference to a trainPart: mission=timetable; trainPartRef has to be used; the other attributes (startOcpRef, endOcpRef, begin, end, runLength) are redundant to the corresponding attributes of the train part at its definition in the RailML file. The repeating of these attributes is optional; if they are repeated they have to be consistent.
  • blockPart without a reference to a trainPart: mission=fullRun or emptyRun; trainPartRef must not be used, startOcpRef, endOcpRef, begin and end have to be used.
  • A duty which is not a run outOfOrder, fillIn, preheating, refuel, shunting, depotrun, standBy, cleaning, maintenance, inspection: trainPartRef must not be used, startOcpRef, endOcpRef, begin and end have to be used, startOcpRef=endOcpRef

Es sind folgende Ausprägungen von blockPart vorgesehen:

  • Fahrt als Referenz auf einen Zugteil: mission=timetable; trainPartRef ist anzugeben; die übrigen Attribute (startOcpRef, endOcpRef, begin, end, runLength) sind redundant zu den gleichbedeutenden Eigenschaften der Zugteile bei deren Definition in der RailML-Datei. Das Wiederholen dieser Attribute ist optional; sofern sie wiederholt werden, müssen sie widerspruchsfrei sein.
  • Fahrt ohne Referenz auf einen Zugteil: mission=fullRun oder emptyRun; trainPartRef darf nicht angegeben sein, startOcpRef, endOcpRef, begin und end müssen angegeben sein.
  • Dienst, der keine Fahrt ist: trainPartRef darf nicht angegeben sein, startOcpRef, endOcpRef, begin und end müssen angegeben sein, startOcpRef=endOcpRef
  • mission=shunting (Rangierdienst)
  • mission=maintenance (Wartungsdienst)
  • mission=standBy (Bereitschafts- und Reservedienst)
  • mission=preheating (Vorheizdienst)
  • mission=refuel (Auffüllen von Vorräten, Tanken usw.)
  • fixed:
  • runLength:
  • vehicleRef: This refers to the id attribute of the associated <vehicle> element.
    This vehicle should fulfill the current task. It may supersede the referenced vehicle in <rostering>.
  • formationRef: This refers to the id attribute of the associated <formation> element.
    This formation should fulfill the current task. It may supersede the referenced formation in <rostering>.

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

Best practice & Examples / Empfohlene Anwendung & Beispiele

see RailML-Beispiel Umlauf, PDF, 314 kByte

Notes / Anmerkungen

There are two ways to describe an empty run or depot run. If it is planned in all details in the timetable, it will be defined with appropriate ocpTT's in the trainPart, possibly with serviceSectionRef's if known. If it is loosely planned with time constants but not infrastructural references, it will be defined as blockPart with an appropriate mission value.

Open issues / Offene Punkte/Pendenzen

Not yet described. / Noch nicht beschrieben.