Dev:Use case example

From wiki.railML.org
Jump to: navigation, search
Example
Subschema: Subschema missing!
This page refers to version example of railML®.
Therefore the content is possibly outdated.
The current version is 2.4.
For general information on use cases see UC:Use cases

Use case / Anwendungsfall / Scénario d’utilisation

This article shows and explains the structure of a good use case. For an actual example see IS:UC:RailwayInfrastructureRecording.

This section should be used for a header or introduction. To get more information on use cases and how to describe them, see Dev:Use cases. The headline is made with Template: UC title (type {{UC title}})

Description / Beschreibung / Description

Please, describe the use case here. The headline is made with Template: UC description (type {{UC description}})

Data Flows and Interfaces / Datenflüsse und Schnittstellen / Flux de données et interfaces

In this section the data flows should be drafted. The headline is made with Template: UC flows (type {{UC flows}})

Interference with other railML® schemas / Interferenz mit anderen railML®-Schemen / Interaction avec autres schemas railML®

Which data interferences are there? The headline is made with Template: UC interference (type {{UC interference}})

Characterizing Data / Charakterisierung der Daten / Caractérisation des données

How can the data be characterized? Explain this in the following subsections. The headline is made with Template: UC data (type {{UC data}})

How often do the data change (update)?

How often are the data updated? Does this happen routinely? The headline is made with Template: UC update (type {{UC update}})

How big are the data fragments to be exchanged (complexity)?

How complex is the exchanged data? The headline is made with Template: UC complexity (type {{UC complexity}})

Which views are represented by the data (focus)?

What is the focus of the data? How can the whole picture be described? The headline is made with Template: UC focus (type {{UC focus}})

Which specific data do you expect to receive/send (elements)?

Please list all elements that are part of the data in this use case. The headline is made with Template: UC elements (type {{UC elements}})