Dev:Codelists

From railML 2 Wiki
Revision as of 18:33, 6 March 2017 by RailML Coord Documentation (talk | contribs) (Intention)
Jump to navigation Jump to search

railML® provides a number of XML codelists. From version 2.3 onwards, they are organized and actualized separately from the schema. Your railML® download will usually contain the codelists in a directory codelists, next to documentation and schema. The separation of schema and codelists allows actualizing the codelists in very short cycles.

The code lists are intended to address certain frequently used entities with a single code, as to avoid repetituous work as well as ambiguity errors. For instance, using <infrastructureManager>, you can address the Austrian Federal Railways (ÖBB) with their code ÖBB: <infrastructureManager code=ÖBB>. In this way, you inherit all information that is collected about the ÖBB in the code list, in this case name, country code and company code:

<infrastructureManager code="ÖBB">
  <name>ÖBB Infra</name>
  <isoCountryCode>AT</isoCountryCode>
  <companyCode>0081</companyCode>
</infrastructureManager>

Current codelists

The current codelists are:

InfrastructureManagers

The list contains infrastructure managing companies. The items are named <infrastructureManager> with the following specification:

  • Attributes
    • code: a code, that should be referred to from within an railML file, typically a short name for the infrastructure manager in latin letters. It links the railML® element <infrastructureManager> with the code list.
  • Children
    • <name>: The company name, with attribute
    • <isoCountryCode>: The two-digit country code of the company according to ISO 3166-1 alpha-2.
    • <companyCode>: Company codes according TAF TAP TSI B.8 or UIC IRS/leaflet 920-1:2006.

Registers

A list of registers, databases, handbooks etc. The items are named <register> with the following specification:

  • Attributes
    • code: A code, that should be referred to from within an railML® file
  • Children
    • <name>: Internationalized name of the operation or control point register
    • <organization>: Organization name that is responsible for the register
    • <remarks>: Internationalized remarks for the operation or control point register

TrainClearanceGauges

A list of clearance gauge standards. It provides data related to a particular train clearance gauge class. The items are named <trainClearanceGauge> with the following specification:

  • Attributes
    • code: A code, that should be referred to from within a railML file, typically a short name for the train clearance gauges in latin letters
  • Children
    • <description>: Internationalized name of the clearance gauge.
    • <validFor>: Gives indication, whether the clearance gauge is valid for only a national, several national or all TSI-compliant networks.

TrainProtectionSystems

List of train protection systems. It provides two container elements for track bound systems and train bound systems respectively:

  • <trainProtectionSystemsAtTrack>: Container for train protection systems, installed "at the track"
    • <trainProtectionSystem>: Single entries for each train protection system, installed "at track"
      • code: A code that should be referred to from within an railML file, typically a short name for the train protection system in latin letters.
      • <name>: Name of the system.
      • <validFor>: If the code for the system differs between vehicle and track installation, put the mapping in this container element.
        • <vehicleSystem>: Train protection system code of the according vehicle system.
  • <trainProtectionSystemsOnVehicle>: Container for train protection systems, installed "on the vehicle"
    • <trainProtectionSystem>: Single entries for each train protection system, installed "on vehicle"
      • code: A code, that should be referred to from within an railML file, typically a short name for the train protection system in latin letters.
      • <name>: Name of the system.
      • <validFor>: If the code for the system differs between vehicle and track installation, put the mapping in this container element.
        • <trackSystem>: Train protection system code of the according track system.