TT:commercialTrainSection: Difference between revisions

From railML 3 Wiki
Jump to navigation Jump to search
[unchecked revision][unchecked revision]
No edit summary
(Changed wording in accordance with results of discussion with developer group)
Line 9: Line 9:
==={{semantics}}===
==={{semantics}}===
{{importComment}}
{{importComment}}
{{semcon|An {{TT:Tag|commercialTrainVariant}} specified the trains path by its {{Attr|itineraryRef}}. Each {{TT:Tag|commercialTrainSection}} or a {{TT:Tag|commercialTrainVariant}} may specify via its {{TT:Tag|range|commercialTrainSection}} which part of the itinerary it represents. No {{TT:Tag|commercialTrainSection}} shall overlap with another of the same {{TT:Tag|commercialTrainVariant}} except for the baseItineraryPoint that connects it to another {{TT:Tag|commercialTrainSection}}.|status=proposed|proposed=2023-01-12|approved=|id=TT:006}}
{{semcon|The itinerary sections of a {{TT:Tag|commercialTrainVariant}}, defined by the {{TT:Tag|commercialTrainSection}}s and their respective {{TT:Tag|range}}s, that are not {{TT:Tag|isCancelled}} and not marked as {{TT:Tag|isOnRequest}}, must be pairwise disjoint, except for their respective first and last {{TT:Tag|baseItineraryPoint}}s.|status=proposed|proposed=2023-01-12|approved=|id=TT:006}}
{{semcon|The sum of all {{TT:Tag|commercialTrainSection}}'s of a {{TT:Tag|commercialTrainVariant}} shall cover the full itinerary referenced by the {{TT:Tag|commercialTrainVariant}}'s {{Attr|itineraryRef}} attribute.|status=proposed|proposed=2023-01-12|approved=|id=TT:007}}
{{semcon|The first(last) {{TT:Tag|baseItineraryPoint}} of each {{TT:Tag|commercialTrainSection}} within a {{TT:Tag|commercialTrainVariant}} must either be the referenced {{TT:Tag|itinerary}}'s first(last) {{TT:Tag|baseItineraryPoint}}, or coincide with another section's last(first) {{TT:Tag|baseItineraryPoint}}.|status=proposed|proposed=2023-01-12|approved=|id=TT:007}}
=={{examples}}==
=={{examples}}==
{{importComment}}
{{importComment}}

Revision as of 15:30, 7 March 2023

Introduction

Documentation

Syntax

Autoexport from the XML-Schema for element TT:commercialTrainSection of railML® version 3.2
Documentation The commercial train sections of a commercial train variant provide info about a part of the trains path.
Subschema timetable
Parents* commercialTrainVariant
Children additionalStopInfos (0..1), categoryRefs (0..1), freightFacilities (0..1), isCancelled (0..1), isOnRequest (0..1), passengerFacilities (0..1), range (0..1), transportServiceRef (0..1)
Attributes:
  • ordererRef: Reference to the organizational unit that ordered the train (optional; xs:string; patterns: (urn:uuid:)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|{[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}),

  • isEmpty: Trains marked with this flag are running empty and thus can be treated differently when rescheduling and dispatching. (optional; xs:boolean),

  • isPublic: Unless specified otherwise, all trains are considered public.
    Non-public trains, their schedules and other details must not be communicated to the open public. (optional; xs:boolean),

  • trainType: Allows classification of trains using an extendable enumeration. Mainly used to distinguish between passenger and freight trains. (optional; xs:string; patterns: other:w{2,})
Possible values:
  • EngineRun
  • Goods
  • Passenger,

  • id: unique identifier (obligatory; xs:string; patterns: (urn:uuid:)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|{[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}}); compare: Dev:Identities
*Notice:
Elements may have different parent elements. As a consequence they may be used in different contexts.
Please, consider this as well as a user of this wiki as when developing this documentation further.
Aspects that are only relevant with respect to one of several parents should be explained exclusively in the documentation of the respective parent element.

This element does not appear in railML® 3.1 within the TT subschema. It is available only in railML® 3.2. Do not hesitate to contact railML.org for further questions.


Changes 3.1→3.2

Introduced with version 3.2.

Semantics

Private-cloud-icon.png Proposed Semantic Constraint "TT:006":
 
The itinerary sections of a <commercialTrainVariant>, defined by the <commercialTrainSection>s and their respective <range>s, that are not <isCancelled> and not marked as <isOnRequest>, must be pairwise disjoint, except for their respective first and last <baseItineraryPoint>s.
 
Proposed on January 12th 2023
FIXME: add Link to discussion!
Please, recognize our guidelines on semantic constraints

Private-cloud-icon.png Proposed Semantic Constraint "TT:007":
 
The first(last) <baseItineraryPoint> of each <commercialTrainSection> within a <commercialTrainVariant> must either be the referenced <itinerary>'s first(last) <baseItineraryPoint>, or coincide with another section's last(first) <baseItineraryPoint>.
 
Proposed on January 12th 2023
FIXME: add Link to discussion!
Please, recognize our guidelines on semantic constraints

Best Practice / Examples

Additional Information

Notes

Open Issues