Merge pull request #1156 from cesarBLG/control-operations-enable

Fix incorrectly disabled options in train operations window

Author: cjakeman

Source/Orts.Simulation/Common/Scripting/PowerSupply/ControlCarPowerSupply.cs

@@ -49,6 +49,7 @@ protected override void SetCurrentMainPowerSupplyState(PowerSupplyState state) {
         protected override void SetCurrentAuxiliaryPowerSupplyState(PowerSupplyState state) {}
         protected override void SetCurrentElectricTrainSupplyState(PowerSupplyState state) {}
         protected override void SetCurrentDynamicBrakeAvailability(bool avail) {}
+        public override PowerSupplyState GetPowerStatus() => PowerSupplyState.Unavailable;
         public void SignalEventToControlActiveLocomotive(PowerSupplyEvent evt)
         {
             ControlActiveLocomotive?.LocomotivePowerSupply.HandleEvent(evt);

Source/Orts.Simulation/Common/Scripting/PowerSupply/DieselPowerSupply.cs

@@ -90,7 +90,27 @@ public float DieselEngineMinRpm
         /// Closing authorization of the traction cut-off relay
         /// </summary>
         public bool TractionCutOffRelayClosingAuthorization() => TractionCutOffRelay.ClosingAuthorization;
-        
+
+        public override PowerSupplyState GetPowerStatus()
+        {
+            var status = base.GetPowerStatus();
+            PowerSupplyState engineStatus;
+            switch (CurrentDieselEnginesState())
+            {
+                case DieselEngineState.Running:
+                    engineStatus = PowerSupplyState.PowerOn;
+                    break;
+                case DieselEngineState.Starting:
+                    engineStatus = PowerSupplyState.PowerOnOngoing;
+                    break;
+                default:
+                    engineStatus = PowerSupplyState.PowerOff;
+                    break;
+            }
+            if (status == engineStatus) return status;
+            return PowerSupplyState.PowerOnOngoing;
+        }
+
         /// <summary>
         /// Sends an event to all diesel engines
         /// </summary>

Source/Orts.Simulation/Common/Scripting/PowerSupply/ElectricPowerSupply.cs

@@ -128,6 +128,34 @@ protected float PantographVoltageVDC
         /// </summary>
         protected void SetFilterVoltageV(float voltage) => EpsHost.FilterVoltageV = voltage;
 
+        public override PowerSupplyState GetPowerStatus()
+        {
+            var status = base.GetPowerStatus();
+            PowerSupplyState electricStatus;
+            switch (CurrentPantographState())
+            {
+                case PantographState.Up:
+                    switch (CurrentCircuitBreakerState())
+                    {
+                        case CircuitBreakerState.Closed:
+                            electricStatus = PowerSupplyState.PowerOn;
+                            break;
+                        default:
+                            electricStatus = PowerSupplyState.PowerOnOngoing;
+                            break;
+                    }
+                    break;
+                case PantographState.Raising:
+                    electricStatus = PowerSupplyState.PowerOnOngoing;
+                    break;
+                default:
+                    electricStatus = PowerSupplyState.PowerOff;
+                    break;
+            }
+            if (status == electricStatus) return status;
+            return PowerSupplyState.PowerOnOngoing;
+        }
+
         /// <summary>
         /// Sends an event to the circuit breaker
         /// </summary>

Source/Orts.Simulation/Common/Scripting/PowerSupply/LocomotivePowerSupply.cs

@@ -293,6 +293,20 @@ protected void SetCustomizedCabviewControlName(int index, string name)
         /// </summary>
         protected virtual void SetCurrentDynamicBrakeAvailability(bool avail) => LpsHost.DynamicBrakeAvailable = avail;
 
+        /// <summary>
+        /// Called by other subsystems to determine whether the locomotive is powered
+        /// </summary>
+        /// <returns>
+        /// PowerSupplyState.PowerOff if the locomotive is unpowered
+        /// PowerSupplyState.PowerOnOngoing if the locomotive is in a power on sequence, but not all subsystems are ready
+        /// PowerSupplyState.PowerOn if the locomotive is ready for service (all necessary subystems are connected)
+        /// </returns>
+        public virtual PowerSupplyState GetPowerStatus()
+        {
+            if (LpsHost.MainPowerSupplyState == LpsHost.AuxiliaryPowerSupplyState) return LpsHost.MainPowerSupplyState;
+            return PowerSupplyState.PowerOnOngoing;
+        }
+
         /// <summary>
         /// Sends an event to the master switch
         /// </summary>

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

@@ -47,6 +47,8 @@ public interface ILocomotivePowerSupply : IPowerSupply
         bool ServiceRetentionCancellationButton { get; set; }
         bool ServiceRetentionActive { get; set; }
 
+        PowerSupplyState GetPowerStatus();
+
         void HandleEventFromTcs(PowerSupplyEvent evt);
         void HandleEventFromTcs(PowerSupplyEvent evt, int id);
         void HandleEventFromTcs(PowerSupplyEvent evt, string message);

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

@@ -266,6 +266,8 @@ public virtual void Update(float elapsedClockSeconds)
             ElectricTrainSupplySwitch.Update(elapsedClockSeconds);
         }
 
+        public PowerSupplyState GetPowerStatus() => AbstractScript?.GetPowerStatus() ?? PowerSupplyState.Unavailable;
+
         public void HandleEvent(PowerSupplyEvent evt)
         {
             AbstractScript?.HandleEvent(evt);

Source/RunActivity/Viewer3D/Popups/TrainCarOperationsViewerWindow.cs

@@ -27,10 +27,12 @@
 using Orts.Simulation.RollingStocks.SubSystems.PowerSupplies;
 using ORTS.Common;
 using ORTS.Common.Input;
+using ORTS.Scripting.Api;
 using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
+using System.Windows.Forms;
 
 namespace Orts.Viewer3D.Popups
 {
@@ -81,10 +83,9 @@ public class TrainCarOperationsViewerWindow : Window
 
         public List<bool> AngleCockAPartiallyOpened = new List<bool>();
         public List<bool> AngleCockBPartiallyOpened = new List<bool>();
-        public string BatteryStatus;
-        string CircuitBreakerState;
+        public bool BatterySwitchOn;
+        public PowerSupplyState PowerSupplyStatus;
         public int LocoRowCount;
-        public string PowerSupplyStatus;
         public int RowsCount;
         public int SpacerRowCount;
         public int SymbolsRowCount;
@@ -437,11 +438,9 @@ void AddSpace(bool full)
                     }
                     if (isElectricDieselLocomotive)
                     {
-                        if (locomotive.GetMultipleUnitsConfiguration() != null)
-                        {
-                            line.Add(new buttonToggleMU(0, 0, textHeight, Owner.Viewer, CarPosition));
-                            AddSpace(false);
-                        }
+                        line.Add(new buttonToggleMU(0, 0, textHeight, Owner.Viewer, CarPosition));
+                        AddSpace(false);
+
                         line.Add(new buttonTogglePower(0, 0, textHeight, Owner.Viewer, CarPosition));
                         AddSpace(false);
                         if ((wagon != null) && (wagon.PowerSupply is IPowerSupply))
@@ -539,10 +538,8 @@ public override void PrepareFrame(ElapsedTime elapsedTime, bool updateFull)
                     carOperations.CarOperationChanged = carOperations.Visible && carOperations.CarOperationChanged;
                 }
                 // Updates power supply status
-                else if (isElectricDieselLocomotive &&
-                     (PowerSupplyStatus != null && PowerSupplyStatus != Owner.Viewer.PlayerTrain.Cars[CarPosition].GetStatus()
-                      || (BatteryStatus != null && BatteryStatus != Owner.Viewer.PlayerTrain.Cars[CarPosition].GetStatus())
-                      || (CircuitBreakerState != null && CircuitBreakerState != (trainCar as MSTSElectricLocomotive).ElectricPowerSupply.CircuitBreaker.State.ToString())))
+                else if ((trainCar is MSTSWagon wagon && wagon.PowerSupply != null && BatterySwitchOn != wagon.PowerSupply.BatterySwitch.On)
+                    || (isElectricDieselLocomotive && PowerSupplyStatus != (trainCar as MSTSLocomotive).LocomotivePowerSupply.GetPowerStatus()))
                 {
                     Layout();
                     UpdateWindowSize();
@@ -898,7 +895,6 @@ public buttonFrontAngleCock(int x, int y, int size, Viewer viewer, TrainCar car,
                 Viewer = viewer;
                 TrainCarViewer = Viewer.TrainCarOperationsViewerWindow;
                 CurrentCar = Viewer.PlayerTrain.Cars[carPosition];
-                var first = car == Viewer.PlayerTrain.Cars.First();
 
                 if (CurrentCar.BrakeSystem is VacuumSinglePipe)
                 {
@@ -908,15 +904,11 @@ public buttonFrontAngleCock(int x, int y, int size, Viewer viewer, TrainCar car,
                 {
                     var carAngleCockAOpenAmount = CurrentCar.BrakeSystem.AngleCockAOpenAmount;
                     var carAngleCockAOpen = (CurrentCar as MSTSWagon).BrakeSystem.AngleCockAOpen;
-                    Texture = !TrainCarViewer.TrainCarOperationsChanged && first ? FrontAngleCockClosed
-                        : carAngleCockAOpenAmount > 0 && carAngleCockAOpenAmount < 1 ? FrontAngleCockPartial
+                    Texture = carAngleCockAOpenAmount > 0 && carAngleCockAOpenAmount < 1 ? FrontAngleCockPartial
                         : carAngleCockAOpen ? FrontAngleCockOpened
                         : FrontAngleCockClosed;
 
-                    if (!first)
-                    {
-                        Click += new Action<Control, Point>(buttonFrontAngleCock_Click);
-                    }
+                    Click += new Action<Control, Point>(buttonFrontAngleCock_Click);
                 }
                 Source = new Rectangle(0, 0, size, size);
             }
@@ -949,7 +941,6 @@ public buttonRearAngleCock(int x, int y, int size, Viewer viewer, TrainCar car,
                 Viewer = viewer;
                 TrainCarViewer = Viewer.TrainCarOperationsViewerWindow;
                 CurrentCar = Viewer.PlayerTrain.Cars[carPosition];
-                var last = car == Viewer.PlayerTrain.Cars.Last();
 
                 if (CurrentCar.BrakeSystem is VacuumSinglePipe)
                 {
@@ -959,15 +950,11 @@ public buttonRearAngleCock(int x, int y, int size, Viewer viewer, TrainCar car,
                 {
                     var carAngleCockBOpenAmount = (CurrentCar as MSTSWagon).BrakeSystem.AngleCockBOpenAmount;
                     var carAngleCockBOpen = (CurrentCar as MSTSWagon).BrakeSystem.AngleCockBOpen;
-                    Texture = last ? RearAngleCockClosed
-                        : carAngleCockBOpenAmount > 0 && carAngleCockBOpenAmount < 1 ? RearAngleCockPartial
+                    Texture = carAngleCockBOpenAmount > 0 && carAngleCockBOpenAmount < 1 ? RearAngleCockPartial
                         : carAngleCockBOpen ? RearAngleCockOpened
                         : RearAngleCockClosed;
 
-                    if (!last)
-                    {
-                        Click += new Action<Control, Point>(buttonRearAngleCock_Click);
-                    }
+                    Click += new Action<Control, Point>(buttonRearAngleCock_Click);
                 }
                 Source = new Rectangle(0, 0, size, size);
             }
@@ -1094,18 +1081,16 @@ class buttonToggleMU : Image
             readonly Viewer Viewer;
             readonly TrainCarOperationsViewerWindow TrainCarViewer;
             readonly TrainCar CurrentCar;
-            readonly string MultipleUnitsConfiguration;
             public buttonToggleMU(int x, int y, int size, Viewer viewer, int carPosition)
                 : base(x, y, size, size)
             {
                 Viewer = viewer;
                 TrainCarViewer = Viewer.TrainCarOperationsViewerWindow;
                 CurrentCar = Viewer.PlayerTrain.Cars[carPosition];
 
-                MultipleUnitsConfiguration = Viewer.PlayerLocomotive.GetMultipleUnitsConfiguration();
-                if (CurrentCar is MSTSDieselLocomotive && MultipleUnitsConfiguration != null)
+                if (CurrentCar is MSTSLocomotive)
                 {
-                    Texture = Viewer.TrainCarOperationsWindow.ModifiedSetting || ((CurrentCar as MSTSLocomotive).RemoteControlGroup == 0 && MultipleUnitsConfiguration != "1") ? MUconnected : MUdisconnected;
+                    Texture = Viewer.TrainCarOperationsWindow.ModifiedSetting || ((CurrentCar as MSTSLocomotive).RemoteControlGroup == 0) ? MUconnected : MUdisconnected;
                 }
                 else
                 {
@@ -1116,12 +1101,12 @@ public buttonToggleMU(int x, int y, int size, Viewer viewer, int carPosition)
             }
             void buttonToggleMU_Click(Control arg1, Point arg2)
             {
-                if (CurrentCar is MSTSDieselLocomotive)
+                if (CurrentCar is MSTSLocomotive)
                 {
                     MSTSLocomotive locomotive = CurrentCar as MSTSLocomotive;
 
                     new ToggleMUCommand(Viewer.Log, locomotive, locomotive.RemoteControlGroup < 0);
-                    if (locomotive.RemoteControlGroup == 0 && MultipleUnitsConfiguration != "1")
+                    if (locomotive.RemoteControlGroup == 0)
                     {
                         Viewer.Simulator.Confirmer.Information(Viewer.Catalog.GetString("MU signal connected"));
                         Texture = MUconnected;
@@ -1167,10 +1152,10 @@ void buttonTogglePower_Click(Control arg1, Point arg2)
                 if ((CurrentCar is MSTSElectricLocomotive) || (CurrentCar is MSTSDieselLocomotive))
                 {
                     MSTSLocomotive locomotive = CurrentCar as MSTSLocomotive;
+                    bool powerOn = locomotive.LocomotivePowerSupply.GetPowerStatus() == PowerSupplyState.PowerOff;
 
-                    new PowerCommand(Viewer.Log, locomotive, !locomotive.LocomotivePowerSupply.MainPowerSupplyOn);
-                    var mainPowerSupplyOn = locomotive.LocomotivePowerSupply.MainPowerSupplyOn;
-                    if (mainPowerSupplyOn)
+                    new PowerCommand(Viewer.Log, locomotive, powerOn);
+                    if (!powerOn)
                         Viewer.Simulator.Confirmer.Information(Viewer.Catalog.GetString("Power OFF command sent"));
                     else
                         Viewer.Simulator.Confirmer.Information(Viewer.Catalog.GetString("Power ON command sent"));
@@ -1183,36 +1168,9 @@ void buttonTogglePower_Click(Control arg1, Point arg2)
             }
             public Texture2D locomotiveStatusPower(int CarPosition)
             {
-                string locomotiveStatus = CurrentCar.GetStatus();
-                foreach (string data in locomotiveStatus.Split('\n').Where((string d) => !string.IsNullOrWhiteSpace(d)))
-                {
-                    string[] parts = data.Split(new string[] { " = " }, 2, StringSplitOptions.None);
-                    string keyPart = parts[0];
-                    string valuePart = parts?[1];
-                    if (keyPart.Contains(Viewer.Catalog.GetParticularString("DieselEngine","Engine")))
-                    {
-                        TrainCarViewer.PowerSupplyStatus = locomotiveStatus;
-                        Texture = valuePart.Contains(Viewer.Catalog.GetParticularString("DieselEngine", "Running")) ? PowerOn
-                           : valuePart.Contains(Viewer.Catalog.GetParticularString("DieselEngine", "Stopped")) ? PowerOff
-                           : PowerChanging;
-                        break;
-                    }
-
-                    MSTSElectricLocomotive locomotive = CurrentCar as MSTSElectricLocomotive;
-                    switch (locomotive.ElectricPowerSupply.CircuitBreaker.State)
-                    {
-                        case ORTS.Scripting.Api.CircuitBreakerState.Closed:
-                            Texture = PowerOn;
-                            break;
-                        case ORTS.Scripting.Api.CircuitBreakerState.Closing:
-                            Texture = PowerChanging;
-                            break;
-                        case ORTS.Scripting.Api.CircuitBreakerState.Open:
-                            Texture = PowerOff;
-                            break;
-                    }
-                    TrainCarViewer.CircuitBreakerState = locomotive.ElectricPowerSupply.CircuitBreaker.State.ToString();
-                }
+                var powerStatus = (CurrentCar as MSTSLocomotive).LocomotivePowerSupply.GetPowerStatus();
+                TrainCarViewer.PowerSupplyStatus = powerStatus;
+                Texture = powerStatus == PowerSupplyState.PowerOn ? PowerOn : powerStatus == PowerSupplyState.PowerOff ? PowerOff : PowerChanging;
                 return Texture;
             }
         }
@@ -1235,6 +1193,7 @@ public ToggleBatterySwitch(int x, int y, int size, Viewer viewer, int carPositio
                     if (wagon.PowerSupply.BatterySwitch.Mode == BatterySwitch.ModeType.AlwaysOn)
                     {
                         Texture = BattAlwaysOn32;
+                        TrainCarViewer.BatterySwitchOn = wagon.PowerSupply.BatterySwitch.On;
                     }
                     else
                     {
@@ -1272,18 +1231,11 @@ void ToggleBatterySwitch_Click(Control arg1, Point arg2)
             }
             public Texture2D locomotiveStatusBattery(int CarPosition)
             {
-                string locomotiveStatus = CurrentCar.GetStatus();
-                foreach (string data in locomotiveStatus.Split('\n').Where((string d) => !string.IsNullOrWhiteSpace(d)))
+                if (CurrentCar is MSTSWagon wagon && wagon.PowerSupply != null)
                 {
-                    string[] parts = data.Split(new string[] { " = " }, 2, StringSplitOptions.None);
-                    string keyPart = parts[0];
-                    string valuePart = parts?[1];
-                    if (keyPart.Contains(Viewer.Catalog.GetString("Battery")))
-                    {
-                        TrainCarViewer.BatteryStatus = locomotiveStatus;
-                        Texture = valuePart.Contains(Viewer.Catalog.GetString("On")) ? BattOn32 : BattOff32;
-                        break;
-                    }
+                    bool on = wagon.PowerSupply.BatterySwitch.On;
+                    TrainCarViewer.BatterySwitchOn = on;
+                    Texture = on ? BattOn32 : BattOff32;
                 }
                 return Texture;
             }