TT:operatingDay: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[unchecked revision][checked revision]
No edit summary
(multiplicity)
(13 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{elementDocu|
{{ElementDocu|
elementName = operatingDay
elementName = operatingDay
|semantics =
|semantics =
The Element {{TT:Doc|operatingDay}} gives a week based abstract description of an operating period for a normal day. Variations for certain types of days (e.g. public holidays) are dealt with in {{TT:Doc|operatingDayDeviance}}. Two different elements {{TT:Doc|operatingDay}} are valid at the same time. Therefore the {{attr|startDate}} and {{attr|endDate}} should be used to delimit different period parts.  
The Element {{TT:Tag|operatingDay}} gives a week based abstract description of an operating period for a normal day. Variations for certain types of days (e.g. public holidays) are dealt with in {{TT:Doc|operatingDayDeviance}}. Two different elements {{TT:Tag|operatingDay}} are valid at the same time. Therefore the {{Attr|startDate}} and {{Attr|endDate}} must be used to delimit different period parts.  


{{deu|Das Element {{TT:Doc|operatingDay}} gibt eine wochenbasierte Beschreibung der Verkehrsperiode für normale Tage. Besondere Tagestypen wie Feiertage werden im Unterelement {{TT:Doc|operatingDayDeviance}} behandelt. Zwei unterschiedliche Elemente {{TT:Doc|operatingDay}} gelten dabei gleichberechtigt. Sie sollten daher über {{attr|startDate}} und {{attr|endDate}} zeitlich nicht überlappend voneinander abgegrenzt werden.}}
{{Deu|Das Element {{TT:Tag|operatingDay}} gibt eine wochenbasierte Beschreibung der Verkehrsperiode für normale Tage. Besondere Tagestypen wie Feiertage werden im Unterelement {{TT:Tag|operatingDayDeviance}} behandelt. Zwei unterschiedliche Elemente {{TT:Tag|operatingDay}} gelten dabei gleichberechtigt. Sie müssen daher über {{Attr|startDate}} und {{Attr|endDate}} zeitlich nicht überlappend voneinander abgegrenzt werden.}}


|parent = {{TT:Doc|operatingPeriod}}
|parent = {{TT:Tag|operatingPeriod}}
 
|childs = {{TT:Doc|operatingDayDeviance}}


|childs = {{TT:Tag|operatingDayDeviance}}, {{any}} {{intro|2.3}}
|minocc=0
|maxocc=∞
|inheritedAttributes
|inheritedAttributes


|ownAttributes =  
|ownAttributes =  


*{{attr|operatingCode}}: a 7-digit bitmask (0/1) for the days of a normal week, Monday to Sunday ({{xsdType|string}}, required)
*{{Attr|operatingCode}}: a 7-digit bitmask (0/1) for the days of a normal week, Monday to Sunday
*{{attr|onRequest}}: needed for "runs Monday to Friday and additionally Sunday on request" ({{xsdType|boolean}}, optional).
*{{Attr|onRequest}}: needed for "runs Monday to Friday and additionally Sunday on request"
*{{attr|startDate}}: could be used to reduce the considered period ({{xsdType|date}}, optional).
*{{Attr|startDate}}: can be used to reduce the considered period{{StartEndDoc}}
*{{attr|endDate}}: could be used to reduce the considered period ({{xsdType|date}}, optional).
*{{Attr|endDate}}: can be used to reduce the considered period{{StartEndDoc}}
{{InheritAnyAttribute
|comment={{intro|2.3}}
|anyAttribute =
|anyAttribute_de =
}}


|constraints =
*{{Attr|operatingCode}} {{xsdType|string}}, mandatory
*{{Attr|onRequest}} {{xsdType|boolean}}, optional
*{{Attr|startDate}} {{xsdType|date}}, optional; shall be lower or equal {{Attr|endDate}} if both are used.
*{{Attr|endDate}} {{xsdType|date}}, optional; shall be higher or equal {{Attr|startDate}} if both are used.
|semcon={{startEndCon}}
|example =
|example =
Train is driving Monday to Saturday:
Train is operating Monday to Saturday (with no exception on public holidays):
   <rail:operatingPeriod id="op16" description="Monday - Saturday">
   <rail:operatingPeriod id="op16" description="Monday - Saturday">
  <rail:operatingDay operatingCode="1111110"/>
    <rail:operatingDay operatingCode="1111110"/>
   </rail:operatingPeriod>
   </rail:operatingPeriod>
see also the example of the {{rml}} {{site|http://www.railml.org/en/introduction/partners.html|developing partner}} iRFP:
* {{external|http://www.irfp.de/download/railml_beispiel_verkehrstage.pdf|Weitere Informationen und {{rml}}-Beispiel zu Verkehrstagen|type=PDF|comment=by Dirk Bräuer, iRFP Dresden|date=2012-05-23|visited=2018-03-26|lang=DE}}


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

Revision as of 22:29, 25 November 2018


operatingDay
 


Scheme description / Schemenbeschreibung

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

Multiplicity / Anzahl

[0..∞]

Semantics / Bedeutung

The Element <operatingDay> gives a week based abstract description of an operating period for a normal day. Variations for certain types of days (e.g. public holidays) are dealt with in operatingDayDeviance. Two different elements <operatingDay> are valid at the same time. Therefore the startDate and endDate must be used to delimit different period parts.

Das Element <operatingDay> gibt eine wochenbasierte Beschreibung der Verkehrsperiode für normale Tage. Besondere Tagestypen wie Feiertage werden im Unterelement <operatingDayDeviance> behandelt. Zwei unterschiedliche Elemente <operatingDay> gelten dabei gleichberechtigt. Sie müssen daher über startDate und endDate zeitlich nicht überlappend voneinander abgegrenzt werden.
 
Please, be aware of the semantic constraint(s)!

Attributes of operatingDay / Attribute von operatingDay

  • operatingCode: a 7-digit bitmask (0/1) for the days of a normal week, Monday to Sunday
  • onRequest: needed for "runs Monday to Friday and additionally Sunday on request"
  • startDate: can be used to reduce the considered period Please, recognize the semantic constraint.
  • endDate: can be used to reduce the considered period Please, recognize the semantic constraint.
  • 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

  • operatingCode xs:string, mandatory
  • onRequest xs:boolean, optional
  • 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. 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

Train is operating Monday to Saturday (with no exception on public holidays):

 <rail:operatingPeriod id="op16" description="Monday - Saturday">
   <rail:operatingDay operatingCode="1111110"/>
 </rail:operatingPeriod>

see also the example of the railML® developing partner (link to the railML® website) iRFP:

Notes / Anmerkungen

Not yet described. / Noch nicht beschrieben.

Open issues / Offene Punkte/Pendenzen

Not yet described. / Noch nicht beschrieben.