Visualization of infrastructure elements in railML 2

Description

The current implementation of in railML 2.4 allows only for visualization of line , track , track elements and OCP .

However, railML infrastructure data model contains more elements. For these elements (e.g. ) a visualization concept has to be defined.

Background

The documentation of and its child elements in the wiki is not sufficient w.r.t. best practice usage. In consequence, it is unclear how to model visualization of elements that are not directly linked with tracks.

Links

• Forum discussion
• Torben Brand, 03.12.2019: [https://www.railml.org/forum/index.php?t=msg&th=693&start=0&]
• Trac tickets
• Wiki documentation
• IS:infrastructureVisualizations: [https://wiki2.railml.org/wiki/IS:infrastructureVisualizations]
• IS:ocpVis: [https://wiki2.railml.org/index.php?title=IS:ocpVis]
• IS:lineVis: [https://wiki2.railml.org/index.php?title=IS:lineVis]
• IS:trackVis: [https://wiki2.railml.org/index.php?title=IS:trackVis]
• IS:trackElementVis: [https://wiki2.railml.org/index.php?title=IS:trackElementVis]

Proposed solution in railML 2.5

The following adaptations need to be done in the railML2 wiki:

• IS:infrastructureVisualizations
• add in Best practice: " shall be used to describe a graphical visualization of infrastructure, e.g. on a screen or a paper plan."
• change multiplicity from [1..1] to [0..1], because is optional in
• IS:lineVis
• add semantic note: visualization of a railway line element
• IS:ocpVis
• add semantic note: DEPRECATED; has been used for visualizing OCP elements
• IS:trackVis
• add semantic note: visualization of a track or a track element
• IS:objectVis
• new semantic note: visualization of an object that is not located on a track or a line, e.g. an OCP or a controller.

Beyond better documentation, it is discussed whether shall be replaced by to allow for visulization of all the different types of elements that don't match tracks and lines.

• Description changed

  == Description ==
  
  The current implementation of <visualization> in railML 2.4 allows only for visualization of line <lineVis>, track <trackVis>, track elements <trackElementVis> and OCP <ocpVis>.
  
  However, railML infrastructure data model contains more elements. For these elements (e.g. <controller> ) a visualization concept has to be defined. 
  
  === Background ===
  
  The documentation of <visualization> and its child elements in the wiki is not sufficient w.r.t. best practice usage. In consequence, it is unclear how to model visualization of elements that are not directly linked with tracks.
  
  === Links ===
  
  * Forum discussion
   * Torben Brand, 03.12.2019: [https://www.railml.org/forum/index.php?t=msg&th=693&start=0&]
  * Trac tickets
  * Wiki documentation
+  * IS:infrastructureVisualizations: [https://wiki2.railml.org/wiki/IS:infrastructureVisualizations]
   * IS:ocpVis: [https://wiki2.railml.org/index.php?title=IS:ocpVis]
   * IS:lineVis: [https://wiki2.railml.org/index.php?title=IS:lineVis]
   * IS:trackVis: [https://wiki2.railml.org/index.php?title=IS:trackVis]
   * IS:trackElementVis: [https://wiki2.railml.org/index.php?title=IS:trackElementVis]
  
- == Proposed solution in railML 2.4 ==
- 
- under discussion
- 
  == Proposed solution in railML 2.5 ==
  
- under discussion
+ The following **adaptations need to be done in the railML2 wiki**:
+ 
+ * IS:infrastructureVisualizations
+  * add in Best practice: "<infrastructureVisualizations> shall be used to describe a graphical visualization of infrastructure, e.g. on a screen or a paper plan."
+  * change multiplicity from [1..1] to [0..1], because <infrastructureVisualizations> is optional in <railml>
+ * IS:lineVis
+  * add semantic note
+ * IS:ocpVis
+  * add semantic note
+ * IS:trackVis
+  * add semantic note
+ 
+ Beyond better documentation, it is discussed whether **<ocpVis> shall be replaced by <objectVis>** to allow for visulization of all the different types of elements that don't match tracks and lines.

add proposed solution for railML 2.5 (wiki and schema)

In [changeset:"1169/railML"]:

replacing <ocpVis> with <objectVis>, see #373

• Cc added @coordination.IS
• Description changed

  == Description ==
  
  The current implementation of <visualization> in railML 2.4 allows only for visualization of line <lineVis>, track <trackVis>, track elements <trackElementVis> and OCP <ocpVis>.
  
  However, railML infrastructure data model contains more elements. For these elements (e.g. <controller> ) a visualization concept has to be defined. 
  
  === Background ===
  
  The documentation of <visualization> and its child elements in the wiki is not sufficient w.r.t. best practice usage. In consequence, it is unclear how to model visualization of elements that are not directly linked with tracks.
  
  === Links ===
  
  * Forum discussion
   * Torben Brand, 03.12.2019: [https://www.railml.org/forum/index.php?t=msg&th=693&start=0&]
  * Trac tickets
  * Wiki documentation
   * IS:infrastructureVisualizations: [https://wiki2.railml.org/wiki/IS:infrastructureVisualizations]
   * IS:ocpVis: [https://wiki2.railml.org/index.php?title=IS:ocpVis]
   * IS:lineVis: [https://wiki2.railml.org/index.php?title=IS:lineVis]
   * IS:trackVis: [https://wiki2.railml.org/index.php?title=IS:trackVis]
   * IS:trackElementVis: [https://wiki2.railml.org/index.php?title=IS:trackElementVis]
  
  == Proposed solution in railML 2.5 ==
  
  The following **adaptations need to be done in the railML2 wiki**:
  
  * IS:infrastructureVisualizations
   * add in Best practice: "<infrastructureVisualizations> shall be used to describe a graphical visualization of infrastructure, e.g. on a screen or a paper plan."
   * change multiplicity from [1..1] to [0..1], because <infrastructureVisualizations> is optional in <railml>
  * IS:lineVis
-  * add semantic note
+  * add semantic note: visualization of a railway line element
  * IS:ocpVis
-  * add semantic note
+  * add semantic note: DEPRECATED; has been used for visualizing OCP elements
  * IS:trackVis
-  * add semantic note
+  * add semantic note: visualization of a track or a track element
+ * IS:objectVis
+  * new semantic note: visualization of an object that is not located on a track or a line, e.g. an OCP or a controller.
  
  Beyond better documentation, it is discussed whether **<ocpVis> shall be replaced by <objectVis>** to allow for visulization of all the different types of elements that don't match tracks and lines.

• Owner set to @documentation.GOV
• Status changed from new to assigned

Proposed solution ( replaces ) has been implemented with railML 2.5;

clarifying definitions of different <*Vis> elements;

documentation in wiki is pending; ticket has been assigned to Mr. Ferri Leberl who is responsible for the wiki documentation.

• The suggestions in https://trac.railml.org/ticket/373 have been entered
• https://wiki2.railml.org/wiki/Dev:changes/2.5#.3CocpVis.3E_replaced_with_.3CobjectVis.3E has been added

@coordination.IS Please, check

removed Wiki label

assigned to @coordination.IS and unassigned @root

changed milestone to %2.5

removed 2.5 label