CO:state: Difference between revisions

From railML 3 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
No edit summary
m (→‎{{introduction}}: made a difference between <elementState> and <elementState> visible)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<!--Element '''{{{element}}}'''-->
<!--Element '''{{{element}}}'''-->
[[File:1.jpeg|thumb|200px|Sörnäinen Harbour was disestablished in November 2008 when Vuosaari Harbour was opened. The remains of Sörnäinen harbour rail could still be spotted in 2009, until the track was dismantled in 2009–2010 {{commons|Buffer_at_Sörnäinen_Harbour,_2009.jpg|Vestman|CC|BY|2.0}}]]
[[File:1.jpeg|thumb|200px|Sörnäinen Harbour was disestablished in November 2008 when Vuosaari Harbour was opened. The remains of Sörnäinen harbour rail could still be spotted in 2009, until the track was dismantled in 2009–2010 {{flickr|vestman/3515310818|BY|2.0}}]]
=={{introduction}}==
=={{introduction}}==
See https://wiki3.railml.org/wiki/Dev:Common_state_repository.
This element is used to describe the general state of the infrastructure, interlocking and rollingstock equipment and installations described in the document. This means that the state described here applies to all elements unless they describe a state different from this one as their element element state  ({{rml|3.2}} IS {{IS:Tag|elementState}}, {{rml|3.3}} CO {{CO:Tag|elementState}}). Unless specified otherwise using the child element {{GEN:Tag|validity}} the described state is not limited to a specific time but rather applies in general.
<br>
See also [[CO:elementState#Semantics]] for the guide.
<!--{{#ifeq:{{{comment}}}||{{missing information|topic=the semantics|user=<br>This template was inserted Automatically on import by [[user:Roboter]]}}|{{{comment}}}}}-->
<!--{{#ifeq:{{{comment}}}||{{missing information|topic=the semantics|user=<br>This template was inserted Automatically on import by [[user:Roboter]]}}|{{{comment}}}}}-->
{{ImportComment}}
{{ImportComment}}
=={{documentation}}==
=={{documentation}}==
==={{syntax}}===
==={{syntax}}===
Line 15: Line 18:
=={{Additional Information}}==
=={{Additional Information}}==
==={{Notes}}===
==={{Notes}}===
Two new state values were introduced in {{rml|3.3}}: {{enum|withdrawn}} and {{enum|dismantled}}. The new value {{enum|withdrawn}} is not covered by any of the values available in previous versions. When working with multiple versions of {{rml}}, this value can be given as {{enum|other:withdrawn}} in previous versions. The new value {{enum|dismantled}} is a subset of the old value {{enum|closed}}. When working with multiple versions of {{rml}} both {{enum|closed}} and {{enum|dismantled}} map to {{enum|closed}} in previous versions.
==={{Open issues}}===
==={{Open issues}}===

Latest revision as of 10:54, 23 April 2025

Sörnäinen Harbour was disestablished in November 2008 when Vuosaari Harbour was opened. The remains of Sörnäinen harbour rail could still be spotted in 2009, until the track was dismantled in 2009–2010 © CC-BY vestman (Source; Archive)

Introduction

This element is used to describe the general state of the infrastructure, interlocking and rollingstock equipment and installations described in the document. This means that the state described here applies to all elements unless they describe a state different from this one as their element element state (railML® 3.2 IS <elementState>, railML® 3.3 CO <elementState>). Unless specified otherwise using the child element <validity> the described state is not limited to a specific time but rather applies in general.
See also CO:elementState#Semantics for the guide.


Documentation

Syntax

Autoexport from the XML-Schema for element CO:state of railML® version 3.3
    
Documentation Use to specify states that apply for the whole document. States defined here must not overlap each other in time. If certain elements do not follow the global states defined here, these exceptions need to be specified at the level of the element with the diverging state (e.g. levelCrossingIS)
Subschema common
Parents*

states

Children

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

Attributes:
  • id: the identifier of the object; this can be either of type xs:ID or UUID (obligatory; xs:ID); compare: Dev:Identities,

  • value: Used to specify the state value. (obligatory; xs:string; patterns: other:w{2,}; consider Dev:UsingAny too.)
Possible values:
  • closed
  • conceptual
  • disabled
  • dismantled
  • operational
  • planned
  • withdrawn
*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 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 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

Best Practice / Examples

Additional Information

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.

Open Issues