Merge pull request #735 from Sharpe49/feature/battery-switch-defaulton

cjakeman · web-flow · commit fd53951b7ebe · 2023-01-21T11:20:26.000Z
Added new parameter for battery switch
diff --git a/Source/Documentation/Manual/physics.rst b/Source/Documentation/Manual/physics.rst
@@ -4313,12 +4313,16 @@ In real life, the battery switch may not
 close instantly, so you can add a delay with the optional parameter
 ``ORTSBattery( Delay ( ) )`` (by default in seconds).
 
+It is possible for the battery switch to be switched on at the start of the simulation.
+To activate this behaviour, you can add the optional parameter ``ORTSBattery( DefaultOn ( 1 ) )``
+
 Example::
 
     Engine (
       ORTSBattery (
         Mode ( PushButtons )
         Delay ( 2s )
+        DefaultOn ( 1 )
       )
     )
 
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSControlTrailerCar.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSControlTrailerCar.cs
@@ -88,6 +88,7 @@ public override void Parse(string lowercasetoken, STFReader stf)
                 case "engine(ortstractioncutoffrelayclosingdelay":
                 case "engine(ortsbattery(mode":
                 case "engine(ortsbattery(delay":
+                case "engine(ortsbattery(defaulton":
                 case "engine(ortsmasterkey(mode":
                 case "engine(ortsmasterkey(delayoff":
                 case "engine(ortsmasterkey(headlightcontrol":
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSDieselLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSDieselLocomotive.cs
@@ -156,6 +156,7 @@ public override void Parse(string lowercasetoken, STFReader stf)
                 case "engine(ortstractioncutoffrelayclosingdelay":
                 case "engine(ortsbattery(mode":
                 case "engine(ortsbattery(delay":
+                case "engine(ortsbattery(defaulton":
                 case "engine(ortsmasterkey(mode":
                 case "engine(ortsmasterkey(delayoff":
                 case "engine(ortsmasterkey(headlightcontrol":
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSElectricLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSElectricLocomotive.cs
@@ -74,6 +74,7 @@ public override void Parse(string lowercasetoken, STFReader stf)
                 case "engine(ortscircuitbreakerclosingdelay":
                 case "engine(ortsbattery(mode":
                 case "engine(ortsbattery(delay":
+                case "engine(ortsbattery(defaulton":
                 case "engine(ortsmasterkey(mode":
                 case "engine(ortsmasterkey(delayoff":
                 case "engine(ortsmasterkey(headlightcontrol":
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSSteamLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSSteamLocomotive.cs
@@ -878,6 +878,7 @@ public override void Parse(string lowercasetoken, STFReader stf)
 
                 case "engine(ortsbattery(mode":
                 case "engine(ortsbattery(delay":
+                case "engine(ortsbattery(defaulton":
                 case "engine(ortsmasterkey(mode":
                 case "engine(ortsmasterkey(delayoff":
                 case "engine(ortsmasterkey(headlightcontrol":
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs
@@ -1411,6 +1411,7 @@ public virtual void Parse(string lowercasetoken, STFReader stf)
                 case "wagon(ortspowerondelay":
                 case "wagon(ortsbattery(mode":
                 case "wagon(ortsbattery(delay":
+                case "wagon(ortsbattery(defaulton":
                 case "wagon(ortspowersupplycontinuouspower":
                 case "wagon(ortspowersupplyheatingpower":
                 case "wagon(ortspowersupplyairconditioningpower":
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/BatterySwitch.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/BatterySwitch.cs
@@ -34,6 +34,7 @@ public enum ModeType
         }
         public ModeType Mode { get; protected set; } = ModeType.AlwaysOn;
         public float DelayS { get; protected set; } = 0f;
+        public bool DefaultOn { get; protected set; } = false;
 
         // Variables
         readonly MSTSWagon Wagon;
@@ -79,27 +80,47 @@ public virtual void Parse(string lowercasetoken, STFReader stf)
                 case "wagon(ortsbattery(delay":
                     DelayS = stf.ReadFloatBlock(STFReader.UNITS.Time, 0f);
                     break;
+
+                case "engine(ortsbattery(defaulton":
+                case "wagon(ortsbattery(defaulton":
+                    DefaultOn = stf.ReadBoolBlock(false);
+                    break;
             }
         }
 
         public void Copy(BatterySwitch other)
         {
             Mode = other.Mode;
             DelayS = other.DelayS;
+            DefaultOn = other.DefaultOn;
         }
 
         public virtual void Initialize()
         {
             Timer.Setup(DelayS);
+
+            if (DefaultOn)
+            {
+                On = true;
+
+                if (Mode == ModeType.Switch)
+                {
+                    CommandSwitch = true;
+                }
+            }
         }
 
         /// <summary>
         /// Initialization when simulation starts with moving train
         /// </summary>
         public virtual void InitializeMoving()
         {
-            CommandSwitch = true;
             On = true;
+
+            if (Mode == ModeType.Switch)
+            {
+                CommandSwitch = true;
+            }
         }
 
         public virtual void Save(BinaryWriter outf)
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/LocomotivePowerSupply.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/LocomotivePowerSupply.cs
@@ -112,6 +112,7 @@ public virtual void Parse(string lowercasetoken, STFReader stf)
 
                 case "engine(ortsbattery(mode":
                 case "engine(ortsbattery(delay":
+                case "engine(ortsbattery(defaulton":
                     BatterySwitch.Parse(lowercasetoken, stf);
                     break;
                 case "engine(ortsmasterkey(mode":
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/PassengerCarPowerSupply.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/PassengerCarPowerSupply.cs
@@ -88,6 +88,7 @@ public virtual void Parse(string lowercasetoken, STFReader stf)
 
                 case "wagon(ortsbattery(mode":
                 case "wagon(ortsbattery(delay":
+                case "wagon(ortsbattery(defaulton":
                     BatterySwitch.Parse(lowercasetoken, stf);
                     break;
 
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/SteamPowerSupply.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/PowerSupplies/SteamPowerSupply.cs
@@ -73,6 +73,7 @@ public virtual void Parse(string lowercasetoken, STFReader stf)
             {
                 case "engine(ortsbattery(mode":
                 case "engine(ortsbattery(delay":
+                case "engine(ortsbattery(defaulton":
                     BatterySwitch.Parse(lowercasetoken, stf);
                     break;
                 case "engine(ortsmasterkey(mode":

Original file line number	Diff line number	Diff line change
`@@ -4313,12 +4313,16 @@ In real life, the battery switch may not`
`4313`	`4313`	`close instantly, so you can add a delay with the optional parameter`
`4314`	`4314`	``ORTSBattery( Delay ( ) )`` (by default in seconds).
`4315`	`4315`
	`4316`	`+It is possible for the battery switch to be switched on at the start of the simulation.`
	`4317`	+To activate this behaviour, you can add the optional parameter ``ORTSBattery( DefaultOn ( 1 ) )``
	`4318`	`+`
`4316`	`4319`	`Example::`
`4317`	`4320`
`4318`	`4321`	`Engine (`
`4319`	`4322`	`ORTSBattery (`
`4320`	`4323`	`Mode ( PushButtons )`
`4321`	`4324`	`Delay ( 2s )`
	`4325`	`+ DefaultOn ( 1 )`
`4322`	`4326`	`)`
`4323`	`4327`	`)`
`4324`	`4328`
Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ public virtual void Parse(string lowercasetoken, STFReader stf)`
`73`	`73`	`{`
`74`	`74`	`case "engine(ortsbattery(mode":`
`75`	`75`	`case "engine(ortsbattery(delay":`
	`76`	`+ case "engine(ortsbattery(defaulton":`
`76`	`77`	`BatterySwitch.Parse(lowercasetoken, stf);`
`77`	`78`	`break;`
`78`	`79`	`case "engine(ortsmasterkey(mode":`