Generic:bitmaskValidity

From railML 3 Wiki
Jump to navigation Jump to search

Introduction

Documentation

Syntax

Autoexport from the XML-Schema for element generic:bitmaskValidity of railML® version 3.2
Documentation A validity may be made up of a bitmask validity. This kind of validity is defined by an array of 0 and 1's, one for each day of its duration. A one encodes that an operation is going to take place on the day its slot represents, a zero encodes that it does not.
Subschema generic
Parents* validity
Children weekPatterns (0..1)
Attributes:
  • bitmask: This is a bit mask with 0 or 1 for every day of the timetablePeriod. A 0 indicates a non-operating day, while a 1 indicates an operating day.
    The first character corresponds with the first day of the bitmaskValidity indicated by the fromDate.
    The last character corresponds with the last day of the bitmaskValidity. The length of the bitmask specifies the number of days the enclosing validity describes. (obligatory; xs:string; patterns: [0-1]*),

  • fromDate: Specifies the first day when this validities bitmask is to be applied. (obligatory; xs:date),

  • timePeriodRef: Reference to the time period. (optional; xs:string; patterns: (urn:uuid:)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|{[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}})
*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:bitmaskValidity> 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:bitmaskValidity> that might have preceded it.

Semantics

Best Practice / Examples

Additional Information

Notes

In contrast to the operatingPeriod in railML 2 the <bitmaskValidity>'s bitmask does not necessarily span the whole length of the <timePeriod> referenced with @timePeriofRef. Instead the date described with the first bit of the bitmask is give with the attribute @fromDate. The last date described by the bitmask can be calculated by adding the length of the bitmask as number of days to the value of @fromDate. Any date that is not described with the bitmask, i.e. is before or after the dates described in the bitmask, is expected to be considered as if a 0 was given by reading software.

Open Issues