IS:designator ocp

From railML 2 Wiki
Revision as of 15:08, 17 May 2012 by Dirk Bräuer (talk | contribs) (THIS IS A PER-ANNOUNCEMENT FOR A NEW ELEMENT AND NOT YET RELEASED. CONTENTS MAY CHANGE UNTIL FINAL RELEASE OF RAILML 2.2.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


key
 


Scheme description / Schemenbeschreibung

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

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

Multiplicity / Anzahl

[1..1]

Semantics / Bedeutung

There are normally several abbreviations and/or numbers for the same <ocp> (station), even in one country. So, the writing and reading software of a railML file can have different external primary keys for the same <ocp> (station).

The <key> sequence allows to enumerate more than one external primary key for one <ocp>. Such, it defines the mapping from one to another register.

It supersets the older (now deprecated) attributes 'code' and 'abbrev[i]ation' of <ocp>.

Attributes of key / Attribute von key

  • register: Enumeration defining the catalogue, index, or directory where the external primary key comes from or refers to. See below for a list of the currently registered catalogues.
  • value: Contains the external primary key of the OCP belonging to the referred register.

Syntactic Constraints / Syntaktische Beschränkungen

  • register xs:enumeration, required: For short-time or internal purposes new enumeration entries can be used additional to that of railML's XSD. But for official data exchange between two software programs it is _strongly_ recommended that each new 'register' entry has to be 'registered' at the Scheme Coordinator.
  • value xs:string, required: May be a string or a number depending on the 'register'. This means, some 'register' entries require a pure numeric number and do not allow characters or other signs. This is not forced by railML so far.

Best practice & Examples / Empfohlene Anwendung & Beispiele

<ocp ... name='Passau Hbf.' ...>
    <key register='IBNR' value='8000298'/>
    <key register='DS100' value='NPA'/>
    <key register='DB640' value='Pa'/>
</ocp>

<ocp ... name='Fieberbrunn' ...>
    <key register='IBNR' value='8100053'/>
    <key register='DB640_2011' value='Fie'/>
    <key register='DB640_2012' value='Hch H2'/>
    <key register='DS100' value='XAFB'/>
</ocp>

Notes / Anmerkungen

THIS IS A PER-ANNOUNCEMENT FOR A NEW ELEMENT AND NOT YET RELEASED. CONTENTS MAY CHANGE UNTIL FINAL RELEASE OF RAILML 2.2.

Currently predefined 'register' enumeration entries:

  • ENEE Station code of ENEE database managed by UIC.
  • IBNR Numbers used in some public timetable databases and some customer information systems (EFA - Elektronische Fahrplanauskunft). This enumeration entry requires the value to be an integer number.
  • DS100 German "Betriebsstellenkürzel", Dienstvorschrift/Richtlinie No. 100 of Deutsche Bahn.
  • DB640 Austrian Dienstbehelf No. 640 of Österreichische Bundesbahnen.

Since the values change over the years, each one of the 'register' enumeration entries can be used with _xxxx (underline and a four-digit year number) to specify the year of the key values if necessary.

Open issues / Offene Punkte/Pendenzen

Not yet described. / Noch nicht beschrieben.