Dev:Examples

From wiki.railML.org
(Redirected from Dev:example)
Jump to: navigation, search

Examples
 

Like pictures, illustrative examples can say more than a thousand words. Therefore, they can be valuable to grasp the concepts of railML®.

railML.org publishes several example files on its website under https://www.railml.org/en/user/exampledata.html (link to the railML® website)

To enrich our stock we highly appreciate if you share your examples with us.

To learn where to find, how to use and how to contribute use cases see Dev:Use cases. While use cases follow a top down approach, explaining the context, examples follow a bottom up approach, explaining a punctual sollution. Typical use cases are formulated narratively; the core of an example is railML® code.

Real World Examples

Furthermore, railML.org provides real world railway examples from professional tools. This are kindly provided by our partners. A download is only available for registered users.

Training Examples by railML.org

Trainig examples are published by railML.org in order to provide valid and comprehensible railML data files for developers and interested. They are not meant for productive purposes and only represent an imaginary railway infrastructure.

Simple Example

A simple example that comprehensibly explains the modelling principles of railML (and RailTopoModel) on the basis of a small selection of railway specific elements. The example intends to provide beginners a first and easy-to-understand overview of the essential elements and attributes of the model and exchange format.

Ein einfaches Beispiel, was die Modellierungsprinzipen von railML (und RailTopoModel) bewusst mit nur wenigen Elementen des Eisenbahnbetriebs erläutert. Damit soll Einsteigern mit Konzentration auf das Wesentliche ein erster und leicht verständlicher Überblick über wesentliche Elemente und Attribute des Modells und Austauschformates gegeben werden.

  • Under development since: July 2017
  • Current example version: V11 (as of September 17, 2018)
  • Schemas: Infrastructure
  • railML® version: 2.3, 2.4, 3.1beta

Advanced Example

(Under development)

An extended example, which shows common elements of railway opeartion that are used in data management and data exchange with railML (and RailTopoModel) on a daily basis. With this programmers and users shall clearly understand central elements and attributes. Furthermore, they can compare them with their own developments.

Parts of the Advanced Example correspond to the Simple Example without contradiction and extend it only by additional elements.

Ein erweitertes Beispiel, was die alltägliche Datenhaltung und den Datenaustausch mit railML (und RailTopoModel) durch oft gebräuchliche Elementen des Eisenbahnbetriebs darstellt. Programmierer und Anwender können dadurch in übersichtlicher Weise zentrale Elemente und Attribute nachvollziehen und mit eigenen Entwicklungen abgleichen.

Teile des Advanced Example entsprechen dabei widerspruchsfrei dem Simple Example und erweitern dieses dabei nur durch zusätzliche Elemente.

  • Under development since: October 2018
  • Current example version: Upcoming
  • Subschemas:Timetable, Infrastructure, Interlocking, RollingStock
  • railML® Versions: 2.4 (planned), 3.1 (planned)

Complex Example

(Upcoming)

A sophisticated example, which focuses on featuring (internationally understandable) special features, comprehensible exceptions and special problems in data exchange. The target group of this example data set are developers and modellers with advanced experience in the railML environment.

Ein komplexes Beispiel, welches auch (international verständliche) Besonderheiten, nachvollziehbare Ausnahmen und spezielle Probleme im Datenaustausch darstellt. Zielgruppe sind hier langjährige Entwickler und Modellierer im railML-Umfeld.

  • Under development since: Upcoming
  • Current example version: Upcoming
  • Subschemas: To be decided
  • railML® Versions: To be decided

How to contribute examples

  • It is recommended to arrange your example in advance with the coordinators as to avoid futile efforts.
  • Please, only submit examples from certified applications. You can inform about the certification procedure here.
  • Generally, examples are more illustrative, if they have a real background.
  • As a general rule, minimal examples are more convenient to convey the principles of railML®. Comprehensive examples are appreciated too, as to test the limmitations of applications.
  • Good examples contain
    • a brief description (abstract)
    • information of the content (number, formats and functions of files)
    • a railML® file
    • a human readable presentation or visualisation
    • a comprehensive explanation
  • Please, submit your example either to the respective subschema coordinator, or to the railML® coordinator. For the contact details see https://www.railml.org/en/user/subschemes.html (link to the railML® website).
  • a list of good examples (in German; mostly without connection to railML®) can be found on http://irfp.de/beispiele.html (external link, German flag.png, visited on 2018-03-27; by Dirk Bräuer, iRFP Dresden)