Added new parameter for battery switch

Sharpe49 · Sharpe49 · commit b9a0ea302c6d · 2023-01-03T17:29:16.000+01:00
diff --git a/Source/Documentation/Manual/physics.rst b/Source/Documentation/Manual/physics.rst
@@ -4291,12 +4291,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
@@ -868,6 +868,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
@@ -1380,6 +1380,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
`@@ -4291,12 +4291,16 @@ In real life, the battery switch may not`
`4291`	`4291`	`close instantly, so you can add a delay with the optional parameter`
`4292`	`4292`	``ORTSBattery( Delay ( ) )`` (by default in seconds).
`4293`	`4293`
	`4294`	`+It is possible for the battery switch to be switched on at the start of the simulation.`
	`4295`	+To activate this behaviour, you can add the optional parameter ``ORTSBattery( DefaultOn ( 1 ) )``
	`4296`	`+`
`4294`	`4297`	`Example::`
`4295`	`4298`
`4296`	`4299`	`Engine (`
`4297`	`4300`	`ORTSBattery (`
`4298`	`4301`	`Mode ( PushButtons )`
`4299`	`4302`	`Delay ( 2s )`
	`4303`	`+ DefaultOn ( 1 )`
`4300`	`4304`	`)`
`4301`	`4305`	`)`
`4302`	`4306`
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":`