Merge pull request #839 from Csantucci/further-cc-parameters

cesarBLG · web-flow · commit c3fcdaa84986 · 2024-10-29T09:15:33.000+01:00
First phase of https://blueprints.launchpad.net/or/+spec/additional-cruise-control-parameters
diff --git a/Source/Documentation/Manual/cruisecontrol.rst b/Source/Documentation/Manual/cruisecontrol.rst
@@ -138,6 +138,9 @@ A list of the available .eng file CC parameters follows here below.
    "ModeSwitchAllowedWithThrottleNotAtZero", "Switch from manual to auto and vice-versa can occur also when throttle lever is not at 0", "Boolean", "FALSE"
    "DisableManualSwitchToAutoWhenSetSpeedNotAtTop", "Manual Switch to Cruise Control Auto Mode can't occur when speed is not set at maximum value and at the same moment train speed is not 0", "Boolean", "FALSE"
    "UseTrainBrakeAndDynBrake", "CC uses train brake and dyn brake together", "Boolean", "FALSE"
+   "UseDynBrake", "CC uses dyn brake", "Boolean", "TRUE"
+   "TrainBrakeCommandHasPriorityOverCruiseControl", "A manual train braking inhibits Cruise Control to use both dynamic braking and tractive force", "Boolean", "TRUE"
+   "TrainBrakeCommandHasPriorityOverAcceleratingCruiseControl", "A manual train braking inhibits Cruise Control to use tractive force", "Boolean", "TRUE"
    "SpeedDeltaToEnableTrainBrake", "This is the minimum speed delta between actual speed and desired speed for the CC to use also the train brake", "Float(speed)", "5m/s"
    "SpeedDeltaToEnableFullTrainBrake", "This is the minimum speed delta between actual speed and desired speed for the CC to use also the train brake with no reduced intensity", "Float(speed)", "10m/s"
    "TrainBrakeMinPercentValue", "This is the minimum train brake percent used by the CC. 0 means no braking, 100 means full service braking", "Float(percent)", "30"
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs
@@ -4382,7 +4382,7 @@ public void StartTrainBrakeIncrease(float? target)
             AlerterReset(TCSEvent.TrainBrakeChanged);
             TrainBrakeController.StartIncrease(target);
             TrainBrakeController.CommandStartTime = Simulator.ClockTime;
-            if (CruiseControl != null && CruiseControl.TrainBrakeCommandHasPriorityOverCruiseControl)
+            if (CruiseControl != null && (CruiseControl.TrainBrakeCommandHasPriorityOverCruiseControl || CruiseControl.TrainBrakeCommandHasPriorityOverAcceleratingCruiseControl))
             {
                 CruiseControl.TrainBrakePriority = true;
             }
@@ -4471,7 +4471,8 @@ public void SetTrainBrakeValue(float value)
             if (change != 0)
             {
                 new TrainBrakeCommand(Simulator.Log, change > 0, controller.CurrentValue, Simulator.ClockTime);
-                if (change > 0 && CruiseControl != null && CruiseControl.TrainBrakeCommandHasPriorityOverCruiseControl) CruiseControl.TrainBrakePriority = true;
+                if (change > 0 && CruiseControl != null && ( CruiseControl.TrainBrakeCommandHasPriorityOverCruiseControl || CruiseControl.TrainBrakeCommandHasPriorityOverAcceleratingCruiseControl)) 
+                    CruiseControl.TrainBrakePriority = true;
                 SignalEvent(Event.TrainBrakeChange);
                 AlerterReset(TCSEvent.TrainBrakeChanged);
             }
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/CruiseControl.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/CruiseControl.cs
@@ -104,7 +104,6 @@ public enum SpeedSelectorMode { Parking, Neutral, On, Start }
         public float AccelerationRampMaxMpSSS = 0.7f;
         public float AccelerationDemandMpSS;
         public float AccelerationRampMinMpSSS = 0.01f;
-        public bool ResetForceAfterAnyBraking = false;
         public float ThrottleFullRangeIncreaseTimeSeconds = 6;
         public float ThrottleFullRangeDecreaseTimeSeconds = 6;
         public float DynamicBrakeFullRangeIncreaseTimeSeconds;
@@ -134,10 +133,10 @@ public enum SpeedSelectorMode { Parking, Neutral, On, Start }
         public bool DisableCruiseControlOnThrottleAndZeroForce = false;
         public bool DisableCruiseControlOnThrottleAndZeroForceAndZeroSpeed = false;
         public bool ForceResetRequiredAfterBraking = false;
-        public bool ForceResetIncludeDynamicBrake = false;
         public bool ZeroSelectedSpeedWhenPassingToThrottleMode = false;
         public bool DynamicBrakeCommandHasPriorityOverCruiseControl = true;
         public bool TrainBrakeCommandHasPriorityOverCruiseControl = true;
+        public bool TrainBrakeCommandHasPriorityOverAcceleratingCruiseControl = true;
         public bool HasIndependentThrottleDynamicBrakeLever = false;
         public bool HasProportionalSpeedSelector = false;
         public bool SpeedSelectorIsDiscrete = false;
@@ -146,6 +145,7 @@ public enum SpeedSelectorMode { Parking, Neutral, On, Start }
         public bool EnableSelectedSpeedSelectionWhenManualModeSet = false;
         public bool ModeSwitchAllowedWithThrottleNotAtZero = false;
         public bool UseTrainBrakeAndDynBrake = false;
+        public bool UseDynBrake = true;
         protected float SpeedDeltaToEnableTrainBrake = 5;
         protected float SpeedDeltaToEnableFullTrainBrake = 10;
         public float MinimumSpeedForCCEffectMpS = 0;
@@ -167,6 +167,7 @@ public enum SpeedSelectorMode { Parking, Neutral, On, Start }
         protected bool reducingForce = false;
         protected float skidSpeedDegratation = 0;
         public bool TrainBrakePriority = false;
+        public bool TrainBrakePriorityIfCCAccelerating = false;
         public bool WasBraking = false;
         public bool WasForceReset = true;
 
@@ -218,7 +219,6 @@ public CruiseControl(CruiseControl other, MSTSLocomotive locomotive)
             AccelerationTable = other.AccelerationTable;
             AccelerationRampMaxMpSSS = other.AccelerationRampMaxMpSSS;
             AccelerationRampMinMpSSS = other.AccelerationRampMinMpSSS;
-            ResetForceAfterAnyBraking = other.ResetForceAfterAnyBraking;
             ThrottleFullRangeIncreaseTimeSeconds = other.ThrottleFullRangeIncreaseTimeSeconds;
             ThrottleFullRangeDecreaseTimeSeconds = other.ThrottleFullRangeDecreaseTimeSeconds;
             DynamicBrakeFullRangeIncreaseTimeSeconds = other.DynamicBrakeFullRangeIncreaseTimeSeconds;
@@ -246,17 +246,18 @@ public CruiseControl(CruiseControl other, MSTSLocomotive locomotive)
             DisableCruiseControlOnThrottleAndZeroForce = other.DisableCruiseControlOnThrottleAndZeroForce;
             DisableCruiseControlOnThrottleAndZeroForceAndZeroSpeed = other.DisableCruiseControlOnThrottleAndZeroForceAndZeroSpeed;
             ForceResetRequiredAfterBraking = other.ForceResetRequiredAfterBraking;
-            ForceResetIncludeDynamicBrake = other.ForceResetIncludeDynamicBrake;
             ZeroSelectedSpeedWhenPassingToThrottleMode = other.ZeroSelectedSpeedWhenPassingToThrottleMode;
             DynamicBrakeCommandHasPriorityOverCruiseControl = other.DynamicBrakeCommandHasPriorityOverCruiseControl;
             TrainBrakeCommandHasPriorityOverCruiseControl = other.TrainBrakeCommandHasPriorityOverCruiseControl;
+            TrainBrakeCommandHasPriorityOverAcceleratingCruiseControl = other.TrainBrakeCommandHasPriorityOverAcceleratingCruiseControl;
             HasIndependentThrottleDynamicBrakeLever = other.HasIndependentThrottleDynamicBrakeLever;
             HasProportionalSpeedSelector = other.HasProportionalSpeedSelector;
             DisableManualSwitchToAutoWhenSetSpeedNotAtTop = other.DisableManualSwitchToAutoWhenSetSpeedNotAtTop;
             EnableSelectedSpeedSelectionWhenManualModeSet = other.EnableSelectedSpeedSelectionWhenManualModeSet;
             SpeedSelectorIsDiscrete = other.SpeedSelectorIsDiscrete;
             DoComputeNumberOfAxles = other.DoComputeNumberOfAxles;
             UseTrainBrakeAndDynBrake = other.UseTrainBrakeAndDynBrake;
+            UseDynBrake = other.UseDynBrake;
             SpeedDeltaToEnableTrainBrake = other.SpeedDeltaToEnableTrainBrake;
             SpeedDeltaToEnableFullTrainBrake = other.SpeedDeltaToEnableFullTrainBrake;
             MinimumSpeedForCCEffectMpS = other.MinimumSpeedForCCEffectMpS;
@@ -280,7 +281,6 @@ public void Parse(STFReader stf)
                     case "speedselectorsteptimeseconds": SpeedSelectorStepTimeSeconds = stf.ReadFloatBlock(STFReader.UNITS.Any, 0.1f); break;
                     case "throttlefullrangeincreasetimeseconds": ThrottleFullRangeIncreaseTimeSeconds = stf.ReadFloatBlock(STFReader.UNITS.Any, 5); break;
                     case "throttlefullrangedecreasetimeseconds": ThrottleFullRangeDecreaseTimeSeconds = stf.ReadFloatBlock(STFReader.UNITS.Any, 5); break;
-                    case "resetforceafteranybraking": ResetForceAfterAnyBraking = stf.ReadBoolBlock(false); break;
                     case "dynamicbrakefullrangeincreasetimeseconds": DynamicBrakeFullRangeIncreaseTimeSeconds = stf.ReadFloatBlock(STFReader.UNITS.Any, 5); break;
                     case "dynamicbrakefullrangedecreasetimeseconds": DynamicBrakeFullRangeDecreaseTimeSeconds = stf.ReadFloatBlock(STFReader.UNITS.Any, 5); break;
                     case "trainbrakefullrangeincreasetimeseconds": TrainBrakeFullRangeIncreaseTimeSeconds = stf.ReadFloatBlock(STFReader.UNITS.Any, 10); break;
@@ -341,14 +341,15 @@ public void Parse(STFReader stf)
                     case "usethrottleasspeedselector": UseThrottleAsSpeedSelector = stf.ReadBoolBlock(false); break;
                     case "usethrottleasforceselector": UseThrottleAsForceSelector = stf.ReadBoolBlock(false); break;
                     case "forceresetrequiredafterbraking": ForceResetRequiredAfterBraking = stf.ReadBoolBlock(false); break;
-                    case "forceresetincludedynamicbrake": ForceResetIncludeDynamicBrake = stf.ReadBoolBlock(false); break;
                     case "zeroselectedspeedwhenpassingtothrottlemode": ZeroSelectedSpeedWhenPassingToThrottleMode = stf.ReadBoolBlock(false); break;
                     case "dynamicbrakecommandhaspriorityovercruisecontrol": DynamicBrakeCommandHasPriorityOverCruiseControl = stf.ReadBoolBlock(true); break;
                     case "trainbrakecommandhaspriorityovercruisecontrol": TrainBrakeCommandHasPriorityOverCruiseControl = stf.ReadBoolBlock(true); break;
+                    case "trainbrakecommandhaspriorityoveracceleratingcruisecontrol": TrainBrakeCommandHasPriorityOverAcceleratingCruiseControl = stf.ReadBoolBlock(true); break;
                     case "hasindependentthrottledynamicbrakelever": HasIndependentThrottleDynamicBrakeLever = stf.ReadBoolBlock(false); break;
                     case "hasproportionalspeedselector": HasProportionalSpeedSelector = stf.ReadBoolBlock(false); break;
                     case "speedselectorisdiscrete": SpeedSelectorIsDiscrete = stf.ReadBoolBlock(false); break;
                     case "usetrainbrakeanddynbrake": UseTrainBrakeAndDynBrake = stf.ReadBoolBlock(false); break;
+                    case "usedynbrake": UseDynBrake = stf.ReadBoolBlock(false); break;
                     case "speeddeltatoenabletrainbrake": SpeedDeltaToEnableTrainBrake = stf.ReadFloatBlock(STFReader.UNITS.Speed, 5f); break;
                     case "speeddeltatoenablefulltrainbrake": SpeedDeltaToEnableFullTrainBrake = stf.ReadFloatBlock(STFReader.UNITS.Speed, 10f); break;
                     case "minimumspeedforcceffect": MinimumSpeedForCCEffectMpS = stf.ReadFloatBlock(STFReader.UNITS.Speed, 0f); break;
@@ -506,15 +507,16 @@ public void Update(float elapsedClockSeconds)
                     trainBrakePercent = 0;
                 }
                 else if ((Locomotive.TrainBrakeController.MaxPressurePSI - Locomotive.BrakeSystem.BrakeLine1PressurePSI > 1 ||
-                    Locomotive.Train.BrakeLine4 > 0) && TrainBrakePriority && !CCIsUsingTrainBrake)
+                    Locomotive.Train.BrakeLine4 > 0) && TrainBrakePriority && !CCIsUsingTrainBrake && (TrainBrakeCommandHasPriorityOverAcceleratingCruiseControl && (CCThrottleOrDynBrakePercent > 0 || TrainBrakeCommandHasPriorityOverCruiseControl)))
                 {
                     reducingForce = true;
                     timeFromEngineMoved = 0;
                     if (CCThrottleOrDynBrakePercent > 0)
                         CCThrottleOrDynBrakePercent = 0;
                 }
-                else if (TrainBrakePriority || DynamicBrakePriority || (ThrottleNeutralPosition && SelectedSpeedMpS == 0) || SelectedMaxAccelerationPercent == 0 ||
-                    (ForceResetRequiredAfterBraking &&
+                else if (TrainBrakePriority && (TrainBrakeCommandHasPriorityOverCruiseControl || TrainBrakeCommandHasPriorityOverAcceleratingCruiseControl && CCThrottleOrDynBrakePercent > 0)
+                    || DynamicBrakePriority || (ThrottleNeutralPosition && SelectedSpeedMpS == 0) || SelectedMaxAccelerationPercent == 0 ||
+                    (ForceResetRequiredAfterBraking && (TrainBrakeCommandHasPriorityOverAcceleratingCruiseControl && (CCThrottleOrDynBrakePercent > 0 || TrainBrakeCommandHasPriorityOverCruiseControl)) &&
                         (!WasForceReset || (WasBraking && SelectedMaxAccelerationPercent > 0))))
                 {
                     if (SpeedSelMode == SpeedSelectorMode.Parking)
@@ -528,6 +530,10 @@ public void Update(float elapsedClockSeconds)
                     float prevTrainBrakePercent = trainBrakePercent;
                     CalculateRequiredForce(elapsedClockSeconds, Locomotive.AbsWheelSpeedMpS);
                     CCThrottleOrDynBrakePercent = MathHelper.Clamp(CCThrottleOrDynBrakePercent, -100, 100);
+                    if (CCThrottleOrDynBrakePercent > 0 && ForceResetRequiredAfterBraking && (!WasForceReset || WasBraking && SelectedMaxAccelerationPercent > 0))
+                    {
+                        CCThrottleOrDynBrakePercent = 0;
+                    }
                     if (CCThrottleOrDynBrakePercent >= 0)
                     {
                         Locomotive.ThrottlePercent = CCThrottleOrDynBrakePercent;
@@ -1191,7 +1197,7 @@ public void CalculateRequiredForce(float elapsedClockSeconds, float AbsWheelSpee
                     else
                     {
                         deltaSpeedMpS = SetSpeedMpS + (trainElevation < -0.01 ? trainElevation * (SelectedNumberOfAxles / 12) : 0) - AbsWheelSpeedMpS;
-                        if (Locomotive.DynamicBrakeAvailable)
+                        if (Locomotive.DynamicBrakeAvailable && UseDynBrake)
                         {
                             AccelerationDemandMpSS = (float)-Math.Sqrt(-StartReducingSpeedDeltaDownwards * deltaSpeedMpS);
 
@@ -1237,7 +1243,7 @@ public void CalculateRequiredForce(float elapsedClockSeconds, float AbsWheelSpee
                     }
                     else
                     {
-                        if (Locomotive.DynamicBrakeAvailable)
+                        if (Locomotive.DynamicBrakeAvailable && UseDynBrake)
                         {
                             float val = (float)Math.Abs(StartReducingSpeedDeltaDownwards * coeff * ((deltaSpeedMpS + 0.5f) / 3));
                             AccelerationDemandMpSS = -(float)Math.Sqrt(val);
@@ -1346,7 +1352,10 @@ public void CalculateRequiredForce(float elapsedClockSeconds, float AbsWheelSpee
                 if (speedDiff < AntiWheelSpinSpeedDiffThreshold - 0.05f)
                     skidSpeedDegratation = 0;
                 if (AntiWheelSpinEquipped) CCThrottleOrDynBrakePercent = Math.Max(CCThrottleOrDynBrakePercent - skidSpeedDegratation, 0);
-                if (breakout || Locomotive.TrainBrakeController.MaxPressurePSI - Locomotive.BrakeSystem.BrakeLine1PressurePSI > 1)
+                if (breakout || Locomotive.TrainBrakeController.MaxPressurePSI - Locomotive.BrakeSystem.BrakeLine1PressurePSI > 1
+//                  Following commented line can enable traction also when train is braking
+//                    && TrainBrakeCommandHasPriorityOverCruiseControl
+                    )
                 {
                     CCThrottleOrDynBrakePercent = 0;
                 }
@@ -1385,7 +1394,7 @@ void SetTrainBrake(ref float brakePercent, float elapsedClockSeconds, float delt
         {
             if (deltaSpeedMpS > -SpeedDeltaToEnableFullTrainBrake)
             {
-                bool dynamicBrakeAvailable = Locomotive.DynamicBrakeAvailable && Locomotive.LocomotivePowerSupply.DynamicBrakeAvailable && Locomotive.AbsSpeedMpS > Locomotive.DynamicBrakeSpeed1MpS;
+                bool dynamicBrakeAvailable = Locomotive.DynamicBrakeAvailable && Locomotive.LocomotivePowerSupply.DynamicBrakeAvailable && UseDynBrake && Locomotive.AbsSpeedMpS > Locomotive.DynamicBrakeSpeed1MpS;
                 if (!dynamicBrakeAvailable || deltaSpeedMpS < -SpeedDeltaToEnableTrainBrake)
                 {
                     CCIsUsingTrainBrake = true;

Original file line number	Diff line number	Diff line change
`@@ -4382,7 +4382,7 @@ public void StartTrainBrakeIncrease(float? target)`
`4382`	`4382`	`AlerterReset(TCSEvent.TrainBrakeChanged);`
`4383`	`4383`	`TrainBrakeController.StartIncrease(target);`
`4384`	`4384`	`TrainBrakeController.CommandStartTime = Simulator.ClockTime;`
`4385`		`- if (CruiseControl != null && CruiseControl.TrainBrakeCommandHasPriorityOverCruiseControl)`
	`4385`	`+ if (CruiseControl != null && (CruiseControl.TrainBrakeCommandHasPriorityOverCruiseControl \|\| CruiseControl.TrainBrakeCommandHasPriorityOverAcceleratingCruiseControl))`
`4386`	`4386`	`{`
`4387`	`4387`	`CruiseControl.TrainBrakePriority = true;`
`4388`	`4388`	`}`
`@@ -4471,7 +4471,8 @@ public void SetTrainBrakeValue(float value)`
`4471`	`4471`	`if (change != 0)`
`4472`	`4472`	`{`
`4473`	`4473`	`new TrainBrakeCommand(Simulator.Log, change > 0, controller.CurrentValue, Simulator.ClockTime);`
`4474`		`- if (change > 0 && CruiseControl != null && CruiseControl.TrainBrakeCommandHasPriorityOverCruiseControl) CruiseControl.TrainBrakePriority = true;`
	`4474`	`+ if (change > 0 && CruiseControl != null && ( CruiseControl.TrainBrakeCommandHasPriorityOverCruiseControl \|\| CruiseControl.TrainBrakeCommandHasPriorityOverAcceleratingCruiseControl))`
	`4475`	`+ CruiseControl.TrainBrakePriority = true;`
`4475`	`4476`	`SignalEvent(Event.TrainBrakeChange);`
`4476`	`4477`	`AlerterReset(TCSEvent.TrainBrakeChanged);`
`4477`	`4478`	`}`