TT:operatingPeriodRef trainPart: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[unchecked revision][checked revision]
m (Template changed)
(multiplicity)
(16 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{elementDocu|
{{ElementDocu|
elementName = operatingPeriodRef
elementName = operatingPeriodRef


Line 5: Line 5:
The Element {{TT:Tag|operatingPeriodRef}} is used for referencing the {{TT:Doc|operatingPeriod}} for the {{TT:Doc|trainPart}}.  
The Element {{TT:Tag|operatingPeriodRef}} is used for referencing the {{TT:Doc|operatingPeriod}} for the {{TT:Doc|trainPart}}.  


{{deu|Das Element {{TT:Tag|operatingPeriodRef}} referenziert die zum {{TT:Doc|trainPart}} gehörige Verkehrsperiode.}}
{{Deu|Das Element {{TT:Tag|operatingPeriodRef}} referenziert die zum {{TT:Doc|trainPart}} gehörige Verkehrsperiode.}}


|parent = {{TT:Doc|trainPart}}
|parent = {{TT:Tag|trainPart}}


|childs = {{TT:Doc|specialService}}
|childs = {{TT:Tag|specialService|operatingPeriodRef}} {{depr|2.2}}
 
|minocc=0
|inheritedAttributes = see {{CO:Doc|tElementWithReference}}
|inheritedAttributes =
*{{attr|ref}}: references an {{TT:Doc|operatingPeriod}}.
{{InheritRefAny
|contextLink = {{TT:Tag|operatingPeriod}}
|ref =
|ref_de =
|anyAttribute =
|anyAttribute_de =
}}


|ownAttributes =
|ownAttributes =
*{{attr|startDate}}: 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}}: 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 =
* {{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 #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 22:02, 25 November 2018


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