RS:designator

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: <state>
• Children: None

Multiplicity / Anzahl

[0..∞]

Semantics / Bedeutung

FIXME(introduced with version 2.5)
 
Please, be aware of the semantic constraint(s)!

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).
• 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).

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 <state>.
• 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 <state>.

Semantic Constraints / Semantische Beschränkungen

Semantic Constraint "RS: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 the validity periods of other entries of the same register of the same enclosing <state>.   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

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.