Merge pull request #421 from Sharpe49/tcs-eb-manuel-reset

Added a reset command in order to reset a TCS emergency braking triggered by the simulator
https://trello.com/c/QvCgMnVW/256-command-to-release-train-control-system-emergency-braking

Author: cjakeman

Source/Documentation/Manual/driving.rst

@@ -1026,6 +1026,17 @@ You can have train cars oscillating (swaying) by hitting ``<Ctrl+V>``; if
 you want more oscillation, click ``<Ctrl+V>`` again. Four levels, 
 including the no-oscillation level, are available by repeating ``<Ctrl+V>``.
 
+Manual emergency braking release
+--------------------------------
+
+In some cases where the emergency braking is triggered by the simulator, it is possible to release
+the emergency braking by pressing ``<Shift+Backspace>``.
+
+The cases where the reset is allowed are:
+
+- Signal passed at danger
+- Trailed misaligned switch
+
 .. _driving-turntable:
 
 Engaging a turntable or a transfertable

Source/Documentation/Manual/features-rollingstock.rst

@@ -1054,6 +1054,38 @@ to be displayed in the ETCS DMI. For example, the following block orders the DMI
    single: Style
    single: SwitchVal
 
+Emergency braking triggered by the simulator
+''''''''''''''''''''''''''''''''''''''''''''
+
+The emergency brakings triggered by the simulator are always sent to the TCS script.
+
+Two functions are used to transmit this information:
+
+.. code-block:: csharp
+
+    public override void HandleEvent(TCSEvent evt, string message)
+
+The events sent are ``EmergencyBrakingRequestedBySimulator``, ``EmergencyBrakingReleasedBySimulator`` and ``ManualResetOutOfControlMode``.
+For the first event, the reason of the emergency braking is also sent:
+
+- ``SPAD``: The train has passed a signal at danger at the front of the train
+- ``SPAD_REAR``: The train has passed a signal at danger at the rear of the train
+- ``MISALIGNED_SWITCH``: The train has trailed a misaligned switch
+- ``OUT_OF_AUTHORITY``: The train has passed the limit of authority
+- ``OUT_OF_PATH``: The train has ran off its allocated path
+- ``SLIPPED_INTO_PATH``: The train has slipped back into the path of another train
+- ``SLIPPED_TO_ENDOFTRACK``: The train has slipped off the end of the track
+- ``OUT_OF_TRACK``: The train has moved off the track
+- ``OTHER_TRAIN_IN_PATH``: Another train has entered the train's path
+- ``SLIPPED_INTO_TURNTABLE``: The train has entered a misaligned turntable
+- ``TRAIN_ON_MOVING_TURNTABLE``: The train has started moving on a moving turntable
+
+.. code-block:: csharp
+
+    public override void SetEmergency(bool emergency)
+
+This function is deprecated and will be deleted in a future version. The parameter indicates if the emergency braking is requested (true) or released (false).
+
 Generic cabview controls
 ''''''''''''''''''''''''
 Often Train Control Systems have a quite sophisticated DMI (driver-machine 

Source/ORTS.Common/Input/UserCommand.cs

@@ -25,6 +25,7 @@ public enum UserCommand
         [GetString("Game Multi Player Dispatcher")] GameMultiPlayerDispatcher,
         [GetString("Game Multi Player Texting")] GameMultiPlayerTexting,
         [GetString("Game Switch Manual Mode")] GameSwitchManualMode,
+        [GetString("Game Reset Out Of Control Mode")] GameResetOutOfControlMode,
         [GetString("Game Clear Signal Forward")] GameClearSignalForward,
         [GetString("Game Clear Signal Backward")] GameClearSignalBackward,
         [GetString("Game Reset Signal Forward")] GameResetSignalForward,

Source/ORTS.Settings/InputSettings.cs

@@ -485,6 +485,7 @@ static void InitializeCommands(UserCommandInput[] Commands)
             Commands[(int)UserCommand.GamePause] = new UserCommandKeyInput(Keys.Pause);
             Commands[(int)UserCommand.GamePauseMenu] = new UserCommandKeyInput(0x01);
             Commands[(int)UserCommand.GameQuit] = new UserCommandKeyInput(0x3E, KeyModifiers.Alt);
+            Commands[(int)UserCommand.GameResetOutOfControlMode] = new UserCommandKeyInput(0x0E, KeyModifiers.Shift);
             Commands[(int)UserCommand.GameRequestControl] = new UserCommandKeyInput(0x12, KeyModifiers.Alt);
             Commands[(int)UserCommand.GameResetSignalBackward] = new UserCommandKeyInput(0x0F, KeyModifiers.Control | KeyModifiers.Shift);
             Commands[(int)UserCommand.GameResetSignalForward] = new UserCommandKeyInput(0x0F, KeyModifiers.Control);

Source/Orts.Simulation/Common/Commands.cs

@@ -633,26 +633,40 @@ public InitializeBrakesCommand( CommandLog log )
 
         public override void Redo() {
             Receiver.UnconditionalInitializeBrakes();
-            // Report();
         }
     }
 
     [Serializable()]
-    public sealed class EmergencyPushButtonCommand : Command
+    public sealed class ResetOutOfControlModeCommand : Command
+    {
+        public static Train Receiver { get; set; }
+        public ResetOutOfControlModeCommand(CommandLog log) : base(log)
+        {
+            Redo();
+        }
+
+        public override void Redo()
+        {
+            Receiver.ManualResetOutOfControlMode();
+            Receiver.SignalEvent(TCSEvent.ManualResetOutOfControlMode);
+        }
+    }
+
+    [Serializable()]
+    public sealed class EmergencyPushButtonCommand : BooleanCommand
     {
         public static MSTSLocomotive Receiver { get; set; }
 
-        public EmergencyPushButtonCommand(CommandLog log)
-            : base(log)
+        public EmergencyPushButtonCommand(CommandLog log, bool toState)
+            : base(log, toState)
         {
             Redo();
         }
 
         public override void Redo()
         {
-            Receiver.EmergencyButtonPressed = !Receiver.EmergencyButtonPressed;
-            Receiver.TrainBrakeController.EmergencyBrakingPushButton = Receiver.EmergencyButtonPressed;
-            // Report();
+            Receiver.EmergencyButtonPressed = ToState;
+            Receiver.TrainBrakeController.EmergencyBrakingPushButton = ToState;
         }
     }
 

Source/Orts.Simulation/Common/Scripting/TrainControlSystem.cs

@@ -523,7 +523,8 @@ public virtual void HandleEvent(PowerSupplyEvent evt, string message) { }
         /// <summary>
         /// Called by signalling code externally to stop the train in certain circumstances.
         /// </summary>
-        public abstract void SetEmergency(bool emergency);
+        [Obsolete("SetEmergency method is deprecated, use HandleEvent(TCSEvent, string) instead")]
+        public virtual void SetEmergency(bool emergency) { }
         /// <summary>
         /// Called when player has requested a game save. 
         /// Set at virtual to keep compatibility with scripts not providing this method.
@@ -570,6 +571,18 @@ public enum TRAIN_CONTROL
 
     public enum TCSEvent
     {
+        /// <summary>
+        /// Emergency braking requested by simulator (train is out of control).
+        /// </summary>
+        EmergencyBrakingRequestedBySimulator,
+        /// <summary>
+        /// Emergency braking released by simulator.
+        /// </summary>
+        EmergencyBrakingReleasedBySimulator,
+        /// <summary>
+        /// Manual reset of the train's out of control mode.
+        /// </summary>
+        ManualResetOutOfControlMode,
         /// <summary>
         /// Reset request by pressing the alerter button.
         /// </summary>