CO:elementState

From railML 3 Wiki
Jump to navigation Jump to search

Introduction

Consider also an other German example of an invalid signal (external link).

Documentation

Syntax

Autoexport from the XML-Schema for element CO:elementState of railML® version 3.3
    
Documentation Allows specifying states deviating from the ones specified under //common/states. This is useful for defining elements that will be put into or out of operation while other parts of the resources described in this document stay in the same state, e.g. construction of a new bridge or level crossing.
Subschema common
Parents*

aspectRelation, assetsForInterlocking, balise, baliseGroup, border, bufferStop, combinedRoute, conflictingRoute, controller, controlsInterface, crossing, crossingInPosition, dangerArea, dangerPoint, derailerIL, derailerIS, derailerInPosition, destinationPoint, detector, detectorInState, electrificationSection, emergencyStopArea, endOfTrack, etcsArea, etcsLevelTransition, formation, genericArea, genericDetector, hasAspect, hasDetectorTypes, hasElementGroupType, hasHmiIndication, hasLevelCrossingType, hasOperatorCommand, hasRouteType, hasSignalLamp, hasTVDresetStrategy, implementsElementGroup, interface, key, keyLockIL, keyLockIS, keyLockInState, levelCrossingIL, levelCrossingIS, levelCrossingInState, line, linesideElectronicUnitIL, linesideElectronicUnitIS, loadingGauge, localOperationArea, loop, mileageChange, movableBridge, movableCrossing, objectController, operationalPoint, overCrossing, overlap, overlapRelease, permissionZone, platform, platformEdge, powerSupplyIL, radioBlockCentre, radioBlockCentreBorder, restrictionArea, route, routeActivationSection, routeEntry, routeExit, routeRelation, routeReleaseGroupAhead, routeReleaseGroupRear, routeSequence, routeStatusIndicator, serviceSection, shuntingZone, signalBox, signalIL, signalIS, signalIndicator, signalWithAspect, specificInfrastructureManager, speedSection, stationIndicator, stoppingPlace, switchIL, switchIS, switchInPosition, track, trackBed, trackGauge, trackIL, trainDetectionElement, trainNumberField, trainProtectionElement, trainRadio, tunnelGateIL, tunnelGateIS, tvdSection, underCrossing, vehicle, vehiclePart, weightLimit, workZone

Children

name (0..*), validity (0..*)

Attributes:
Possible values:
  • closed: The element is no longer available for operation. Usually a planning phase is needed before reopening the element for operation again. Otherwise a closed element could also be dismantled.
  • conceptual: The construction or commissioning of the element is planned for the medium or long term. However, there are still no concrete (planning) activities for the construction of the element beyond the preliminary planning and cost estimation.
  • disabled: The element is currently not usable, switched off or deactivated and therefore cannot be used regularly. However, it can be put back into operation at short notice without further construction, acceptance or approval activities.
  • dismantled: The element has been dismantled and is no longer available for use. In order to get it back into operation, planning needs to be conducted again.
  • operational: The element is operational and can be used regularly.
  • planned: The construction or commissioning of the element is planned concretely and at short notice or concrete planning activities for the construction take place, e.g. design, approval or implementation planning, cost calculation, award of contracts. It is not normally possible to use the element.
  • withdrawn: Planning for the element was withdrawn without building it. Planning could continue at any time in the future. It is not possible to use the element (in this configuration) for operation.
*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.2 within the CO subschema. It is available only in railML® 3.3. Do not hesitate to contact railML.org e.V. for further questions.
This element does not appear in railML® 3.1 within the CO subschema. It is available only in railML® 3.3. Do not hesitate to contact railML.org e.V. for further questions.


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.
Introduced with version 3.3.

Semantics

Timeline.svg This content is only valid for version(s) 3.3  


Best Practice / Examples



<?xml version="1.0" encoding="UTF-8"?><railML xmlns="https://www.railml.org/schemas/3.3" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:gml4rail3="https://www.railml.org/schemas/3.3/gml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="3.3" xsi:schemaLocation="https://www.railml.org/schemas/3.3 https://www.railml.org/schemas/3.3/railml3.xsd">
  <common id="co1">
    <states>
      <state id="st01" value="operational">
        <name language="en" name="Operational 2024"/>
        <validity>
          <period from="2024-01-01T00:00:00Z" to="2024-12-31T09:00:00"/>
        </validity>
      </state>
      <state id="st02" value="operational">
        <name language="en" name="Operational 2025"/>
        <validity>
          <period from="2025-01-01T00:00:00Z" to="2025-12-31T09:00:00"/>
        </validity>
      </state>
    </states>
  </common>
  <infrastructure id="is01">
    <functionalInfrastructure>
      <tracks>
        <track id="t01">
          <designator entry="XXX1" register="_nrv"/>
        </track>
        <track id="t02">
          <designator entry="XXX2" register="_nrv"/>
        </track>
        <track id="t03">
          <designator entry="XXX3" register="_nrv"/>
          <elementState value="disabled">
            <name language="en" name="Construction May24"/>
            <validity>
              <period from="2024-05-10T02:00:00Z" to="2024-05-15T22:00:00Z"/>
            </validity>
            <validity>
              <period from="2024-05-18T02:00:00Z" to="2024-05-19T22:00:00Z"/>
            </validity>
          </elementState>
        </track>
        <track id="t04">
          <designator entry="XXX4" register="_nrv"/>
          <elementState value="closed">
            <name language="en" name="Track closure for dismanteling"/>
            <validity>
              <period from="2025-08-20T00:00:00Z" to="2025-08-31T09:00:00"/>
            </validity>
          </elementState>
          <elementState value="dismantled">
            <validity>
              <period from="2025-09-01T00:00:00Z" /> <!--no end date is known-->
            </validity>
          </elementState>
        </track>
        <track id="t05">
          <designator entry="XXX5" register="_nrv"/>
        </track>
        <track id="t06">
          <designator entry="XXX6" register="_nrv"/>
          <elementState value="planned">
            <name language="en" name="New track planned to be operational q3 of 2025"/>
            <validity>
              <period from="2024-01-01T00:00:00Z" to="2025-12-31T09:00:00"/>
            </validity>
          </elementState>
          <elementState value="planned">
            <name language="en" name="New track planned to be operational q3 of 2025"/>
            <validity>
              <period from="2025-01-01T00:00:00Z" to="2025-08-31T09:00:00"/>
            </validity>
          </elementState>
          <!--no need to specify the rest of the year as it is in line with the common state-->
        </track>
      </tracks>
    </functionalInfrastructure>
  </infrastructure>
  <rollingstock>
    <vehicles>
      <vehicle id="v01">
        <designator entry="1234-5678-1X" register="_BN"/>
      </vehicle>
      <vehicle id="v02">
        <designator entry="1234-5678-2X" register="_BN"/>
      </vehicle>
      <vehicle id="v03">
        <designator entry="1234-5678-3X" register="_BN"/>
      </vehicle>
      <vehicle id="v04">
        <designator entry="1234-5678-4X" register="_BN"/>
      </vehicle>
      <vehicle id="v05">
        <designator entry="1234-5678-5X" register="_BN"/>
        <elementState value="dismantled"/> 
          <validity>
            <period from="2025-01-01T00:00:00Z"/>
          </validity><!--dismantled for year 2025 -->
      </vehicle>
      <vehicle id="v06">
        <designator entry="1234-5678-6X" register="_BN"/>
      </vehicle>
    </vehicles>
  </rollingstock>
</railML>


Notes

Two new state values were introduced in railML® 3.3: withdrawn and dismantled. The new value withdrawn is not covered by any of the values available in previous versions. When working with multiple versions of railML®, this value can be given as other:withdrawn in previous versions. The new value dismantled is a subset of the old value closed. When working with multiple versions of railML® both closed and dismantled map to closed in previous versions.

Additional Information

🗒️ This segment provides background information that is not relevant for the certification process.  


Further information

For context see corresponding:

Open Issues

References