TT:specialService operatingPeriodRef: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
No edit summary
(|semcon={{startEndCon}})
(7 intermediate revisions by 2 users not shown)
Line 2: Line 2:
elementName = specialService
elementName = specialService


|semantics =
|semantics ={{depr|2.2}} — use reference to individual operating period instead.<br>&nbsp;<br>
The Element {{TT:Tag|specialService|operatingPeriodRef}} describes a calendar based modification of the {{TT:Doc|operatingPeriod}} by including or excluding certain days or periods. The maximal duration of the underlying {{TT:Doc|timetablePeriod}} and {{TT:Doc|operatingPeriod}} may not be expanded with a this {{TT:Tag|specialService|operatingPeriodRef}}. {{AddAnn|| }}
The Element {{TT:Tag|specialService|operatingPeriodRef}} describes a calendar based modification of the {{TT:Doc|operatingPeriod}} by including or excluding certain days or periods. The maximal duration of the underlying {{TT:Doc|timetablePeriod}} and {{TT:Doc|operatingPeriod}} may not be expanded with a this {{TT:Tag|specialService|operatingPeriodRef}}. {{AddAnn|| }}


Line 12: Line 12:
|ownAttributes =
|ownAttributes =
* {{Attr|type}}: It has to follow the constraints of {{XsdType|string}}. {{AddAnn|| }} Possible values are:
* {{Attr|type}}: It has to follow the constraints of {{XsdType|string}}. {{AddAnn|| }} Possible values are:
{{missing information|user=[[User:Ferri Leberl|Ferri Leberl]] ([[User talk:Ferri Leberl|talk]]) 16:14, 25 April 2018 (CEST)|topic=the semantics of the enumeration items}}
:* {{Enum|include}}
:* {{Enum|include}}
:* {{Enum|exclude}}
:* {{Enum|exclude}}


* {{Attr|singleDate}}: This is used to include or exclude a single day. {{AddAnn|| }}
* {{Attr|singleDate}}: This is used to include or exclude a single day. {{AddAnn|| }}
 
* {{Attr|startDate}}: This is used to include or exclude a time period. {{AddAnn|| }}{{StartEndDoc}}
* {{Attr|startDate}}: This is used to include or exclude a time period. {{AddAnn|| }}
* {{Attr|endDate}}: This is used to include or exclude a time period. {{AddAnn|| }}{{StartEndDoc}}
 
* {{Attr|startTime}}: {{depr|2.4}} This is used for a more detailed description of the time period. {{AddAnn|| }}
* {{Attr|endDate}}: This is used to include or exclude a time period. {{AddAnn|| }}
* {{Attr|endTime}}: {{depr|2.4}} This is used for a more detailed description of the time period. {{AddAnn|| }}
 
* {{Attr|startTime}}: This is used for a more detailed description of the time period. {{AddAnn|| }}
 
* {{Attr|endTime}}: This is used for a more detailed description of the time period. {{AddAnn|| }}
 
{{InheritAnyAttribute
{{InheritAnyAttribute
|comment={{intro|2.3}}
|comment={{intro|2.3}}
Line 36: Line 32:
* {{Attr|singleDate}} {{XsdType|date}}, optional
* {{Attr|singleDate}} {{XsdType|date}}, optional


* {{Attr|startDate}} {{XsdType|date}}, optional
* {{Attr|startDate}} {{XsdType|date}}, optional; shall be lower or equal {{Attr|endDate}} if both are used.


* {{Attr|endDate}} {{XsdType|date}}, optional
* {{Attr|endDate}} {{XsdType|date}}, optional; shall be higher or equal {{Attr|startDate}} if both are used.


* {{Attr|startTime}} {{XsdType|time}}, optional
* {{Attr|startTime}} {{XsdType|time}}, optional
Line 45: Line 41:
   
   
{{AddAnn|| }}
{{AddAnn|| }}
 
|semcon={{startEndCon}}
|example =  
|example =  
<specialService type="include" singleDate="2009-12-24"/>
<specialService type="include" singleDate="2009-12-24"/>

Revision as of 13:45, 12 November 2018


specialService
 


Scheme description / Schemenbeschreibung

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

Multiplicity / Anzahl

[1..1]

Semantics / Bedeutung

(deprecated with version 2.2) — use reference to individual operating period instead.
 
The Element <specialService> describes a calendar based modification of the operatingPeriod by including or excluding certain days or periods. The maximal duration of the underlying timetablePeriod and operatingPeriod may not be expanded with a this <specialService>.

Das Element <specialService> beschreibt die auf einen Kalender bezogene Modifizierung einer Verkehrsperiode operatingPeriod um einzelne Zusatz- und/oder Ausfalltage oder auch Zusatz- und/oder Ausfallperioden. Die maximale Dauer der zugrundeliegenden Fahrplanperiode timetablePeriod beziehungsweise der darauf basierenden Verkehrsperiode operatingPeriod darf dabei aber nicht erweitert werden.
 
Please, be aware of the semantic constraint(s)!

Attributes of specialService / Attribute von specialService

  • type: It has to follow the constraints of xs:string. Possible values are:

Missinginformation.png In this article there is information missing with respect to the semantics of the enumeration items. Please help improving the railML® wiki by filling the gaps. Possibly, you will find further details on the discussion pageFerri Leberl (talk) 16:14, 25 April 2018 (CEST)
  • include
  • exclude
  • singleDate: This is used to include or exclude a single day.
  • startDate: This is used to include or exclude a time period. Please, recognize the semantic constraint.
  • endDate: This is used to include or exclude a time period. Please, recognize the semantic constraint.
  • startTime: (deprecated with version 2.4) This is used for a more detailed description of the time period.
  • endTime: (deprecated with version 2.4) This is used for a more detailed description of the time period.
  • xs:anyAttribute(introduced with version 2.3) This provides an extension point for non-railML® attributes in a foreign namespace. How to use it?

Syntactic Constraints / Syntaktische Beschränkungen

  • startDate xs:date, optional; shall be lower or equal endDate if both are used.
  • endDate xs:date, optional; 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

<specialService type="include" singleDate="2009-12-24"/>

Notes / Anmerkungen

Not yet described. / Noch nicht beschrieben.

Open issues / Offene Punkte/Pendenzen

Not yet described. / Noch nicht beschrieben.