Added neutral mode on brake controllers

Author: Sharpe49

Source/Orts.Formats.Msts/CabViewFile.cs

@@ -209,6 +209,8 @@ public enum CABViewControlTypes
         ORTS_OVERCHARGE,
         ORTS_AIR_FLOW_METER,
         ORTS_TRAIN_AIR_FLOW_METER,
+        ORTS_NEUTRAL_MODE_COMMAND_SWITCH,
+        ORTS_NEUTRAL_MODE_ON,
         ORTS_BATTERY_SWITCH_COMMAND_SWITCH,
         ORTS_BATTERY_SWITCH_COMMAND_BUTTON_CLOSE,
         ORTS_BATTERY_SWITCH_COMMAND_BUTTON_OPEN,

Source/Orts.Simulation/Common/Commands.cs

@@ -765,7 +765,6 @@ public BailOffCommand(CommandLog log, bool toState)
         public override void Redo()
         {
             Receiver.SetBailOff(ToState);
-            // Report();
         }
 
         public override string ToString()
@@ -788,7 +787,6 @@ public QuickReleaseCommand(CommandLog log, bool toState)
         public override void Redo()
         {
             Receiver.TrainBrakeController.QuickReleaseButtonPressed = ToState;
-            // Report();
         }
 
         public override string ToString()
@@ -811,7 +809,28 @@ public BrakeOverchargeCommand(CommandLog log, bool toState)
         public override void Redo()
         {
             Receiver.TrainBrakeController.OverchargeButtonPressed = ToState;
-            // Report();
+        }
+
+        public override string ToString()
+        {
+            return base.ToString() + " - " + (ToState ? "off" : "on");
+        }
+    }
+
+    [Serializable()]
+    public sealed class BrakeNeutralModeCommand : BooleanCommand
+    {
+        public static MSTSLocomotive Receiver { get; set; }
+
+        public BrakeNeutralModeCommand(CommandLog log, bool toState)
+            : base(log, toState)
+        {
+            Redo();
+        }
+
+        public override void Redo()
+        {
+            Receiver.TrainBrakeController.NeutralModeCommandSwitchOn = ToState;
         }
 
         public override string ToString()

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

@@ -66,6 +66,16 @@ internal void AttachToHost(ScriptedBrakeController host)
         /// </summary>
         public bool OverchargeButtonPressed() => Host.OverchargeButtonPressed;
 
+        /// <summary>
+        /// True if the neutral mode switch is on
+        /// </summary>
+        protected bool NeutralModeCommandSwitchOn { get => Host.NeutralModeCommandSwitchOn; set => Host.NeutralModeCommandSwitchOn = value; }
+
+        /// <summary>
+        /// True if the neutral mode is on
+        /// </summary>
+        protected bool NeutralModeOn { get => Host.NeutralModeOn; set => Host.NeutralModeOn = value; }
+
         /// <summary>
         /// True if low voltage power supply is switched on.
         /// </summary>

Source/Orts.Simulation/Simulation/Confirmer.cs

@@ -90,6 +90,7 @@ public enum CabControl {
       , BrakeHose
       , QuickRelease
       , Overcharge
+      , NeutralMode
       // Cab Devices
       , Sander
       , Alerter
@@ -243,6 +244,7 @@ public Confirmer(Simulator simulator, double defaultDurationS)
                 , new string [] { GetString("Brake Hose"), GetString("disconnect"), null, GetString("connect") }
                 , new string [] { GetString("Quick Release"), GetString("off"), null, GetString("on") }
                 , new string [] { GetString("Overcharge"), GetString("off"), null, GetString("on") }
+                , new string [] { GetString("Neutral mode"), GetString("off"), null, GetString("on") }
                 // Cab Devices
                 , new string [] { GetString("Sander"), GetString("off"), null, GetString("on") } 
                 , new string [] { GetString("Alerter"), GetString("acknowledge"), null, GetParticularString("Alerter", "sound") } 

Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs

@@ -5795,6 +5795,16 @@ public virtual float GetDataOf(CabViewControl cvc)
                         }
                         break;
                     }
+                case CABViewControlTypes.ORTS_NEUTRAL_MODE_COMMAND_SWITCH:
+                    {
+                        data = (TrainBrakeController == null || !TrainBrakeController.NeutralModeCommandSwitchOn) ? 0 : 1;
+                        break;
+                    }
+                case CABViewControlTypes.ORTS_NEUTRAL_MODE_ON:
+                    {
+                        data = (TrainBrakeController == null || !TrainBrakeController.NeutralModeOn) ? 0 : 1;
+                        break;
+                    }
                 case CABViewControlTypes.FRICTION_BRAKING:
                     {
                         data = (BrakeSystem == null) ? 0.0f : BrakeSystem.GetCylPressurePSI();

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/Controllers/BrakeController.cs

@@ -40,6 +40,8 @@ public class ScriptedBrakeController : IController
         private bool tcsFullServiceBraking = false;
         private bool overchargeButtonPressed = false;
         private bool quickReleaseButtonPressed = false;
+        private bool neutralModeCommandSwitchOn = false;
+
         public bool EmergencyBraking
         {
             get
@@ -141,6 +143,28 @@ public bool OverchargeButtonPressed
             }
         }
 
+        public bool NeutralModeCommandSwitchOn
+        {
+            get
+            {
+                return neutralModeCommandSwitchOn;
+            }
+            set
+            {
+                if (Simulator.Confirmer != null)
+                {
+                    if (value && !neutralModeCommandSwitchOn)
+                        Simulator.Confirmer.Confirm(CabControl.NeutralMode, CabSetting.On);
+                    else if (!value && neutralModeCommandSwitchOn)
+                        Simulator.Confirmer.Confirm(CabControl.NeutralMode, CabSetting.Off);
+                }
+
+                neutralModeCommandSwitchOn = value;
+            }
+        }
+
+        public bool NeutralModeOn { get; set; }
+
         public float MaxPressurePSI { get; set; }
         public float MaxOverchargePressurePSI { get; private set; }
         public float ReleaseRatePSIpS { get; private set; }

Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs

@@ -2227,6 +2227,8 @@ public virtual int GetDrawIndex()
                 case CABViewControlTypes.ORTS_BAILOFF:
                 case CABViewControlTypes.ORTS_QUICKRELEASE:
                 case CABViewControlTypes.ORTS_OVERCHARGE:
+                case CABViewControlTypes.ORTS_NEUTRAL_MODE_COMMAND_SWITCH:
+                case CABViewControlTypes.ORTS_NEUTRAL_MODE_ON:
                 case CABViewControlTypes.DOORS_DISPLAY:
                 case CABViewControlTypes.CYL_COCKS:
                 case CABViewControlTypes.ORTS_BLOWDOWN_VALVE:
@@ -2516,6 +2518,7 @@ public void HandleUserInput()
                 case CABViewControlTypes.ORTS_BAILOFF: new BailOffCommand(Viewer.Log, ChangedValue(Locomotive.BailOff ? 1 : 0) > 0); break;
                 case CABViewControlTypes.ORTS_QUICKRELEASE: new QuickReleaseCommand(Viewer.Log, ChangedValue(Locomotive.TrainBrakeController.QuickReleaseButtonPressed ? 1 : 0) > 0); break;
                 case CABViewControlTypes.ORTS_OVERCHARGE: new BrakeOverchargeCommand(Viewer.Log, ChangedValue(Locomotive.TrainBrakeController.OverchargeButtonPressed ? 1 : 0) > 0); break;
+                case CABViewControlTypes.ORTS_NEUTRAL_MODE_COMMAND_SWITCH: new BrakeNeutralModeCommand(Viewer.Log, ChangedValue(Locomotive.TrainBrakeController.NeutralModeCommandSwitchOn ? 1 : 0) > 0); break;
                 case CABViewControlTypes.RESET: new AlerterCommand(Viewer.Log, ChangedValue(Locomotive.TrainControlSystem.AlerterButtonPressed ? 1 : 0) > 0); break;
                 case CABViewControlTypes.CP_HANDLE:
                     if ((Locomotive.CruiseControl?.SelectedMaxAccelerationPercent == 0 && Locomotive.CruiseControl.SpeedRegMode == CruiseControl.SpeedRegulatorMode.Auto)