TT:operatingPeriodRef trainPart: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[unchecked revision][checked revision]
(Updated using new templates (Vorlage:InheritRef, Vorlage:RailMLType))
(16 intermediate revisions by 6 users not shown)
Line 9: Line 9:
|parent = {{TT:Tag|trainPart}}
|parent = {{TT:Tag|trainPart}}


|childs = {{TT:Tag|specialService}}
|childs = {{TT:Tag|specialService|operatingPeriodRef}} {{depr|2.2}}
 
|minocc=0
|inheritedAttributes =
|inheritedAttributes =
{{InheritRef
{{InheritRefAny
|attributeName = ref
|contextLink = {{TT:Tag|operatingPeriod}}
|contextLink = {{TT:Tag|operatingPeriod}}
|notes_en =  
|ref =
|ref_de =
|anyAttribute =
|anyAttribute_de =
}}
}}


|ownAttributes =
|ownAttributes =
* {{Attr|startDate}}: This describes optional further restrictions of the operating period. If not empty it has to be equal or later than the {{Attr|startDate}} of the referenced {{TT:Doc|timetablePeriod}}.
* {{Attr|startDate}} {{depr|2.2}}: This describes optional further restrictions of the operating period.{{StartEndDoc}}
 
* {{Attr|endDate}} {{depr|2.2}}: This describes optional further restrictions of the operating period.{{StartEndDoc}}
* {{Attr|endDate}}: This describes optional further restrictions of the operating period. If not empty it has to be equal or earlier than the {{Attr|endDate}} of the referenced {{TT:Doc|timetablePeriod}}.
 
|constraints =
|constraints =
* {{Attr|ref}} {{RailMLType|tGenericRef}}, mandatory
* {{Attr|ref}} {{RailMLType|tGenericRef}}, mandatory
* {{Attr|startDate}} {{XsdType|date}}, optional {{depr|2.2}}; shall be lower or equal {{Attr|endDate}} if both are used.
* {{Attr|endDate}} {{XsdType|date}}, optional {{depr|2.2}}; shall be higher or equal {{Attr|startDate}} if both are used.
|semcon={{startEndCon}}
|notes =
Child element {{TT:Doc|specialService|operatingPeriodRef}} is deprecated from railML 2.2 on. An individual {{TT:Doc|operatingPeriod}} for each {{TT:Doc|trainPart}} should be referenced instead. See TRAC ticket {{ticket|158}}.


|example =  
|example =  
Normal reference to the {{TT:Doc|operatingPeriod}} for 'daily':
Normal reference to the {{TT:Doc|operatingPeriod}} for 'daily':


* <rail:operatingPeriodRef ref="TGL"/>
<rail:operatingPeriodRef ref="TGL"/>


Same reference but restricted to certain period:
* See also
:# [[TT:Midnight_overrun | How to indicate midnight overruns in railML]]


* <rail:operatingPeriodRef ref="TGL" startDate="2009-10-05" endDate="2009-10-16"/>
* '''iRFP Dresden''': selection of examples for operationg periods in German
:# {{external|http://www.irfp.de/download/railml_beispiel_verkehrstage.pdf|iRFP-Informationen und -Beispiel zu Verkehrstagen in railML|lang=DE|comment=by Dirk Bräuer, iRFP Dresden|date=May 2012}}


|backHome = TT:elements
|backHome = TT:elements
}}
}}

Revision as of 13:52, 19 June 2020


operatingPeriodRef
 


Scheme description / Schemenbeschreibung

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

Multiplicity / Anzahl

[0..1]

Semantics / Bedeutung

The Element <operatingPeriodRef> is used for referencing the operatingPeriod for the trainPart.

Das Element <operatingPeriodRef> referenziert die zum trainPart gehörige Verkehrsperiode.
 
Please, be aware of the semantic constraint(s)!

Attributes of operatingPeriodRef / Attribute von operatingPeriodRef

  • ref: This refers to the id attribute of the associated <operatingPeriod> element.

Syntactic Constraints / Syntaktische Beschränkungen

  • ref xs:IDREF, mandatory
  • startDate xs:date, optional (deprecated with version 2.2); shall be lower or equal endDate if both are used.
  • endDate xs:date, optional (deprecated with version 2.2); shall be higher or equal startDate if both are used.

Semantic Constraints / Semantische Beschränkungen

Private-cloud-icon.png Semantic Constraint "TT:001":
 
Any starting time stamp (as it may result e.g. from a combination of startDate and startTime) shall be lower or equal any ending time stamp (e.g. endDate) if both are given. Must not overlap with other validity periods. See also https://wiki2.railml.org/wiki/Dev:Defining_temporal_availability_of_infrastructure_elements_and_speed_profiles
 
Proposed on November 12th 2018
Approved on March 21st 2019
FIXME: add Link to discussion!
Please, recognize our guidelines on semantic constraints

Best practice & Examples / Empfohlene Anwendung & Beispiele

Normal reference to the operatingPeriod for 'daily':

<rail:operatingPeriodRef ref="TGL"/>
  • See also
  1. How to indicate midnight overruns in railML
  • iRFP Dresden: selection of examples for operationg periods in German
  1. iRFP-Informationen und -Beispiel zu Verkehrstagen in railML (external link, May 2012, 🇩🇪; by Dirk Bräuer, iRFP Dresden)

Notes / Anmerkungen

Child element specialService is deprecated from railML 2.2 on. An individual operatingPeriod for each trainPart should be referenced instead. See TRAC ticket #158.

Open issues / Offene Punkte/Pendenzen

Not yet described. / Noch nicht beschrieben.