Generic:weekPattern

From railML 3 Wiki
Jump to navigation Jump to search

Introduction

Documentation

Syntax

Autoexport from the XML-Schema for element Generic:weekPattern of railML® version 3.2
 
Documentation

A weekpattern describes the general pattern of operating days between a startDate and an endDate that is the base of the enclosing bitmask.
It is important to note that the weekPatterns provided here are not the leading information in terms validity. They are provided only in order to explain how the enclosing bitmask was constructed.

Subschema

generic

Parents*
Children

None

Attributes:

  • endDate: Last applicable date of the week pattern. It is expected to be within the duration described by the enclosing validity.
    If no endDate is provided it is assumed that the weekPattern applies until the end of the enclosing bitmaskValidity (optional; xs:date),

  • pattern: 7-character field with 0 or 1 for each day of the week, the first day of the week being a Monday. A 0 indicates a non-operating day, while a 1 indicates an operating day.
    Note that the specified startDate of the enclosing WeekPattern is not necessarily the first day of the 7 character field, nor is it necessarily the first 1 in the pattern. (obligatory; xs:string; length: 7; patterns: [0-1]{7}),

  • publicHolidayMode: Indicates how the enclosing validity operates in regards to public holidays. (optional; xs:string)
Possible values:
  • neverRunsOnHolidays: Indicates that the validity does not apply on all public holidays no matter if the specified pattern is marked with one for that day. Trains referencing a validity with this value set will not run on public holidays.
  • runsOnAllHolidays: Indicates that the validity applies on all public holidays. This means that no matter what is specified via the bitMask, the validity will apply and a train using this validity is scheduled to run.
  • runsOnIndicatedHolidays: Indicates that the validity applies even if a day is a public holiday.,

  • startDate: First applicable date of the week pattern. It is expected to be within the duration described by the enclosing validity.
    Note that the specified startDate of the enclosing WeekPattern is not necessarily the first day of the 7 character field, nor is it necessarily the first 1 in the pattern.
    If startDate is not provided it is assumed that the weekPattern applies from the start of the enclosing bitmaskValidity. (optional; xs:date)
*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 generic subschema. It is available only in railML® 3.2. There exists an element <CO:weekPattern> that might have preceded it. Do not hesitate to contact railML.org for further questions.


Changes 3.1→3.2

Introduced with version 3.2. There exists an element <CO:weekPattern> that might have preceded it.

Semantics

Best Practice / Examples

Additional Information

Notes

Open Issues