Dev:TrainClearanceGauges: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[checked revision][checked revision]
(Copy of CO:Codelists; for the authors see https://wiki.railml.org/index.php?title=CO%3ACodelists&action=history&year=2018&month=-1)
 
(Replaced content with "{{mirror}}")
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{rml}} provides a number of XML '''codelists'''. From version 2.3 onwards, they are organized and actualized separately from the schema.  Your [[Dev:Downloading and using railML|{{rml}} download]] will usually contain the codelists in a directory ''codelists'', next to documentation and schema. These codelists reflect the state of the codelists at the time of the publication of the respective {{rml}} version.
{{mirror}}
 
For the current codelist see [https://svn.railml.org/railML2/trunk/codelists https://svn.railml.org/railML2/trunk/codelists].
==Concept==
The code lists are intended to address certain frequently used entities with a single code, as to avoid repetitious work as well as ambiguity errors. For instance, using {{CO:Tag|infrastructureManager}}, you can address the [https://en.wikipedia.org/wiki/Austrian_Federal_Railways 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:
<syntaxhighlight lang="xml">
<infrastructureManager code="ÖBB">
  <name>ÖBB Infra</name>
  <isoCountryCode>AT</isoCountryCode>
  <companyCode>0081</companyCode>
</infrastructureManager>
</syntaxhighlight>
Moreover, the separation of schema and codelists allows actualizing the codelists in very short cycles.
==Missing entries==
Are you missing an entry? Did you find a mistake? We try to serve you with current, comprehensive and correct codelists and will try to add necessary entries as soon as possible. The actualization of the codelists does not follow the usual {{rml}} actualization cycles but happens in short terms.
 
* Inform the {{rml}} coordinator about a missing, incomplete or faulty entry — see https://www.railml.org/en/user/subschemes.html for the contact data.
* The coordinator will check your supplements and, where appropriate, include them into the regarding code list.
* The actualized codelist will be published in the SVN under [https://svn.railml.org/railML2/trunk/codelists https://svn.railml.org/railML2/trunk/codelists].
 
==Current codelists==
The current codelists are:
===InfrastructureManagers===
The list contains infrastructure managing companies. The items are named <infrastructureManager> with the following specification:
*Attributes
**{{attr|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 {{rml}} element {{CO:Tag|infrastructureManager}} with the code list.
*Children
**<name>: The company name, with attribute {{attr|}}
**<isoCountryCode>: The two-digit country code of the company according to [https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2].
**<companyCode>: Company codes according TAF TAP TSI B.8 or UIC IRS/leaflet 920-1:2006.
 
For an example entry see [[#Concept]].
 
===Registers===
A list of registers, databases, handbooks etc. The items are named <register> with the following specification:
*Attributes
**{{attr|code}}: A code, that should be referred to from within an {{rml}} 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
;Example entry
<syntaxhighlight lang=xml>
<register code="RL100">
<name xml:lang="de-DE">Betriebsstellenverzeichnis</name>
<organization xml:lang="de-DE">DB</organization>
<remarks xml:lang="de-DE">auch/früher als DS100 oder Ril100 bezeichnet</remarks>
<remarks xml:lang="en">also/former known as DS100 or Ril100</remarks>
</register>
</syntaxhighlight>
 
===TrainClearanceGauges===
A list of [https://en.wikipedia.org/wiki/Loading_gauge clearance gauge] standards. It provides data related to a particular train clearance gauge class. The items are named <trainClearanceGauge> with the following specification:
*Attributes
**{{attr|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.
;Example entry
<syntaxhighlight lang=xml>
<trainClearanceGauge code="GA">
<description>stucture gauge GA according European standard</description>
<validFor>interoperable</validFor>
</trainClearanceGauge>
</syntaxhighlight>
 
===TrainProtectionSystems===
List of [https://en.wikipedia.org/wiki/Train_protection_system train protection systems]. It provides two container elements for track bound systems and train bound systems respectively:
====At track====
*<trainProtectionSystemsAtTrack>: Container for train protection systems, installed "at the track"
**<trainProtectionSystem>: Single entries for each train protection system, installed "at track"
***{{attr|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.
;Example entry
<syntaxhighlight lang=xml>
<trainProtectionSystem code="Crocodile">
<name/>
<validFor>
  <vehicleSystem>Crocodile</vehicleSystem>
  <vehicleSystem>Memor</vehicleSystem>
  <vehicleSystem>Memor2</vehicleSystem>
</validFor>
</trainProtectionSystem>
</syntaxhighlight>
====On Vehicle====
*<trainProtectionSystemsOnVehicle>: Container for train protection systems, installed "on the vehicle"
**<trainProtectionSystem>: Single entries for each train protection system, installed "on vehicle"
***{{attr|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.
;Example entry
<syntaxhighlight lang=xml>
<trainProtectionSystem code="CIR-ELKE2">
<name/>
<validFor>
  <trackSystem>LZB</trackSystem>
  <trackSystem>CIR-ELKE</trackSystem>
  <trackSystem>CIR-ELKE2</trackSystem>
</validFor>
</trainProtectionSystem>
</syntaxhighlight>
 
[[category:Common Concept]]

Latest revision as of 20:36, 23 January 2020

🗒️ This page is mirrored from page Dev:TrainClearanceGauges in The railML® 3 wiki.
RailML Trademark RGB V2.png
XML Railway exchange format
https://railML.org
Latest release: 2.5
(September 1st, 2021)
 
Main Menu
 
Subschemas
XML tree
UML diagrams
Use cases
Versions & Changes

The codelist TrainClearanceGauges collects clearance gauge standards. It provides data related to a particular train clearance gauge class. Your railML® download may contain the code lists in a directory codelists, next to documentation and schema. As the code lists have shorter cycles than railML® versions have you might want to get the current list from https://development.railml.org/railml/shared/-/raw/master/codelists/TrainClearanceGauges.xml (link to the railML® website).

The code lists are intended to address certain frequently used entities with a single code, as to avoid repetitious work as well as ambiguity errors. Moreover, the separation of schema and codelists allows actualizing the codelists in very short cycles. The concept of codelists is explained here.

The codelist consists of clearance gauge standards (external link). It provides data related to a particular train clearance gauge class. The root/container element is named <trainClearanceGaugeList>. 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. Allowed values are "interoperable", "multinational" and "national".
Example entry
<trainClearanceGauge code="GA">
 <description>stucture gauge GA according European standard</description>
 <validFor>interoperable</validFor>
</trainClearanceGauge>

Affected Elements

Currently the codes listed in InfrastructureManagers.xml can be used as values for the code attribute of the following elements:

railML® 2

railML® 3

Current entries

As of January 2018, the following gauges are listed:

railML® Code Description ValidFor URL Contact
GA stucture gauge GA according European standard interoperable
GB stucture gauge GB according European standard interoperable
GC stucture gauge GC according European standard interoperable
G1 Multilateral gauge or international gauge G1 other than GA, GB and GC as defined in European standard. interoperable
G2 Multilateral gauge or international gauge G2 other than GA, GB and GC as defined in European standard. multinational
GB1 Multilateral gauge or international gauge GB1 other than GA, GB and GC as defined in European standard. multinational
GB2 Multilateral gauge or international gauge GB2 other than GA, GB and GC as defined in European standard. multinational
BE1 Domestic gauge BE1 as defined in European standard or national regulation. national
BE2 Domestic gauge BE2 as defined in European standard or national regulation national
BE3 Domestic gauge BE3 as defined in European standard or national regulation national
FR-3.3 Domestic gauge FR-3.3 as defined in European standard or national regulation national
PTb Domestic gauge PTb as defined in European standard or national regulation national
PTb+ Domestic gauge PTb+ as defined in European standard or national regulation national
PTc Domestic gauge PTc as defined in European standard or national regulation national
FIN1 Domestic gauge FIN1 as defined in European standard or national regulation national
SEa Domestic gauge SEa as defined in European standard or national regulation national
SEc Domestic gauge SEc as defined in European standard or national regulation national
DE1 Domestic gauge DE1 as defined in European standard or national regulation national
DE2 Domestic gauge DE2 as defined in European standard or national regulation national
DE3 Domestic gauge DE3 as defined in European standard or national regulation interoperable
Z-GCD Domestic gauge Z-GCD as defined in European standard or national regulation national
UK1 Domestic gauge UK1 as defined in European standard or national regulation national
UK1[D] Domestic gauge UK1[D] as defined in European standard or national regulation national
W6 Domestic gauge W6 as defined in European standard or national regulation national
FS Domestic gauge FS (Italy) as defined in European standard or national regulation national
S Domestic gauge S (1520 broad gauge) as defined in European standard or national regulation interoperable
GHE16 Domestic gauge GHE16 (Spain) as defined in European standard or national regulation national
GEB16 Domestic gauge GEB16 (Spain) as defined in European standard or national regulation national
GEC16 Domestic gauge GEC16 (Spain) as defined in European standard or national regulation national
IRL1 Domestic gauge IRL1 (Ireland) as defined in European standard or national regulation interoperable
IRL2 Domestic gauge IRL2 (Ireland) as defined in European standard or national regulation national
IRL3 Domestic gauge IRL3 (Ireland) as defined in European standard or national regulation national

Are you missing an entry? The procedure to extend the list is explained here.