IS:state (with length): Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
No edit summary
(Added new attributes of railML 2.4.)
Line 3: Line 3:
|parent={{IS:Tag|states}}
|parent={{IS:Tag|states}}
|childs={{IS:Tag|from}}, {{IS:Tag|to}}
|childs={{IS:Tag|from}}, {{IS:Tag|to}}
|semantics=This is to define disabled/enabled infrastructure pieces with a given time frame for a certain length. The length can be specified via the children {{IS:Tag|from}} and {{IS:Tag|to}} (can be left away if the complete object is disabled; must not be used if the object is nonspacial, e.g. {{IS:Tag|levelCrossing}}). The time frame can, optionally, be expressed via {{Attr|operatingPeriodRef}}.
|semantics=This is to define disabled/enabled infrastructure pieces with a given time frame for a certain length. The length can be specified via the children {{IS:Tag|from}} and {{IS:Tag|to}} (can be left away if the complete object is disabled; must not be used if the object is nonspacial, e.g. {{IS:Tag|levelCrossing}}).  
 
For information on defining the time and duration of the 'state', see [[Dev:Defining temporal availability of infrastructure elements and speed profiles|Defining temporal availability of infrastructure elements and speed profiles]]
|inheritedAttributes=''None''
|inheritedAttributes=''None''
|ownAttributes=
|ownAttributes=
*{{Attr|disabled}}: This attribute is 'true' if the infrastructure piece is somehow disabled.
*{{Attr|disabled}}: This attribute is 'true' if the infrastructure piece is somehow disabled.
*{{Attr|operatingPeriodRef}}: The temporal frame of the 'state' should be defined in the 'timetable' part of the railML file, using the 'operatingPeriod' element.
*{{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.
*{{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.
*{{Attr|remarks}}: This is to further explain the 'state' definition.
|constraints=
|constraints=
*{{Attr|disabled}}: {{XsdType|boolean}}
*{{Attr|disabled}}: {{XsdType|boolean}}
*{{Attr|operatingPeriodRef}}: {{railMLType|tGenericRef}}
*{{Attr|operatingPeriodRef}}: {{railMLType|tGenericRef}}
*{{Attr|startTime}}: {{XsdType|time}}
*{{Attr|endTime}}: {{XsdType|time}}
*{{Attr|endDayOffset}}: {{XsdType|nonNegativeInteger}}
*{{Attr|remarks}}: {{railMLType|tElementDescription}}
*{{Attr|remarks}}: {{railMLType|tElementDescription}}
|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.}}
|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 08:18, 23 August 2018


IS:state
 


Scheme description / Schemenbeschreibung

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

Multiplicity / Anzahl

[1..1]

Semantics / Bedeutung

This is to define disabled/enabled infrastructure pieces with a given time frame for a certain length. The length can be specified via the children <from> and <to> (can be left away if the complete object is disabled; must not be used if the object is nonspacial, e.g. <levelCrossing>).

For information on defining the time and duration of the 'state', see Defining temporal availability of infrastructure elements and speed profiles

Attributes of IS:state / Attribute von IS:state

  • disabled: This attribute is 'true' if the infrastructure piece is somehow disabled.
  • 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.

Syntactic Constraints / Syntaktische Beschränkungen

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.