Send TCS pantograph orders via power supply events

cesarBLG · cesarBLG · commit b5d21b48df8b · 2024-11-08T12:58:09.000+01:00
diff --git a/Source/Orts.Simulation/Common/Scripting/PowerSupply/LocomotivePowerSupply.cs b/Source/Orts.Simulation/Common/Scripting/PowerSupply/LocomotivePowerSupply.cs
@@ -508,6 +508,46 @@ public virtual void HandleEventFromOtherLocomotive(int locoIndex, PowerSupplyEve
 
         }
 
+        /// <summary>
+        /// Called when the TCS wants to transmit an event to power supply
+        /// </summary>
+        /// <param name="evt"></param>
+        public virtual void HandleEventFromTcs(PowerSupplyEvent evt)
+        {
+            switch (evt)
+            {
+                case PowerSupplyEvent.LowerPantograph:
+                case PowerSupplyEvent.RaisePantograph:
+                    SignalEventToPantographs(evt);
+                    SignalEventToOtherTrainVehicles(evt);
+                    break;
+            }
+        }
+
+        /// <summary>
+        /// Called when the TCS wants to transmit an event to power supply
+        /// </summary>
+        /// <param name="evt"></param>
+        /// <param name="id"></param>
+        public virtual void HandleEventFromTcs(PowerSupplyEvent evt, int id)
+        {
+            switch (evt)
+            {
+                case PowerSupplyEvent.LowerPantograph:
+                case PowerSupplyEvent.RaisePantograph:
+                    SignalEventToPantograph(evt, id);
+                    SignalEventToOtherTrainVehiclesWithId(evt, id);
+                    break;
+            }
+        }
+
+        /// <summary>
+        /// Called when the TCS wants to transmit an event and/or a message to power supply
+        /// </summary>
+        /// <param name="evt"></param>
+        /// <param name="message"></param>
+        public virtual void HandleEventFromTcs(PowerSupplyEvent evt, string message) {}
+
         protected bool GetBoolParameter(string sectionName, string keyName, bool defaultValue) => LoadParameter(sectionName, keyName, defaultValue);
         protected int GetIntParameter(string sectionName, string keyName, int defaultValue) => LoadParameter(sectionName, keyName, defaultValue);
         protected float GetFloatParameter(string sectionName, string keyName, float defaultValue) => LoadParameter(sectionName, keyName, defaultValue);
diff --git a/Source/Orts.Simulation/Common/Scripting/PowerSupply/PowerSupply.cs b/Source/Orts.Simulation/Common/Scripting/PowerSupply/PowerSupply.cs
@@ -113,13 +113,6 @@ public virtual void HandleEvent(PowerSupplyEvent evt, int id)
             SignalEventToPantograph(evt, id);
         }
 
-        /// <summary>
-        /// Called when the TCS wants to transmit an event and/or a message to power supply
-        /// </summary>
-        /// <param name="evt"></param>
-        /// <param name="message"></param>
-        public virtual void HandleEventFromTcs(PowerSupplyEvent evt, string message) {}
-
         public virtual void HandleEventFromLeadLocomotive(PowerSupplyEvent evt)
         {
             // By default, send the event to every component
diff --git a/Source/Orts.Simulation/Common/Scripting/TrainControlSystem.cs b/Source/Orts.Simulation/Common/Scripting/TrainControlSystem.cs
@@ -533,12 +533,32 @@ internal void AttachToHost(ScriptedTrainControlSystem host)
         /// </summary>
         public Func<string, string, string, string> GetStringParameter;
 
+
+        /// <summary>
+        /// Sends an event to the power supply
+        /// </summary>
+        /// <param name="evt">The event to send</param>
+        public void SignalEventToPowerSupply(PowerSupplyEvent evt)
+        {
+            Locomotive.LocomotivePowerSupply.HandleEventFromTcs(evt);
+        }
+
+        /// <summary>
+        /// Sends an event to the power supply
+        /// </summary>
+        /// <param name="evt">The event to send</param>
+        /// <param name="id">Additional id for the event</param>
+        public void SignalEventToPowerSupply(PowerSupplyEvent evt, int id)
+        {
+            Locomotive.LocomotivePowerSupply.HandleEventFromTcs(evt, id);
+        }
+
         /// <summary>
         /// Sends an event and/or a message to the power supply
         /// </summary>
         /// <param name="evt">The event to send</param>
         /// <param name="message">The message to send</param>
-        public void SignalEventToPowerSupply(PowerSupplyEvent evt = PowerSupplyEvent.MessageFromTcs, string message = "")
+        public void SignalEventToPowerSupply(PowerSupplyEvent evt, string message)
         {
             Locomotive.LocomotivePowerSupply.HandleEventFromTcs(evt, message);
         }
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/ILocomotivePowerSupply.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/ILocomotivePowerSupply.cs
@@ -45,6 +45,8 @@ public interface ILocomotivePowerSupply : IPowerSupply
         bool ServiceRetentionCancellationButton { get; set; }
         bool ServiceRetentionActive { get; set; }
 
+        void HandleEventFromTcs(PowerSupplyEvent evt);
+        void HandleEventFromTcs(PowerSupplyEvent evt, int id);
         void HandleEventFromTcs(PowerSupplyEvent evt, string message);
         void HandleEventFromOtherLocomotive(int locoIndex, PowerSupplyEvent evt);
         void HandleEventFromOtherLocomotive(int locoIndex, PowerSupplyEvent evt, int id);
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/LocomotivePowerSupply.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/LocomotivePowerSupply.cs
@@ -262,6 +262,16 @@ public void HandleEvent(PowerSupplyEvent evt, int id)
             AbstractScript?.HandleEvent(evt, id);
         }
 
+        public void HandleEventFromTcs(PowerSupplyEvent evt)
+        {
+            AbstractScript?.HandleEventFromTcs(evt);
+        }
+
+        public void HandleEventFromTcs(PowerSupplyEvent evt, int id)
+        {
+            AbstractScript?.HandleEventFromTcs(evt, id);
+        }
+
         public void HandleEventFromTcs(PowerSupplyEvent evt, string message)
         {
             AbstractScript?.HandleEventFromTcs(evt, message);
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/SteamPowerSupply.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/SteamPowerSupply.cs
@@ -213,6 +213,14 @@ public void HandleEvent(PowerSupplyEvent evt, int id)
         {
         }
 
+        public void HandleEventFromTcs(PowerSupplyEvent evt)
+        {
+        }
+
+        public void HandleEventFromTcs(PowerSupplyEvent evt, int id)
+        {
+        }
+
         public void HandleEventFromTcs(PowerSupplyEvent evt, string message)
         {
         }
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/TrainControlSystem.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/TrainControlSystem.cs
@@ -432,7 +432,7 @@ public void Initialize()
                 {
                     if (Locomotive.Pantographs.State == PantographState.Up)
                     {
-                        Locomotive.Train.SignalEvent(PowerSupplyEvent.LowerPantograph);
+                        Locomotive.LocomotivePowerSupply.HandleEvent(PowerSupplyEvent.LowerPantograph);
                     }
                 };
                 Script.SetPantographUp = (pantoID) =>
@@ -442,7 +442,7 @@ public void Initialize()
                         Trace.TraceError($"TCS script used bad pantograph ID {pantoID}");
                         return;
                     }
-                    Locomotive.Train.SignalEvent(PowerSupplyEvent.RaisePantograph, pantoID);
+                    Locomotive.LocomotivePowerSupply.HandleEvent(PowerSupplyEvent.RaisePantograph, pantoID);
                 };               
                 Script.SetPantographDown = (pantoID) =>
                 {
@@ -451,7 +451,7 @@ public void Initialize()
                         Trace.TraceError($"TCS script used bad pantograph ID {pantoID}");
                         return;
                     }
-                    Locomotive.Train.SignalEvent(PowerSupplyEvent.LowerPantograph, pantoID);
+                    Locomotive.LocomotivePowerSupply.HandleEvent(PowerSupplyEvent.LowerPantograph, pantoID);
                 };
                 Script.SetPowerAuthorization = (value) => PowerAuthorization = value;
                 Script.SetCircuitBreakerClosingOrder = (value) => CircuitBreakerClosingOrder = value;
@@ -898,12 +898,7 @@ public void HandleEvent(TCSEvent evt, int eventIndex)
             HandleEvent(evt, message);
         }
 
-        public void HandleEvent(PowerSupplyEvent evt)
-        {
-            HandleEvent(evt, String.Empty);
-        }
-
-        public void HandleEvent(PowerSupplyEvent evt, string message)
+        public void HandleEvent(PowerSupplyEvent evt, string message="")
         {
             Script?.HandleEvent(evt, message);
         }

Original file line number	Diff line number	Diff line change
`@@ -113,13 +113,6 @@ public virtual void HandleEvent(PowerSupplyEvent evt, int id)`
`113`	`113`	`SignalEventToPantograph(evt, id);`
`114`	`114`	`}`
`115`	`115`
`116`		`- /// <summary>`
`117`		`- /// Called when the TCS wants to transmit an event and/or a message to power supply`
`118`		`- /// </summary>`
`119`		`- /// <param name="evt"></param>`
`120`		`- /// <param name="message"></param>`
`121`		`- public virtual void HandleEventFromTcs(PowerSupplyEvent evt, string message) {}`
`122`		`-`
`123`	`116`	`public virtual void HandleEventFromLeadLocomotive(PowerSupplyEvent evt)`
`124`	`117`	`{`
`125`	`118`	`// By default, send the event to every component`
Original file line number	Diff line number	Diff line change
`@@ -213,6 +213,14 @@ public void HandleEvent(PowerSupplyEvent evt, int id)`
`213`	`213`	`{`
`214`	`214`	`}`
`215`	`215`
	`216`	`+ public void HandleEventFromTcs(PowerSupplyEvent evt)`
	`217`	`+ {`
	`218`	`+ }`
	`219`	`+`
	`220`	`+ public void HandleEventFromTcs(PowerSupplyEvent evt, int id)`
	`221`	`+ {`
	`222`	`+ }`
	`223`	`+`
`216`	`224`	`public void HandleEventFromTcs(PowerSupplyEvent evt, string message)`
`217`	`225`	`{`
`218`	`226`	`}`
Original file line number	Diff line number	Diff line change
`@@ -432,7 +432,7 @@ public void Initialize()`
`432`	`432`	`{`
`433`	`433`	`if (Locomotive.Pantographs.State == PantographState.Up)`
`434`	`434`	`{`
`435`		`- Locomotive.Train.SignalEvent(PowerSupplyEvent.LowerPantograph);`
	`435`	`+ Locomotive.LocomotivePowerSupply.HandleEvent(PowerSupplyEvent.LowerPantograph);`
`436`	`436`	`}`
`437`	`437`	`};`
`438`	`438`	`Script.SetPantographUp = (pantoID) =>`
`@@ -442,7 +442,7 @@ public void Initialize()`
`442`	`442`	`Trace.TraceError($"TCS script used bad pantograph ID {pantoID}");`
`443`	`443`	`return;`
`444`	`444`	`}`
`445`		`- Locomotive.Train.SignalEvent(PowerSupplyEvent.RaisePantograph, pantoID);`
	`445`	`+ Locomotive.LocomotivePowerSupply.HandleEvent(PowerSupplyEvent.RaisePantograph, pantoID);`
`446`	`446`	`};`
`447`	`447`	`Script.SetPantographDown = (pantoID) =>`
`448`	`448`	`{`
`@@ -451,7 +451,7 @@ public void Initialize()`
`451`	`451`	`Trace.TraceError($"TCS script used bad pantograph ID {pantoID}");`
`452`	`452`	`return;`
`453`	`453`	`}`
`454`		`- Locomotive.Train.SignalEvent(PowerSupplyEvent.LowerPantograph, pantoID);`
	`454`	`+ Locomotive.LocomotivePowerSupply.HandleEvent(PowerSupplyEvent.LowerPantograph, pantoID);`
`455`	`455`	`};`
`456`	`456`	`Script.SetPowerAuthorization = (value) => PowerAuthorization = value;`
`457`	`457`	`Script.SetCircuitBreakerClosingOrder = (value) => CircuitBreakerClosingOrder = value;`
`@@ -898,12 +898,7 @@ public void HandleEvent(TCSEvent evt, int eventIndex)`
`898`	`898`	`HandleEvent(evt, message);`
`899`	`899`	`}`
`900`	`900`
`901`		`- public void HandleEvent(PowerSupplyEvent evt)`
`902`		`- {`
`903`		`- HandleEvent(evt, String.Empty);`
`904`		`- }`
`905`		`-`
`906`		`- public void HandleEvent(PowerSupplyEvent evt, string message)`
	`901`	`+ public void HandleEvent(PowerSupplyEvent evt, string message="")`
`907`	`902`	`{`
`908`	`903`	`Script?.HandleEvent(evt, message);`
`909`	`904`	`}`