Merge pull request #1115 from cesarBLG/automatic-ets

Do not activate ETS switch if no suitable cars are attached

Author: cjakeman

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/DieselPowerSupply.cs

@@ -311,13 +311,13 @@ public override void HandleEvent(PowerSupplyEvent evt)
                     SignalEventToBatterySwitch(PowerSupplyEvent.QuickPowerOn);
                     SignalEventToMasterKey(PowerSupplyEvent.TurnOnMasterKey);
                     SignalEventToDieselEngines(PowerSupplyEvent.StartEngine);
-                    SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.SwitchOnElectricTrainSupply);
+                    SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.QuickPowerOn);
                     break;
 
                 case PowerSupplyEvent.QuickPowerOff:
                     QuickPowerOn = false;
-                    SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.SwitchOffElectricTrainSupply);
-                    SignalEventToTractionCutOffRelay(PowerSupplyEvent.OpenTractionCutOffRelay);
+                    SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.QuickPowerOff);
+                    SignalEventToTractionCutOffRelay(PowerSupplyEvent.QuickPowerOff);
                     SignalEventToDieselEngines(PowerSupplyEvent.StopEngine);
                     SignalEventToMasterKey(PowerSupplyEvent.TurnOffMasterKey);
                     SignalEventToBatterySwitch(PowerSupplyEvent.QuickPowerOff);

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/ElectricPowerSupply.cs

@@ -309,12 +309,12 @@ public override void HandleEvent(PowerSupplyEvent evt)
                     SignalEventToMasterKey(PowerSupplyEvent.TurnOnMasterKey);
                     SignalEventToPantograph(PowerSupplyEvent.RaisePantograph, 1);
                     SignalEventToOtherTrainVehiclesWithId(PowerSupplyEvent.RaisePantograph, 1);
-                    SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.SwitchOnElectricTrainSupply);
+                    SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.QuickPowerOn);
                     break;
 
                 case PowerSupplyEvent.QuickPowerOff:
                     QuickPowerOn = false;
-                    SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.SwitchOffElectricTrainSupply);
+                    SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.QuickPowerOff);
                     SignalEventToCircuitBreaker(PowerSupplyEvent.QuickPowerOff);
                     SignalEventToPantographs(PowerSupplyEvent.LowerPantograph);
                     SignalEventToOtherTrainVehicles(PowerSupplyEvent.LowerPantograph);

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/ElectricTrainSupplySwitch.cs

@@ -37,6 +37,27 @@ public enum ModeType
         readonly MSTSLocomotive Locomotive;
         public bool CommandSwitch { get; protected set; } = false;
         public bool On { get; protected set; } = false;
+        public bool QuickPowerOn = false;
+        private bool firstUpdate = true;
+
+        /// <summary>
+        /// Number of cars that require energy from the electric train supply
+        /// </summary>
+        protected int NumberOfElectricTrainSupplyConnectedCars
+        {
+            get
+            {
+                int count = 0;
+                foreach (var car in Locomotive.Train.Cars)
+                {
+                    if (car == null) continue;
+                    if (!(car is MSTSWagon wagon)) continue;
+                    if (!(wagon.PassengerCarPowerSupply?.ElectricTrainSupplyConnectedLocomotives.Contains(Locomotive) ?? false)) continue;
+                    count++;
+                }
+                return count;
+            }
+        }
 
         public ElectricTrainSupplySwitch(MSTSLocomotive locomotive, ModeType defaultMode = ModeType.Automatic)
         {
@@ -122,15 +143,15 @@ public virtual void Update(float elapsedClockSeconds)
                 case ModeType.Automatic:
                     if (On)
                     {
-                        if (!Locomotive.LocomotivePowerSupply.AuxiliaryPowerSupplyOn)
+                        if (!Locomotive.LocomotivePowerSupply.AuxiliaryPowerSupplyOn || NumberOfElectricTrainSupplyConnectedCars == 0)
                         {
                             On = false;
                             Locomotive.SignalEvent(Event.ElectricTrainSupplyOff);
                         }
                     }
                     else
                     {
-                        if (Locomotive.LocomotivePowerSupply.AuxiliaryPowerSupplyOn)
+                        if (Locomotive.LocomotivePowerSupply.AuxiliaryPowerSupplyOn && NumberOfElectricTrainSupplyConnectedCars > 0)
                         {
                             On = true;
                             Locomotive.SignalEvent(Event.ElectricTrainSupplyOn);
@@ -139,6 +160,19 @@ public virtual void Update(float elapsedClockSeconds)
                     break;
 
                 case ModeType.Switch:
+                    if (QuickPowerOn && !firstUpdate)
+                    {
+                        if (NumberOfElectricTrainSupplyConnectedCars == 0 || CommandSwitch)
+                        {
+                            QuickPowerOn = false;
+                        }
+                        else if (Locomotive.LocomotivePowerSupply.AuxiliaryPowerSupplyOn)
+                        {
+                            QuickPowerOn = false;
+                            CommandSwitch = true;
+                            Locomotive.SignalEvent(Event.ElectricTrainSupplyCommandOn);
+                        }
+                    }
                     if (On)
                     {
                         if (!CommandSwitch || !Locomotive.LocomotivePowerSupply.AuxiliaryPowerSupplyOn)
@@ -157,12 +191,19 @@ public virtual void Update(float elapsedClockSeconds)
                     }
                     break;
             }
+            firstUpdate = false;
         }
 
         public virtual void HandleEvent(PowerSupplyEvent evt)
         {
             switch (evt)
             {
+                case PowerSupplyEvent.QuickPowerOn:
+                    if (Mode == ModeType.Switch)
+                    {
+                        QuickPowerOn = true;
+                    }
+                    break;
                 case PowerSupplyEvent.SwitchOnElectricTrainSupply:
                     if (Mode == ModeType.Switch)
                     {
@@ -172,6 +213,8 @@ public virtual void HandleEvent(PowerSupplyEvent evt)
                     break;
 
                 case PowerSupplyEvent.SwitchOffElectricTrainSupply:
+                case PowerSupplyEvent.QuickPowerOff:
+                    QuickPowerOn = false;
                     if (Mode == ModeType.Switch)
                     {
                         CommandSwitch = false;

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/SteamPowerSupply.cs

@@ -109,11 +109,11 @@ public override void HandleEvent(PowerSupplyEvent evt)
                     SignalEventToMasterKey(PowerSupplyEvent.TurnOnMasterKey);
                     SignalEventToPantograph(PowerSupplyEvent.RaisePantograph, 1);
                     SignalEventToOtherTrainVehiclesWithId(PowerSupplyEvent.RaisePantograph, 1);
-                    SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.SwitchOnElectricTrainSupply);
+                    SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.QuickPowerOn);
                     break;
 
                 case PowerSupplyEvent.QuickPowerOff:
-                    SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.SwitchOffElectricTrainSupply);
+                    SignalEventToElectricTrainSupplySwitch(PowerSupplyEvent.QuickPowerOff);
                     SignalEventToPantographs(PowerSupplyEvent.LowerPantograph);
                     SignalEventToOtherTrainVehicles(PowerSupplyEvent.LowerPantograph);
                     SignalEventToMasterKey(PowerSupplyEvent.TurnOffMasterKey);