IS:designator impairmentSection

designator
 

💡 (introduced with version 2.5) This element was introduced with version 2.5. Dieses Element wurde mit Version 2.5 eingeführt.

Scheme description / Schemenbeschreibung

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

• Parent: <impairmentSection>
• Children: None

Multiplicity / Anzahl

[0..∞]

Semantics / Bedeutung

In this article there is information missing with respect to element semantics. Please help improving the railML® wiki by filling the gaps. Possibly, you will find further details on the discussion page. Ferri Leberl (talk) 20:44, 29 November 2021 (CET)

(introduced with version 2.5)

Attributes of designator / Attribute von designator

• register: Name of the register, e.g. registers for OCPs: IBNR, DB640, RL100 or DIDOK. Choose a value from the railML codelist Registers.xml or name your own register starting with an underscore.
• entry: An entity's code in the specified register.
• startDate: Date from when (including) the entry becomes or became valid. The entry can be considered as "valid since ever" if this attribute is not used (no other entry of that register was valid during the validity period of the file). Before startDate, either the whole <ocp> wasn't part of the register or there is another entry for that <ocp> and register with a lower endDate. Please, recognize the semantic constraint.
• endDate: Date (including) when the entry becomes or became invalid. The entry can be considered as valid until canceled if this attribute is not used (no other entry of that register will become valid during the validity period of the file as known so far). After endDate, either the whole <ocp> will no longer be part of the register or there is another entry for that <ocp> and register with a higher startDate. Please, recognize the semantic constraint.

Syntactic Constraints / Syntaktische Beschränkungen

• register xs:string, required
• entry xs:string, required
• startDate xs:date, optional: shall be lower or equal endDate if both are used. Must not overlap with other validity periods of the same register for the same <ocp>.
• endDate xs:date, optional: shall be higher or equal startDate if both are used. Must not overlap with other validity periods of the same register for the same <ocp>.

Best practice & Examples / Empfohlene Anwendung & Beispiele

Not yet described. / Noch nicht beschrieben.

Notes / Anmerkungen

A list of current entries can be found on page Dev:Registers#Current entries. The procedure to add entries to the codelist is described on page Dev:Codelists#Missing entries.

Open issues / Offene Punkte/Pendenzen

Not yet described. / Noch nicht beschrieben.