IS:state: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
(Ferri Leberl moved page IS:state to IS:state (with length): Konzeptänderung states)
 
(Konzeptänderung states)
Line 1: Line 1:
#REDIRECT [[IS:state (with length)]]
{{elementDocu
|elementName=IS:state
|parent={{IS:Tag|states}}
|semantics=This is to define disabled/enabled infrastructure pieces with a given time frame.
|inheritedAttributes=''None''
 
|ownAttributes=
*{{Attr|disabled}}: This attribute is 'true' if the infrastructure piece is somehow disabled.
*{{Attr|status}}: {{Intro|2.4}} defines the status of the infrastructure element from perspective of its availability<br>Possible values are:
:*{{enum|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.
:*{{enum|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.
:*{{enum|operational}}: The element is operational and can be used regularly.
:*{{enum|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.
:*{{enum|closed}}: The element is no longer available, removed, dismantled, or no longer exists. Planning, construction or commissioning activities are absolutely necessary for recommissioning.
:*{{OtherEnum}}
*{{Attr|operatingPeriodRef}}: The start date (or start dates if its a periodic state) should be defined in the 'timetable' part of the railML file, using the 'operatingPeriod' element.{{unlock|2.3|
*{{Attr|startTime}}: {{Intro|2.4}} The start time of the 'state'.
*{{Attr|endTime}}: {{Intro|2.4}} The end time of the 'state'.
*{{Attr|endDayOffset}}: {{Intro|2.4}} Duration of the 'state', counted in midnight overruns.}}
*{{Attr|remarks}}: This is to further explain the 'state' definition.{{human}}
 
|constraints=
*{{Attr|disabled}}: {{XsdType|boolean}}
*{{Attr|status}}: {{railMLType|tInfrastructureStatus}}
*{{Attr|operatingPeriodRef}}: {{railMLType|tGenericRef}}{{unlock|2.3|
*{{Attr|startTime}}: {{XsdType|time}}{{startEndDoc}}
*{{Attr|endTime}}: {{XsdType|time}}{{startEndDoc}}
*{{Attr|endDayOffset}}: {{XsdType|nonNegativeInteger}}}}
*{{Attr|remarks}}: {{railMLType|tElementDescription}}
|semcon={{startEndCon}}
|example=The {{IS:Tag|states}} element is optional. In case that no specific {{IS:Tag|state}} is defined for the parent infrastructure element this infrastructure element remains "valid" without any further constraints.<br>{{deu|Das {{IS:Tag|states}} Element ist optional. Für den Fall, dass kein expliziter {{IS:Tag|state}} für das übergeordnete Infrastruktur-Element angegeben ist existieren keine Einschränkungen hinsichtlich der Gültigkeit/Verfügbarkeit dieses Infrastruktur-Elements.}}
}}

Revision as of 16:23, 11 January 2019


IS:state
 


Scheme description / Schemenbeschreibung

Position of IS:state in the XML-Tree / Position von IS:state im XML-Baum

  • Parent: <states>
  • Children: Not yet described. / Noch nicht beschrieben.

Multiplicity / Anzahl

[1..1]

Semantics / Bedeutung

This is to define disabled/enabled infrastructure pieces with a given time frame.
 
Please, be aware of the semantic constraint(s)!

Attributes of IS:state / Attribute von IS:state

  • disabled: This attribute is 'true' if the infrastructure piece is somehow disabled.
  • status: (introduced with version 2.4) defines the status of the infrastructure element from perspective of its availability
    Possible values are:
  • 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.
  • 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.
  • operational: The element is operational and can be used regularly.
  • 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.
  • closed: The element is no longer available, removed, dismantled, or no longer exists. Planning, construction or commissioning activities are absolutely necessary for recommissioning.
  • other:anything: Any value that does not fit any value from the previous enumeration list, fulfilling the constraint: at minimum two characters, whitespace is not allowed. Please, apply Dev:usingAny accordingly.
  • operatingPeriodRef: The start date (or start dates if its a periodic state) should be defined in the 'timetable' part of the railML file, using the 'operatingPeriod' element.
  • startTime: (introduced with version 2.4) The start time of the 'state'.
  • endTime: (introduced with version 2.4) The end time of the 'state'.
  • endDayOffset: (introduced with version 2.4) Duration of the 'state', counted in midnight overruns.
  • remarks: This is to further explain the 'state' definition.
💡 Please take into account our references to human-intepretable data fields.

Bitte berücksichtigen Sie unsere Hinweise zu menschen-intepretierbaren Datenfeldern.

Syntactic Constraints / Syntaktische Beschränkungen

Semantic Constraints / Semantische Beschränkungen

Private-cloud-icon.png Semantic Constraint "TT:001":
 
Any starting time stamp (as it may result e.g. from a combination of startDate and startTime) shall be lower or equal any ending time stamp (e.g. endDate) if both are given. Must not overlap with other validity periods.
 
Proposed on November 12th 2018
Approved on March 21st 2019
FIXME: add Link to discussion!
Please, recognize our guidelines on semantic constraints

Best practice & Examples / Empfohlene Anwendung & Beispiele

The <states> element is optional. In case that no specific <state> is defined for the parent infrastructure element this infrastructure element remains "valid" without any further constraints.
Das <states> Element ist optional. Für den Fall, dass kein expliziter <state> für das übergeordnete Infrastruktur-Element angegeben ist existieren keine Einschränkungen hinsichtlich der Gültigkeit/Verfügbarkeit dieses Infrastruktur-Elements.

Notes / Anmerkungen

Not yet described. / Noch nicht beschrieben.

Open issues / Offene Punkte/Pendenzen

Not yet described. / Noch nicht beschrieben.