Merge pull request #384 from cesarBLG/etcs-dmi-display

ETCS Driver Machine Interface
Discussion: http://www.elvastower.com/forums/index.php?/topic/34577-planning-area-of-the-etcs-dmi/
Blueprint: https://blueprints.launchpad.net/or/+spec/etcs-dmi

Author: cjakeman

Source/Documentation/Manual/features-rollingstock.rst

@@ -806,6 +806,9 @@ Use the following .eng paramater to load an electric power supply script::
 The .cs extension is optional. "Default" will load the generic OR power supply 
 implementation, so do `not` use this name for your own script.
 
+
+.. _features-scripting-tcs:
+
 Train Control System
 --------------------
 
@@ -919,6 +922,17 @@ which returns a handle for the player locomotive instance of the MSTSLocomotive
 class. Through such handle all public classes, methods and variables of 
 the OR Simulation environment can be accessed within the script. 
 
+The Train Control System class provides the ETCSStatus field, which controls the information
+to be displayed in the ETCS DMI. For example, the following block orders the DMI to show the circular speed gauge in yellow colour as the train approaches a speed restriction:
+
+.. code-block:: csharp
+    
+    ETCSStatus.CurrentMonitor = Monitor.TargetSpeed;
+    ETCSStatus.CurrentSupervisionStatus = SupervisionStatus.Indication;
+    ETCSStatus.TargetDistanceM = 1234.5f;
+    ETCSStatus.AllowedSpeedMpS = 50;
+    ETCSStatus.InterventionSpeedMpS = 52.5f;
+    ETCSStatus.TargetSpeedMpS = 25;
 
 .. index::
    single: MultiStateDisplay

Source/Documentation/Manual/options.rst

@@ -695,6 +695,18 @@ system ETCS.
             Units ( KM_PER_HOUR )
         )
 
+It is also possible to display the full ETCS display using the following block
+instead::
+
+		ScreenDisplay (
+			Type ( ORTS_ETCS SCREEN_DISPLAY )
+			Position ( 280 272 320 240 )
+			Units ( KM_PER_HOUR )
+		)
+
+The information displayed in the DMI is controlled via the TCS script. For more details,
+see :ref:`C# engine scripting - Train Control System <features-scripting-tcs>`.
+
 Load day/night textures only when needed
 ----------------------------------------
 

Source/Orts.Formats.Msts/CabViewFile.cs

@@ -233,6 +233,7 @@ public enum CABViewControlTypes
         ORTS_TCS46,
         ORTS_TCS47,
         ORTS_TCS48,
+        ORTS_ETCS,
 
         // Further CabViewControlTypes must be added above this line, to avoid their malfunction in 3DCabs
         EXTERNALWIPERS,
@@ -313,7 +314,8 @@ public CabViewControls(STFReader stf, string basepath)
                 new STFReader.TokenProcessor("combinedcontrol", ()=>{ Add(new CVCDiscrete(stf, basepath)); }),
                 new STFReader.TokenProcessor("firebox", ()=>{ Add(new CVCFirebox(stf, basepath)); }),
                 new STFReader.TokenProcessor("dialclock", ()=>{ ProcessDialClock(stf, basepath);  }),
-                new STFReader.TokenProcessor("digitalclock", ()=>{ Add(new CVCDigitalClock(stf, basepath)); })
+                new STFReader.TokenProcessor("digitalclock", ()=>{ Add(new CVCDigitalClock(stf, basepath)); }),
+                new STFReader.TokenProcessor("screendisplay", ()=>{ Add(new CVCScreen(stf, basepath)); })
             });
 
             //TODO Uncomment when parsed all type
@@ -1165,6 +1167,36 @@ protected int ParseNumStyle(STFReader stf)
     }
     #endregion
 
+    #region Screen based controls
+    public class CVCScreen : CabViewControl
+    {
+        public readonly Dictionary<string, string> CustomParameters = new Dictionary<string, string>();
+        public CVCScreen()
+        {
+        }
+
+        public CVCScreen(STFReader stf, string basepath)
+        {
+            stf.MustMatch("(");
+            stf.ParseBlock(new STFReader.TokenProcessor[] {
+                new STFReader.TokenProcessor("type", ()=>{ ParseType(stf); }),
+                new STFReader.TokenProcessor("position", ()=>{ ParsePosition(stf); }),
+                new STFReader.TokenProcessor("graphic", ()=>{ ParseGraphic(stf, basepath); }),
+                new STFReader.TokenProcessor("units", ()=>{ ParseUnits(stf); }),
+                new STFReader.TokenProcessor("parameters", ()=>{ ParseCustomParameters(stf); }),
+            });
+        }
+        protected void ParseCustomParameters(STFReader stf)
+        {
+            stf.MustMatch("(");
+            while (!stf.EndOfBlock())
+            {
+                CustomParameters[stf.ReadString().ToLower()] = stf.ReadString().ToLower();
+            }
+        }
+    }
+    #endregion
+
     #region other controls
     public class CVCSignal : CVCDiscrete
     {