TT:blockPart: Difference between revisions
[checked revision] | [checked revision] |
(moved explanation to best practice) |
No edit summary |
||
Line 117: | Line 117: | ||
|example = | |example = | ||
=== {{attr|mission}} === | === {{attr|mission}} === | ||
The following characteristics of blockPart are allowed: | The following characteristics of {{TT:Tag|blockPart}} are allowed: | ||
:* '''blockPart as a reference to a trainPart''': {{Attr|mission}}<nowiki>=</nowiki>timetable | :* '''{{TT:Tag|blockPart}} as a reference to a {{TT:Tag|trainPart}}''': | ||
:* '''blockPart without a reference to a trainPart''': {{Attr|mission}}<nowiki>=</nowiki>fullRun | ::*{{Attr|mission}}<nowiki>=</nowiki>{{enum|timetable}} | ||
:* '''A duty which is not a run''' {{Enum|outOfOrder}} | ::{{Attr|trainPartRef}} has to be used; the other attributes ({{Attr|startOcpRef}}, {{Attr|endOcpRef}}, {{Attr|begin}}, {{Attr|end}} and {{Attr|runLength}}) are redundant to the corresponding attributes of the respective {{TT:Tag|trainPart}} as defined within the {{rml}} file. The repetition of these attributes is optional; if they are repeated they have to be consistent. | ||
:* '''{{TT:Tag|blockPart}} without a reference to a {{TT:Tag|trainPart}}''' | |||
::*{{Attr|mission}}<nowiki>=</nowiki>{{enum|fullRun}} | |||
::*{{Attr|mission}}<nowiki>=</nowiki>{{enum|emptyRun}} | |||
::{{Attr|trainPartRef}} must not be used, {{Attr|startOcpRef}}, {{Attr|endOcpRef}}, {{Attr|begin}} and {{Attr|end}} have to be used. | |||
:* '''A duty which is not a run:''' | |||
::*{{Attr|mission}}<nowiki>=</nowiki>{{Enum|outOfOrder}} | |||
::*{{Attr|mission}}<nowiki>=</nowiki>{{Enum|fillIn}} | |||
::*{{Attr|mission}}<nowiki>=</nowiki>{{Enum|preheating}} | |||
::*{{Attr|mission}}<nowiki>=</nowiki>{{Enum|refuel}} | |||
::*{{Attr|mission}}<nowiki>=</nowiki>{{Enum|shunting}} | |||
::*{{Attr|mission}}<nowiki>=</nowiki>{{Enum|depotrun}} | |||
::*{{Attr|mission}}<nowiki>=</nowiki>{{Enum|standBy}} | |||
::*{{Attr|mission}}<nowiki>=</nowiki>{{Enum|cleaning}} | |||
::*{{Attr|mission}}<nowiki>=</nowiki>{{Enum|maintenance}} | |||
::*{{Attr|mission}}<nowiki>=</nowiki>{{Enum|inspection}} | |||
::{{Attr|trainPartRef}} must not be used, {{Attr|startOcpRef}}, {{Attr|endOcpRef}}, {{Attr|begin}} and {{Attr|end}} have to be used, {{Attr|startOcpRef}}<nowiki>=</nowiki>{{Attr|endOcpRef}} | |||
{{Deu|Es sind folgende Ausprägungen von blockPart vorgesehen:}} | {{Deu|Es sind folgende Ausprägungen von {{TT:Tag|blockPart}} vorgesehen:}} | ||
:* {{Deu|'''Fahrt als Referenz auf einen Zugteil''': {{Attr|mission}}<nowiki>=</nowiki>timetable | :* {{Deu|'''Fahrt ({{TT:Tag|blockPart}}) als Referenz auf einen Zugteil ({{TT:Tag|trainPart}})''':}} | ||
:* {{Deu|'''Fahrt ohne Referenz auf einen Zugteil''': {{Attr|mission}}<nowiki>=</nowiki>fullRun | ::*{{deu|{{Attr|mission}}<nowiki>=</nowiki>{{enum|timetable}}}} | ||
:* {{Deu|'''Dienst, der keine Fahrt ist''': | ::{{deu|{{Attr|trainPartRef}} ist anzugeben; die übrigen Attribute ({{Attr|startOcpRef}}, {{Attr|endOcpRef}}, {{Attr|begin}}, {{Attr|end}} und {{Attr|runLength}}) sind redundant zu den gleichbedeutenden Eigenschaften der Zugteile bei deren Definition in der {{rml}}-Datei. Das Wiederholen dieser Attribute ist optional; sofern sie wiederholt werden, müssen sie widerspruchsfrei sein.}} | ||
::* {{Deu|{{Attr|mission}}<nowiki>=</nowiki> | :* {{Deu|'''Fahrt ({{TT:Tag|blockPart}}) ohne Referenz auf einen Zugteil ({{TT:Tag|trainPart}})''': | ||
::* {{Deu|{{Attr|mission}}<nowiki>=</nowiki> | ::*{{deu|{{Attr|mission}}<nowiki>=</nowiki>{{enum|fullRun}}}} | ||
::* {{Deu|{{Attr|mission}}<nowiki>=</nowiki>standBy (Bereitschaftdienst)}} | ::*{{deu|{{Attr|mission}}<nowiki>=</nowiki>{{enum|emptyRun}}}} | ||
::* {{Deu|{{Attr|mission}}<nowiki>=</nowiki> | ::{{deu|{{Attr|trainPartRef}} darf nicht angegeben sein, {{Attr|startOcpRef}}, {{Attr|endOcpRef}}, {{Attr|begin}} und {{Attr|end}} müssen angegeben sein.}} | ||
::* {{ | :* {{Deu|'''Dienst, der keine Fahrt ist''':}} | ||
::*{{deu|{{Attr|mission}}<nowiki>=</nowiki>{{Enum|outOfOrder}}}} | |||
::*{{deu|{{Attr|mission}}<nowiki>=</nowiki>{{Enum|fillIn}}}} | |||
::* {{Deu|{{Attr|mission}}<nowiki>=</nowiki>{{Enum|preheating}} (Vorheizdienst)}} | |||
::* {{Deu|{{Attr|mission}}<nowiki>=</nowiki>{{Enum|refuel}} (Auffüllen von Vorräten, Tanken usw.)}} | |||
::* {{Deu|{{Attr|mission}}<nowiki>=</nowiki>{{Enum|shunting}} (Rangierdienst)}} | |||
::*{{deu|{{Attr|mission}}<nowiki>=</nowiki>{{Enum|depotrun}}}} | |||
::* {{Deu|{{Attr|mission}}<nowiki>=</nowiki>{{Enum|standBy}} (Bereitschaftdienst)}} | |||
::*{{deu|{{Attr|mission}}<nowiki>=</nowiki>{{Enum|cleaning}}}} | |||
::* {{Deu|{{Attr|mission}}<nowiki>=</nowiki>{{Enum|maintenance}} (Wartungsdienst)}} | |||
::*{{deu|{{Attr|mission}}<nowiki>=</nowiki>{{Enum|inspection}}}} | |||
::{{deu|{{Attr|trainPartRef}} darf nicht angegeben sein, {{Attr|startOcpRef}}, {{Attr|endOcpRef}}, {{Attr|begin}} und {{Attr|end}} müssen angegeben sein, {{Attr|startOcpRef}}<nowiki>=</nowiki>{{Attr|endOcpRef}}}} | |||
=== Further information === | === Further information === | ||
See {{external|http://www.irfp.de/download/railml_beispiel_umlauf.pdf|railML-Beispiel Umlauf aus FBS|type=PDF|lang=DE|comment=by Dirk Bräuer, iRFP Dresden|date=2012-05-23|visited=2018-03-26}} | See {{external|http://www.irfp.de/download/railml_beispiel_umlauf.pdf|railML-Beispiel Umlauf aus FBS|type=PDF|lang=DE|comment=by Dirk Bräuer, iRFP Dresden|date=2012-05-23|visited=2018-03-26}} |
Revision as of 18:06, 5 April 2018
{{ElementDocu| elementName = blockPart
|semantics = 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.
|parent = <blockParts>
|childs = <additionalName> (introduced with version 2.1), <xs:any> (introduced with version 2.1)
|inheritedAttributes =
- 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.
|ownAttributes =
|
- 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 / Vorheizen oder -kühlen
- refuel
- shunting / Rangieren
- depotrun
- standBy / Bereitschaft
- cleaning / Reinigung
- maintenance / Wartung
- inspection / Überprüfung
- 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.
- 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>.
|constraints =
- 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
- begin xs:time, optional
- beginDay xs:integer, optional, (introduced with version 2.2): default: 0
- end xs:time, optional
- endDay xs:integer, optional, (introduced with version 2.2): default: 0
- startOcpRef xs:IDREF, optional
- endOcpRef xs:IDREF, optional
- trainPartRef xs:IDREF, optional
- operatingPeriodRef xs:IDREF, optional
- mission union of (restriction of xs:string, tOtherEnumerationValue), where tOtherEnumerationValue is an arbitrary string starting with 'other:' followed by at minimum two characters, white space not allowed for extending railML® enumeration lists (pattern other:\w{2,}), optional
- fixed xs:boolean, optional
- runLength xs:decimal, 6 fraction digits, length value measured in kilometer, optional
- vehicleRef xs:IDREF, optional
- formationRef xs:IDREF, optional
|notes = 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.
|example =
mission
The following characteristics of <blockPart> are allowed:
-
- mission=timetable
- trainPartRef has to be used; the other attributes (startOcpRef, endOcpRef, begin, end and runLength) are redundant to the corresponding attributes of the respective <trainPart> as defined within the railML® file. The repetition of these attributes is optional; if they are repeated they have to be consistent.
- mission=fullRun
- mission=emptyRun
- trainPartRef must not be used, startOcpRef, endOcpRef, begin and end have to be used.
- A duty which is not a run:
- mission=outOfOrder
- mission=fillIn
- mission=preheating
- mission=refuel
- mission=shunting
- mission=depotrun
- mission=standBy
- mission=cleaning
- mission=maintenance
- mission=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:
-
- mission=timetable
- trainPartRef ist anzugeben; die übrigen Attribute (startOcpRef, endOcpRef, begin, end und 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.
- mission=fullRun
- mission=emptyRun
- trainPartRef darf nicht angegeben sein, startOcpRef, endOcpRef, begin und end müssen angegeben sein.
- Dienst, der keine Fahrt ist:
- mission=outOfOrder
- mission=fillIn
- mission=preheating (Vorheizdienst)
- mission=refuel (Auffüllen von Vorräten, Tanken usw.)
- mission=shunting (Rangierdienst)
- mission=depotrun
- mission=standBy (Bereitschaftdienst)
- mission=cleaning
- mission=maintenance (Wartungsdienst)
- mission=inspection
- trainPartRef darf nicht angegeben sein, startOcpRef, endOcpRef, begin und end müssen angegeben sein, startOcpRef=endOcpRef
Further information
See railML-Beispiel Umlauf aus FBS (external link, 2012-05-23, PDF, 🇩🇪, visited on 2018-03-26; by Dirk Bräuer, iRFP Dresden)