Generic:periodBitmask

Documentation

Syntax

Autoexport from the XML-Schema for element Generic:periodBitmask of railML® version 3.3
Description	This element is not documented in the schema!
Subschema	generic
Parents*	validity
Children	times (0..1), weekPatterns (0..1)
Attributes: bitmask: This is a bit mask with 0 or 1 for every day it describes. 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:IDREF)
*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.

Autoexport from the XML-Schema for element Generic:periodBitmask of railML® version 3.2
Description	This element is not documented in the schema!
Subschema	generic
Parents*	validityTime
Children	periodRule (1..1), weekPatterns (0..1)
Attributes: bitmask: This is a bit mask with 0 or 1 for every day it describes. 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, 3.3.
There exists an element <CO:periodBitmask> that might have preceded or replaced it. Do not hesitate to contact railML.org e.V. for further questions.

Changes 3.1→3.2

There exists an overview of all changes between railML^® 3.1 and railML^® 3.2 on page Dev:Changes/3.2.
Introduced with version 3.2. There exists an element <CO:periodBitmask> that might have preceded it.

Changes 3.2→3.3

There exists an overview of all changes between railML^® 3.2 and railML^® 3.3 on page Dev:Changes/3.3.

The parents have been changed.

The children have been changed.

The attributes have been changed.

Best Practice / Examples

     <levelCrossingIS id="lcr01" activation="infrastructureAutomatic">
       <elementState value="operational">
            <name name="levelCrossing in operation" language="en"/>
            <validity>
              <periodBitmask fromDate="2018-01-01" bitmask="1111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100111110011111001111100">
                <times>
                  <period from="06:00:00" to="22:00:00"/>
                </times>
              </periodBitmask>
            </validity>
          </elementState>
       </levelCrossingIS>

Level crossing is in state “operational”. State “operational”:

• begins 2018-01-01;
• has duration 364 days (string in @bitmask attribute has 364 digits);
• Within 364 days, the ones, encoded with 0 in @bitmask, are non-operational. For example:
  • 2018-01-01 is operational;
  • 2018-01-06 is non-operational;
• During operational days (e.g. 2018-01-01) level crossing is operational only from 06:00 till 22:00.

Please refer to <elementState> and Dev:Defining temporal availability of infrastructure elements and speed profiles for additional examples.