Automatic merge of T1.6-rc8-48-ga5be12922 and 14 pull requests

- Pull request #1086 at e10390b: Add Settings Exporter tool (copy settings to INI, etc)
- Pull request #1091 at 2e06f85: Automatic speed control
- Pull request #1104 at ccc5c4d: Handle simple adhesion within the axle module
- Pull request #1115 at 270f22f: Do not activate ETS switch if no suitable cars are attached
- Pull request #1120 at ba3c47f: Automatically Calculate Friction Values if Missing
- Pull request #1121 at 91d2d26: Manually Override Articulation
- Pull request #1124 at e241a0d: Built-in PBL2 brake controller
- Pull request #1130 at 8ae6bb7: Fix F9 points to an incorrect car ID.
- Pull request #1143 at ba9e40a: Status in Work Orders popup set too fast
- Pull request #1152 at 66dfd09: fix: Clean up multiple issues with data logger
- Pull request #1155 at 40f8c34: fix for illegal characters in refeerence to Shape file
- Pull request #1157 at 39cd994: Dynamic brake authorization by TCS
- Pull request #1082 at 5845a1a: Allow variable water level in glass gauge
- Pull request #1128 at 1d7643d: Particle Emitter Overhaul

Author: openrails-bot

Source/Documentation/Manual/physics.rst

@@ -5537,16 +5537,14 @@ the tables below.
 .. index::
    single: DoesBrakeCutPower
    single: BrakeCutsPowerAtBrakeCylinderPressure
-   single: ORTSBrakeCutsPowerAtBrakePipePressure
-   single: ORTSBrakeRestoresPowerAtBrakePipePressure
+   single: OrtsEmergencyBrakeCutsDynamicBrake
 
-Other parameters in the Engine section of the ENG file are used by the braking system to request traction cut-off to the TCS:
+Other parameters in the Engine section of the ENG file are used by the TCS:
 
-- ``DoesBrakeCutPower( x )`` sets whether applying brake on the locomotive cuts the traction for air brake system (1 for enabled, 0 for disabled)
-- ``ORTSDoesVacuumBrakeCutPower( x )`` sets whether applying brake on the locomotive cuts the traction for vacuum brake system (1 for enabled, 0 for disabled)
+- ``DoesBrakeCutPower( x )`` sets whether applying brake on the locomotive cuts the traction (1 for enabled, 0 for disabled)
 - ``BrakeCutsPowerAtBrakeCylinderPressure( x )`` sets the minimum pressure in the brake cylinder that cuts the traction (by default 4 PSI)
-- ``ORTSBrakeCutsPowerAtBrakePipePressure( x )`` sets the maximum pressure in the brake pipe that cuts the traction
-- ``ORTSBrakeRestoresPowerAtBrakePipePressure( x )`` sets the minimum pressure in the brake pipe that restores the traction
+- ``OrtsEmergencyBrakeCutsDynamicBrake`` sets whether an emergency braking disables dynamic brakes
+
 
 Train Derailment
 ----------------

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

@@ -265,14 +265,13 @@ internal void AttachToHost(ScriptedTrainControlSystem host)
         /// </summary>
         public Func<bool> DoesBrakeCutPower;
         /// <summary>
-        /// Deprecated. Returns positive infinity if traction cutoff is requested by the brake system, and negative infinity if it is not requested
+        /// Train brake pressure value which triggers the power cut-off.
         /// </summary>
-        [Obsolete("BrakeCutsPowerAtBrakeCylinderPressureBar() is deprecated, use BrakeSystemTractionAuthorization instead")]
-        public float BrakeCutsPowerAtBrakeCylinderPressureBar()
-        {
-            return BrakeSystemTractionAuthorization ? float.PositiveInfinity : float.NegativeInfinity;
-        }
-        public bool BrakeSystemTractionAuthorization => Host.BrakeSystemTractionAuthorization;
+        public Func<float> BrakeCutsPowerAtBrakeCylinderPressureBar;
+        /// <summary>
+        /// True if dynamic brake must be cut if the emergency brake is applied.
+        /// </summary>
+        public bool EmergencyBrakeCutsDynamicBrake => Locomotive.EmergencyBrakeCutsDynamicBrake;
         /// <summary>
         /// State of the train brake controller.
         /// </summary>

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

@@ -298,6 +298,7 @@ public enum SlipControlType
         public float LargeEjectorBrakePipeChargingRatePSIorInHgpS;
         public float ExhausterHighSBPChargingRatePSIorInHgpS;  // Rate for Exhauster in high speed mode
         public float ExhausterLowSBPChargingRatePSIorInHgpS;  // Rate for Exhauster in high speed mode
+        public bool VacuumBrakeCutoffActivated = false;
         public bool BrakeFlagDecrease = false;
         public bool BrakeFlagIncrease = false;
 
@@ -463,6 +464,7 @@ public float OdometerM
         public float BrakeCutsPowerAtBrakePipePressurePSI;
         public bool DoesVacuumBrakeCutPower { get; private set; }
         public bool DoesBrakeCutPower { get; private set; }
+        public bool EmergencyBrakeCutsDynamicBrake { get; private set; }
         public float BrakeCutsPowerAtBrakeCylinderPressurePSI { get; private set; }
         public bool DoesHornTriggerBell { get; private set; }
         public bool DPSyncTrainApplication { get; private set; }
@@ -1119,6 +1121,7 @@ public override void Parse(string lowercasetoken, STFReader stf)
                 case "engine(brakecutspoweratbrakecylinderpressure": BrakeCutsPowerAtBrakeCylinderPressurePSI = stf.ReadFloatBlock(STFReader.UNITS.PressureDefaultPSI, null); break;
                 case "engine(ortsbrakecutspoweratbrakepipepressure": BrakeCutsPowerAtBrakePipePressurePSI = stf.ReadFloatBlock(STFReader.UNITS.PressureDefaultPSI, null); break;
                 case "engine(ortsbrakerestorespoweratbrakepipepressure": BrakeRestoresPowerAtBrakePipePressurePSI = stf.ReadFloatBlock(STFReader.UNITS.PressureDefaultPSI, null); break;
+                case "engine(ortsemergencybrakecutsdynamicbrake": EmergencyBrakeCutsDynamicBrake = stf.ReadBoolBlock(false); break;
                 case "engine(doeshorntriggerbell": DoesHornTriggerBell = stf.ReadBoolBlock(false); break;
                 case "engine(ortshornlightstimer": HornTimerS = stf.ReadFloatBlock(STFReader.UNITS.Time, null); break;
                 case "engine(ortsbelllightstimer": BellTimerS = stf.ReadFloatBlock(STFReader.UNITS.Time, null); break;
@@ -1338,6 +1341,7 @@ public override void Copy(MSTSWagon copy)
             BrakeCutsPowerAtBrakeCylinderPressurePSI = locoCopy.BrakeCutsPowerAtBrakeCylinderPressurePSI;
             BrakeCutsPowerAtBrakePipePressurePSI = locoCopy.BrakeCutsPowerAtBrakePipePressurePSI;
             BrakeRestoresPowerAtBrakePipePressurePSI = locoCopy.BrakeRestoresPowerAtBrakePipePressurePSI;
+            EmergencyBrakeCutsDynamicBrake = locoCopy.EmergencyBrakeCutsDynamicBrake;
             DynamicBrakeCommandStartTime = locoCopy.DynamicBrakeCommandStartTime;
             DynamicBrakeBlendingOverride = locoCopy.DynamicBrakeBlendingOverride;
             DynamicBrakeBlendingForceMatch = locoCopy.DynamicBrakeBlendingForceMatch;
@@ -1853,17 +1857,17 @@ public override void Initialize()
 
             }
 
-            if ((DoesBrakeCutPower || DoesVacuumBrakeCutPower) && BrakeCutsPowerAtBrakePipePressurePSI > BrakeRestoresPowerAtBrakePipePressurePSI)
+            if (DoesBrakeCutPower && BrakeCutsPowerAtBrakePipePressurePSI > BrakeRestoresPowerAtBrakePipePressurePSI)
             {
                 BrakeCutsPowerAtBrakePipePressurePSI = BrakeRestoresPowerAtBrakePipePressurePSI - 1.0f;
 
                 if (Simulator.Settings.VerboseConfigurationMessages)
                 {
-                    Trace.TraceInformation("BrakeCutsPowerAtBrakePipePressure is greater then BrakeRestoresPowerAtBrakePipePressure, and has been set to value of {0}", FormatStrings.FormatPressure(BrakeCutsPowerAtBrakePipePressurePSI, PressureUnit.PSI, BrakeSystemPressureUnits[BrakeSystemComponent.BrakePipe], true));
+                    Trace.TraceInformation("BrakeCutsPowerAtBrakePipePressure is greater then BrakeRestoresPowerAtBrakePipePressurePSI, and has been set to value of {0} InHg", Bar.ToInHg(Bar.FromPSI(BrakeCutsPowerAtBrakePipePressurePSI)));
                 }
             }
 
-            if (DoesVacuumBrakeCutPower && BrakeSystem is VacuumSinglePipe && (BrakeRestoresPowerAtBrakePipePressurePSI == 0 || BrakeRestoresPowerAtBrakePipePressurePSI > OneAtmospherePSI))
+            if (DoesBrakeCutPower && (BrakeSystem is VacuumSinglePipe) && (BrakeRestoresPowerAtBrakePipePressurePSI == 0 || BrakeRestoresPowerAtBrakePipePressurePSI > OneAtmospherePSI))
             {
                 BrakeRestoresPowerAtBrakePipePressurePSI = Bar.ToPSI(Bar.FromInHg(15.0f)); // Power can be restored once brake pipe rises above 15 InHg
 

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/Brakes/MSTS/AirSinglePipe.cs

@@ -1188,18 +1188,6 @@ public void UpdateAngleCockState(bool AngleCockOpen, ref float AngleCockOpenAmou
             }
         }
 
-        public virtual void UpdateTractionCutoff()
-        {
-            var locomotive = Car as MSTSLocomotive;
-            if (!locomotive.DoesBrakeCutPower) return;
-            if (locomotive.BrakeCutsPowerAtBrakePipePressurePSI > 0)
-            {
-                if (BrakeLine1PressurePSI < locomotive.BrakeCutsPowerAtBrakePipePressurePSI) locomotive.TrainControlSystem.BrakeSystemTractionAuthorization = false;
-                else if (BrakeLine1PressurePSI >= locomotive.BrakeRestoresPowerAtBrakePipePressurePSI) locomotive.TrainControlSystem.BrakeSystemTractionAuthorization = true;
-            }
-            else locomotive.TrainControlSystem.BrakeSystemTractionAuthorization = CylPressurePSI <= locomotive.BrakeCutsPowerAtBrakeCylinderPressurePSI;
-        }
-
         public override void Update(float elapsedClockSeconds)
         {
             var valveType = BrakeValve;
@@ -1966,8 +1954,6 @@ public override void Update(float elapsedClockSeconds)
 
             }
 
-            if (Car is MSTSLocomotive) UpdateTractionCutoff();
-                       
             // Record HUD display values for brake cylinders depending upon whether they are wagons or locomotives/tenders (which are subject to their own engine brakes)   
             if (Car.WagonType == MSTSWagon.WagonTypes.Engine || Car.WagonType == MSTSWagon.WagonTypes.Tender)
             {

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/Brakes/MSTS/VacuumSinglePipe.cs

@@ -453,19 +453,25 @@ public override void Update(float elapsedClockSeconds)
                 float BrakeCutoffPressurePSI = OneAtmospherePSI - lead.BrakeCutsPowerAtBrakePipePressurePSI;
                 float BrakeRestorePressurePSI = OneAtmospherePSI - lead.BrakeRestoresPowerAtBrakePipePressurePSI;
 
-                if (Car is MSTSLocomotive locomotive && locomotive.DoesVacuumBrakeCutPower)
+                if (lead.DoesVacuumBrakeCutPower)
                 {
+
                     // There are three zones of operation - (note logic reversed - O InHg = 14.73psi, and eg 21 InHg = 4.189psi)
                     // Cutoff - exceeds set value, eg 12.5InHg (= 8.5psi)
                     // Between cutoff and restore levels - only if cutoff has triggerd
                     // Restore - when value exceeds set value, eg 17InHg (= 6.36 psi) - resets throttle
                     if (BrakeLine1PressurePSI < BrakeRestorePressurePSI)
                     {
-                        locomotive.TrainControlSystem.BrakeSystemTractionAuthorization = true;
+                        lead.VacuumBrakeCutoffActivated = false;
                     }
                     else if (BrakeLine1PressurePSI > BrakeCutoffPressurePSI)
                     {
-                        locomotive.TrainControlSystem.BrakeSystemTractionAuthorization = false;
+                        lead.MotiveForceN = 0.0f;  // ToDO - This is not a good way to do it, better to be added to MotiveForce Update in MSTSLocomotive(s) when PRs Added
+                        lead.VacuumBrakeCutoffActivated = true;
+                    }
+                    else if (lead.VacuumBrakeCutoffActivated)
+                    {
+                        lead.MotiveForceN = 0.0f; // ToDO - This is not a good way to do it, better to be added to MotiveForce Update in MSTSLocomotive(s) when PRs Added
                     }
                 }
             }

Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/TrainControlSystem.cs

@@ -153,7 +153,6 @@ protected set
         public bool DynamicBrakingAuthorization { get; private set; }
         public float MaxThrottlePercent { get; private set; } = 100f;
         public bool FullDynamicBrakingOrder { get; private set; }
-        public bool BrakeSystemTractionAuthorization = true;
 
         public Dictionary<int, float> CabDisplayControls = new Dictionary<int, float>();
 
@@ -369,7 +368,8 @@ public void Initialize()
                 Script.DynamicBrakingAuthorization = () => DynamicBrakingAuthorization;
                 Script.BrakePipePressureBar = () => Locomotive.BrakeSystem != null ? Bar.FromPSI(Locomotive.BrakeSystem.BrakeLine1PressurePSI) : float.MaxValue;
                 Script.LocomotiveBrakeCylinderPressureBar = () => Locomotive.BrakeSystem != null ? Bar.FromPSI(Locomotive.BrakeSystem.GetCylPressurePSI()) : float.MaxValue;
-                Script.DoesBrakeCutPower = () => Locomotive.DoesBrakeCutPower || Locomotive.DoesVacuumBrakeCutPower;
+                Script.DoesBrakeCutPower = () => Locomotive.DoesBrakeCutPower;
+                Script.BrakeCutsPowerAtBrakeCylinderPressureBar = () => Bar.FromPSI(Locomotive.BrakeCutsPowerAtBrakeCylinderPressurePSI);
                 Script.TrainBrakeControllerState = () => Locomotive.TrainBrakeController.TrainBrakeControllerState;
                 Script.AccelerationMpSS = () => Locomotive.AccelerationMpSS;
                 Script.AltitudeM = () => Locomotive.WorldPosition.Location.Y;
@@ -1198,7 +1198,8 @@ public override void Update()
                         PowerCut |= ExternalEmergency;
                 }
 
-                SetTractionAuthorization(BrakeSystemTractionAuthorization);
+                SetTractionAuthorization(!DoesBrakeCutPower() || LocomotiveBrakeCylinderPressureBar() < BrakeCutsPowerAtBrakeCylinderPressureBar());
+                SetDynamicBrakingAuthorization(!EmergencyBrakeCutsDynamicBrake || !IsBrakeEmergency());
 
                 SetEmergencyBrake(EmergencyBrake);
                 SetFullBrake(FullBrake);