IS:uptime: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
(fixes)
(added semantics of @mode)
 
(5 intermediate revisions by 3 users not shown)
Line 9: Line 9:
|semantics =
|semantics =
The element {{IS:Tag|uptime}} defines daytime constraints for the current {{IS:Doc|ocp}}.
The element {{IS:Tag|uptime}} defines daytime constraints for the current {{IS:Doc|ocp}}.
|ownAttributes =
|ownAttributes =
* {{Attr|from}}
* {{Attr|from}} is the start time for the given {{Attr|mode}}. When referring to midnight at the beginning of the day, please use "00:00:00".
 
* {{Attr|until}} is the end time for the given {{Attr|mode}}. When referring to midnight at the end of the day, please use "24:00:00".
* {{Attr|until}}
* {{Attr|mode}} extension of <state> to specify staff and temporary disabling. Possible values are:
 
* {{Attr|mode}} Possible values are:
:* {{Enum|manned}}: The {{tag|IS|ocp}} is operational/usable and staffed with IM's personnel ready for operation on site (in the area of the {{tag|IS|ocp}}).
:* {{Enum|manned}}: The {{tag|IS|ocp}} is operational/usable and staffed with IM's personnel ready for operation on site (in the area of the {{tag|IS|ocp}}).
:* {{Enum|unmanned}}: The {{tag|IS|ocp}} is operational/usable and not staffed with on site personnel by the IM. Even if the {{tag|IS|ocp}} is not controlled or is remote controlled by any staff of the IM and there is no staff of the IM available in the area of the {{tag|IS|ocp}}.
:* {{Enum|unmanned}}: The {{tag|IS|ocp}} is operational/usable and not staffed with on site personnel by the IM. Even if the {{tag|IS|ocp}} is not controlled or is remote controlled by any staff of the IM and there is no staff of the IM available in the area of the {{tag|IS|ocp}}.
:* {{Enum|off}}: The {{tag|IS|ocp}} is temporarily not operational/usable. No information about local staff is given by this value. Please note that a long-term non-defined or permanent disabling of an {{tag|IS|ocp}} will be expressed via {{tag|IS|ocp}}{{tag|IS|propOther}}{{tag|IS|state|@=status}}=''{disabled&#124;closed}''.
:* {{Enum|off}}: The {{tag|IS|ocp}} is temporarily not operational/usable. No information about local staff is given by this value.
'''Please note that a long-term non-defined or permanent disabling of an {{tag|IS|ocp}} will be expressed via {{tag|IS|ocp}}{{tag|IS|propOther}}{{tag|IS|state|@=status}}=''{disabled&#124;closed}''.'''
:* {{OtherEnum
:* {{OtherEnum
|notes_en =
|notes_en =
|notes_de =
|notes_de =
}}
}}
 
* {{attr|operatingPeriodRef}}: {{intro|2.5}} reference to the operating period defined in the timetable part
 
* {{attr|endDayOffset}}: {{intro|2.5}} define an offset greater than 0 if the end of the time span is not on the same day like the begin of the time span
|constraints =
|constraints =
* {{Attr|from}}: {{XsdType|time}}, mandatory
* {{Attr|from}}: {{XsdType|time}}, mandatory
* {{Attr|until}}: {{XsdType|time}}, mandatory
* {{Attr|until}}: {{XsdType|time}}, mandatory
* {{Attr|mode}}: {{railMLType|tOcpManMode}}; mandatory
* {{Attr|mode}}: {{railMLType|tOcpManMode}}; mandatory
 
* {{constraint|operatingPeriodRef|rml|tGenericRef}}
* {{constraint|endDayOffset|xsd|nonNegativeInteger}}
|backHome = IS:elements
|backHome = IS:elements
|semcon=
|semcon=
Line 38: Line 35:
{{semcon|status=proposed|proposed=2020-02-28|id=IS:009|1=An {{Tag|IS|ocp}} with attribute {{Tag|IS|propOperational|@=operationalType}}=''stoppingPoint'' shall not have {{@|mode}}=''manned'' (as a ''stoppingPoint'' has no operational usage and therefore no operational staff by the IM).}}
{{semcon|status=proposed|proposed=2020-02-28|id=IS:009|1=An {{Tag|IS|ocp}} with attribute {{Tag|IS|propOperational|@=operationalType}}=''stoppingPoint'' shall not have {{@|mode}}=''manned'' (as a ''stoppingPoint'' has no operational usage and therefore no operational staff by the IM).}}
{{semcon|status=proposed|proposed=2020-02-28|id=IS:010|1=An enumeration of several time periods by {{@|from}} and {{@|until}} for one {{Tag|IS|ocp}} shall not overlap so that for every time there shall be a unique status of {{Tag|IS|uptime}}.}}
{{semcon|status=proposed|proposed=2020-02-28|id=IS:010|1=An enumeration of several time periods by {{@|from}} and {{@|until}} for one {{Tag|IS|ocp}} shall not overlap so that for every time there shall be a unique status of {{Tag|IS|uptime}}.}}
|example=As {{Attr|from}} and {{Attr|until}} are mandatory, a {{Attr|mode}} for the whole day must be specified <code>from="00:00:00" until="24:00:00"</code>.
}}
}}

Latest revision as of 10:27, 21 March 2023


uptime
 


Scheme description / Schemenbeschreibung

Position of uptime in the XML-Tree / Position von uptime im XML-Baum

Multiplicity / Anzahl

[0..∞]

Semantics / Bedeutung

The element <uptime> defines daytime constraints for the current ocp.
 
Please, be aware of the semantic constraint(s)!

Attributes of uptime / Attribute von uptime

  • from is the start time for the given mode. When referring to midnight at the beginning of the day, please use "00:00:00".
  • until is the end time for the given mode. When referring to midnight at the end of the day, please use "24:00:00".
  • mode extension of <state> to specify staff and temporary disabling. Possible values are:
  • manned: The <ocp> is operational/usable and staffed with IM's personnel ready for operation on site (in the area of the <ocp>).
  • unmanned: The <ocp> is operational/usable and not staffed with on site personnel by the IM. Even if the <ocp> is not controlled or is remote controlled by any staff of the IM and there is no staff of the IM available in the area of the <ocp>.
  • off: The <ocp> is temporarily not operational/usable. No information about local staff is given by this value.

Please note that a long-term non-defined or permanent disabling of an <ocp> will be expressed via <ocp><propOther><state>@status={disabled|closed}.

  • 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: (introduced with version 2.5) reference to the operating period defined in the timetable part
  • endDayOffset: (introduced with version 2.5) define an offset greater than 0 if the end of the time span is not on the same day like the begin of the time span

Syntactic Constraints / Syntaktische Beschränkungen

  • from: xs:time, mandatory
  • until: xs:time, mandatory
  • mode: union of (restriction of xs:string, tOtherEnumerationValue); tOtherEnumerationValue is an arbitrary string starting with 'other:' followed by at minimum two characters, white space not allowed for extending railML® enumeration lists; mandatory
  • operatingPeriodRef: tGenericRef (xs:IDREF); optional
  • endDayOffset: xs:nonNegativeInteger; optional

Semantic Constraints / Semantische Beschränkungen

Private-cloud-icon.png Proposed Semantic Constraint "IS:008":
 
An <ocp> with <propOperational>@operationalType=blockSignal shall not have @mode=manned (as a manned blockSignal shall be modelled in railML® 2.x as a blockPost).
 
Proposed on February 28th 2020
FIXME: add Link to discussion!
Please, recognize our guidelines on semantic constraints

Private-cloud-icon.png Proposed Semantic Constraint "IS:009":
 
An <ocp> with attribute <propOperational>@operationalType=stoppingPoint shall not have @mode=manned (as a stoppingPoint has no operational usage and therefore no operational staff by the IM).
 
Proposed on February 28th 2020
FIXME: add Link to discussion!
Please, recognize our guidelines on semantic constraints

Private-cloud-icon.png Proposed Semantic Constraint "IS:010":
 
An enumeration of several time periods by @from and @until for one <ocp> shall not overlap so that for every time there shall be a unique status of <uptime>.
 
Proposed on February 28th 2020
FIXME: add Link to discussion!
Please, recognize our guidelines on semantic constraints

Best practice & Examples / Empfohlene Anwendung & Beispiele

As from and until are mandatory, a mode for the whole day must be specified from="00:00:00" until="24:00:00".

Notes / Anmerkungen

Not yet described. / Noch nicht beschrieben.

Open issues / Offene Punkte/Pendenzen

Not yet described. / Noch nicht beschrieben.

Retrieved from "https://wiki2.railml.org/index.php?title=IS:uptime&oldid=14648"