Code refactoring for 3D cabs

cesarBLG · cesarBLG · commit e2c841da0084 · 2022-11-24T09:18:13.000+01:00
diff --git a/Source/Orts.Formats.Msts/CabViewFile.cs b/Source/Orts.Formats.Msts/CabViewFile.cs
@@ -339,6 +339,30 @@ public enum DiscreteStates
         CAB_SIGNAL_DISPLAY
     }
 
+    public struct CabViewControlType
+    {
+        public CABViewControlTypes Type;
+        public int Subtype;
+        public CabViewControlType(string name)
+        {
+            Type = CABViewControlTypes.NONE;
+            Subtype = 0;
+            if (name != null && name.ToUpperInvariant().StartsWith("ORTS_TCS"))
+            {
+                if (int.TryParse(name.Substring(8), out Subtype))
+                {
+                    Type = CABViewControlTypes.ORTS_TCS;
+                }
+            }
+            else Enum.TryParse(name, true, out Type);
+        }
+        public override string ToString()
+        {
+            if (Type == CABViewControlTypes.ORTS_TCS) return Type.ToString() + Subtype;
+            return Type.ToString();
+        }
+    }
+
     public class CabViewControls : List<CabViewControl>
     {
         public CabViewControls(STFReader stf, string basepath)
@@ -404,8 +428,7 @@ public class CabViewControl
         public List<string> Screens;
         public int CabViewpoint;
 
-        public CABViewControlTypes ControlType = CABViewControlTypes.NONE;
-        public int ControlSubtype;
+        public CabViewControlType ControlType;
         public CABViewControlStyles ControlStyle = CABViewControlStyles.NONE;
         public CABViewControlUnits Units = CABViewControlUnits.NONE;
 
@@ -415,24 +438,11 @@ public class CabViewControl
         protected void ParseType(STFReader stf)
         {
             stf.MustMatch("(");
-            try
-            {
-                string name = stf.ReadString();
-                if (name != null && name.ToUpperInvariant().StartsWith("ORTS_TCS"))
-                {
-                    ControlType = CABViewControlTypes.ORTS_TCS;
-                    ControlSubtype = int.Parse(name.Substring(8));
-                }
-                else
-                {
-                    ControlType = (CABViewControlTypes)Enum.Parse(typeof(CABViewControlTypes), name);
-                }
-            }
-            catch(ArgumentException)
+            string name = stf.ReadString();
+            ControlType = new CabViewControlType(name);
+            if (ControlType.Type == CABViewControlTypes.NONE)
             {
-                stf.StepBackOneItem();
-                STFException.TraceInformation(stf, "Skipped unknown ControlType " + stf.ReadString());
-                ControlType = CABViewControlTypes.NONE;
+                STFException.TraceInformation(stf, "Skipped unknown ControlType " + name);
             }
             //stf.ReadItem(); // Skip repeated Class Type 
             stf.SkipRestOfBlock();
@@ -579,7 +589,11 @@ public CVCDial(CABViewControlTypes dialtype, int maxvalue, STFReader stf, string
                 new STFReader.TokenProcessor("graphic", ()=>{ ParseGraphic(stf, basepath); }),
                 new STFReader.TokenProcessor("pivot", ()=>{ Center = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
                 });
-            ControlType = dialtype;
+            ControlType = new CabViewControlType()
+            {
+                Type = dialtype,
+                Subtype = 0,
+            };
             ControlStyle = CABViewControlStyles.NEEDLE;
             Direction = 0;
             MaxValue = maxvalue;
@@ -1256,15 +1270,15 @@ public CVCDiscrete(STFReader stf, string basepath, DiscreteStates discreteState)
                 }
 
                 // MSTS ignores/overrides various settings by the following exceptional cases:
-                if (ControlType == CABViewControlTypes.CP_HANDLE)
+                if (ControlType.Type == CABViewControlTypes.CP_HANDLE)
                     ControlStyle = CABViewControlStyles.NOT_SPRUNG;
-                if (ControlType == CABViewControlTypes.PANTOGRAPH || ControlType == CABViewControlTypes.PANTOGRAPH2 ||
-                    ControlType == CABViewControlTypes.ORTS_PANTOGRAPH3 || ControlType == CABViewControlTypes.ORTS_PANTOGRAPH4)
+                if (ControlType.Type == CABViewControlTypes.PANTOGRAPH || ControlType.Type == CABViewControlTypes.PANTOGRAPH2 ||
+                    ControlType.Type == CABViewControlTypes.ORTS_PANTOGRAPH3 || ControlType.Type == CABViewControlTypes.ORTS_PANTOGRAPH4)
                     ControlStyle = CABViewControlStyles.ONOFF;
-                if (ControlType == CABViewControlTypes.HORN || ControlType == CABViewControlTypes.SANDERS || ControlType == CABViewControlTypes.BELL 
-                    || ControlType == CABViewControlTypes.RESET || ControlType == CABViewControlTypes.VACUUM_EXHAUSTER)
+                if (ControlType.Type == CABViewControlTypes.HORN || ControlType.Type == CABViewControlTypes.SANDERS || ControlType.Type == CABViewControlTypes.BELL 
+                    || ControlType.Type == CABViewControlTypes.RESET || ControlType.Type == CABViewControlTypes.VACUUM_EXHAUSTER)
                     ControlStyle = CABViewControlStyles.WHILE_PRESSED;
-                if (ControlType == CABViewControlTypes.DIRECTION && Orientation == 0)
+                if (ControlType.Type == CABViewControlTypes.DIRECTION && Orientation == 0)
                     Direction = 1 - Direction;
 
                 switch (discreteState)
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSDieselLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSDieselLocomotive.cs
@@ -848,7 +848,7 @@ public override float GetDataOf(CabViewControl cvc)
         {
             float data = 0;
 
-            switch (cvc.ControlType)
+            switch (cvc.ControlType.Type)
             {
                 case CABViewControlTypes.GEARS:
                     if (DieselEngines.HasGearBox)
@@ -1442,7 +1442,7 @@ protected void NormalizeParams()
                         {
                             foreach ( var control in cabView.CVFFile.CabViewControls)
                             {
-                                if (control is CVCDiscrete && control.ControlType == CABViewControlTypes.THROTTLE && (control as CVCDiscrete).Values.Count > 0 && (control as CVCDiscrete).Values[(control as CVCDiscrete).Values.Count - 1] > 1)
+                                if (control is CVCDiscrete && control.ControlType.Type == CABViewControlTypes.THROTTLE && (control as CVCDiscrete).Values.Count > 0 && (control as CVCDiscrete).Values[(control as CVCDiscrete).Values.Count - 1] > 1)
                                 {
                                     var discreteControl = (CVCDiscrete)control;
                                     for (var i = 0; i < discreteControl.Values.Count; i++)
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSElectricLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSElectricLocomotive.cs
@@ -221,7 +221,7 @@ public override float GetDataOf(CabViewControl cvc)
         {
             float data = 0;
 
-            switch (cvc.ControlType)
+            switch (cvc.ControlType.Type)
             {
                 case CABViewControlTypes.LINE_VOLTAGE:
                     data = ElectricPowerSupply.PantographVoltageV;
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSLocomotive.cs
@@ -634,16 +634,16 @@ protected MSTSNotchController BuildDPDynamicBrakeController()
                 {
                     msDisplay = (CVCMultiStateDisplay) cabView.CVFFile.CabViewControls.Where(
                         control => control is CVCMultiStateDisplay &&
-                        (((CVCMultiStateDisplay) control).ControlType == CABViewControlTypes.DYNAMIC_BRAKE_DISPLAY ||
-                        ((CVCMultiStateDisplay) control).ControlType == CABViewControlTypes.CPH_DISPLAY)).First();
+                        (((CVCMultiStateDisplay) control).ControlType.Type == CABViewControlTypes.DYNAMIC_BRAKE_DISPLAY ||
+                        ((CVCMultiStateDisplay) control).ControlType.Type == CABViewControlTypes.CPH_DISPLAY)).First();
                 }
                 catch
                 {
 
                 }
                 if (msDisplay != null)
                 {
-                    if (msDisplay.ControlType == CABViewControlTypes.DYNAMIC_BRAKE_DISPLAY)
+                    if (msDisplay.ControlType.Type == CABViewControlTypes.DYNAMIC_BRAKE_DISPLAY)
                     {
                         foreach (var switchval in msDisplay.Values)
                             dpDynController.AddNotch((float) switchval);
@@ -705,11 +705,8 @@ protected void GetPressureUnit()
                         CabViewControls cvcList = CabViewList[0].CVFFile.CabViewControls;
                         foreach (CabViewControl cvc in cvcList)
                         {
-                            if (brakeSystemComponents.ContainsKey(cvc.ControlType) && pressureUnits.ContainsKey(cvc.Units))
+                            if (brakeSystemComponents.TryGetValue(cvc.ControlType.Type, out var component) && pressureUnits.TryGetValue(cvc.Units, out var unit))
                             {
-                                BrakeSystemComponent component = brakeSystemComponents[cvc.ControlType];
-                                PressureUnit unit = pressureUnits[cvc.Units];
-
                                 BrakeSystemPressureUnits[component] = unit;
                             }
                         }
@@ -4992,7 +4989,7 @@ public override void SignalEvent(Event evt)
         public virtual float GetDataOf(CabViewControl cvc)
         {
             float data = 0;
-            switch (cvc.ControlType)
+            switch (cvc.ControlType.Type)
             {
                 case CABViewControlTypes.SPEEDOMETER:
                     {
@@ -5090,7 +5087,7 @@ public virtual float GetDataOf(CabViewControl cvc)
                             if (DynamicBrakePercent > 0 && MaxDynamicBrakeForceN > 0)
                             {
                                 float rangeFactor;
-                                if (cvc.ControlType == CABViewControlTypes.AMMETER_ABS)
+                                if (cvc.ControlType.Type == CABViewControlTypes.AMMETER_ABS)
                                 {
                                     if (DynamicBrakeMaxCurrentA == 0)
                                         rangeFactor = direction == 0 ? (float)cvc.MaxValue : (float)cvc.MinValue;
@@ -5108,11 +5105,11 @@ public virtual float GetDataOf(CabViewControl cvc)
                             }
                             if (direction == 1)
                                 data = -data;
-                            if (cvc.ControlType == CABViewControlTypes.AMMETER_ABS) data = Math.Abs(data);
+                            if (cvc.ControlType.Type == CABViewControlTypes.AMMETER_ABS) data = Math.Abs(data);
                             break;
                         }
                         data = this.MotiveForceN / MaxForceN * MaxCurrentA;
-                        if (cvc.ControlType == CABViewControlTypes.AMMETER_ABS) data = Math.Abs(data);
+                        if (cvc.ControlType.Type == CABViewControlTypes.AMMETER_ABS) data = Math.Abs(data);
                         break;
                     }
                 case CABViewControlTypes.LOAD_METER:
@@ -5819,7 +5816,7 @@ public virtual float GetDataOf(CabViewControl cvc)
                     }
 
                 case CABViewControlTypes.ORTS_TCS:
-                    TrainControlSystem.CabDisplayControls.TryGetValue(cvc.ControlSubtype - 1, out data);
+                    TrainControlSystem.CabDisplayControls.TryGetValue(cvc.ControlType.Subtype - 1, out data);
                     break;
 
                 case CABViewControlTypes.ORTS_BATTERY_SWITCH_COMMAND_SWITCH:
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/MSTSSteamLocomotive.cs b/Source/Orts.Simulation/Simulation/RollingStocks/MSTSSteamLocomotive.cs
@@ -5856,7 +5856,7 @@ public override float GetDataOf(CabViewControl cvc)
         {
             float data;
 
-            switch (cvc.ControlType)
+            switch (cvc.ControlType.Type)
             {
                 case CABViewControlTypes.WHISTLE:
                     data = Horn ? 1 : 0;
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/CruiseControl.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/CruiseControl.cs
@@ -1414,7 +1414,7 @@ void SetTrainBrake(ref float brakePercent, float elapsedClockSeconds, float delt
         public float GetDataOf(CabViewControl cvc)
         {
             float data = 0;
-            switch (cvc.ControlType)
+            switch (cvc.ControlType.Type)
             {
                 case CABViewControlTypes.ORTS_SELECTED_SPEED:
                 case CABViewControlTypes.ORTS_SELECTED_SPEED_DISPLAY:
diff --git a/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/EOT.cs b/Source/Orts.Simulation/Simulation/RollingStocks/SubSystems/EOT.cs
@@ -229,7 +229,7 @@ public override void Copy(MSTSWagon copy)
         public float GetDataOf(CabViewControl cvc)
         {
             float data = 0;
-            switch (cvc.ControlType)
+            switch (cvc.ControlType.Type)
             {
                 case CABViewControlTypes.ORTS_EOT_ID:
                     data = ID;
diff --git a/Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs b/Source/RunActivity/Viewer3D/RollingStock/MSTSLocomotiveViewer.cs
diff --git a/Source/RunActivity/Viewer3D/RollingStock/SubSystems/DistributedPowerInterface.cs b/Source/RunActivity/Viewer3D/RollingStock/SubSystems/DistributedPowerInterface.cs

Original file line number	Diff line number	Diff line change
`@@ -848,7 +848,7 @@ public override float GetDataOf(CabViewControl cvc)`
`848`	`848`	`{`
`849`	`849`	`float data = 0;`
`850`	`850`
`851`		`- switch (cvc.ControlType)`
	`851`	`+ switch (cvc.ControlType.Type)`
`852`	`852`	`{`
`853`	`853`	`case CABViewControlTypes.GEARS:`
`854`	`854`	`if (DieselEngines.HasGearBox)`
`@@ -1442,7 +1442,7 @@ protected void NormalizeParams()`
`1442`	`1442`	`{`
`1443`	`1443`	`foreach ( var control in cabView.CVFFile.CabViewControls)`
`1444`	`1444`	`{`
`1445`		`- if (control is CVCDiscrete && control.ControlType == CABViewControlTypes.THROTTLE && (control as CVCDiscrete).Values.Count > 0 && (control as CVCDiscrete).Values[(control as CVCDiscrete).Values.Count - 1] > 1)`
	`1445`	`+ if (control is CVCDiscrete && control.ControlType.Type == CABViewControlTypes.THROTTLE && (control as CVCDiscrete).Values.Count > 0 && (control as CVCDiscrete).Values[(control as CVCDiscrete).Values.Count - 1] > 1)`
`1446`	`1446`	`{`
`1447`	`1447`	`var discreteControl = (CVCDiscrete)control;`
`1448`	`1448`	`for (var i = 0; i < discreteControl.Values.Count; i++)`
Original file line number	Diff line number	Diff line change
`@@ -221,7 +221,7 @@ public override float GetDataOf(CabViewControl cvc)`
`221`	`221`	`{`
`222`	`222`	`float data = 0;`
`223`	`223`
`224`		`- switch (cvc.ControlType)`
	`224`	`+ switch (cvc.ControlType.Type)`
`225`	`225`	`{`
`226`	`226`	`case CABViewControlTypes.LINE_VOLTAGE:`
`227`	`227`	`data = ElectricPowerSupply.PantographVoltageV;`
Original file line number	Diff line number	Diff line change
`@@ -634,16 +634,16 @@ protected MSTSNotchController BuildDPDynamicBrakeController()`
`634`	`634`	`{`
`635`	`635`	`msDisplay = (CVCMultiStateDisplay) cabView.CVFFile.CabViewControls.Where(`
`636`	`636`	`control => control is CVCMultiStateDisplay &&`
`637`		`- (((CVCMultiStateDisplay) control).ControlType == CABViewControlTypes.DYNAMIC_BRAKE_DISPLAY \|\|`
`638`		`- ((CVCMultiStateDisplay) control).ControlType == CABViewControlTypes.CPH_DISPLAY)).First();`
	`637`	`+ (((CVCMultiStateDisplay) control).ControlType.Type == CABViewControlTypes.DYNAMIC_BRAKE_DISPLAY \|\|`
	`638`	`+ ((CVCMultiStateDisplay) control).ControlType.Type == CABViewControlTypes.CPH_DISPLAY)).First();`
`639`	`639`	`}`
`640`	`640`	`catch`
`641`	`641`	`{`
`642`	`642`
`643`	`643`	`}`
`644`	`644`	`if (msDisplay != null)`
`645`	`645`	`{`
`646`		`- if (msDisplay.ControlType == CABViewControlTypes.DYNAMIC_BRAKE_DISPLAY)`
	`646`	`+ if (msDisplay.ControlType.Type == CABViewControlTypes.DYNAMIC_BRAKE_DISPLAY)`
`647`	`647`	`{`
`648`	`648`	`foreach (var switchval in msDisplay.Values)`
`649`	`649`	`dpDynController.AddNotch((float) switchval);`
`@@ -705,11 +705,8 @@ protected void GetPressureUnit()`
`705`	`705`	`CabViewControls cvcList = CabViewList[0].CVFFile.CabViewControls;`
`706`	`706`	`foreach (CabViewControl cvc in cvcList)`
`707`	`707`	`{`
`708`		`- if (brakeSystemComponents.ContainsKey(cvc.ControlType) && pressureUnits.ContainsKey(cvc.Units))`
	`708`	`+ if (brakeSystemComponents.TryGetValue(cvc.ControlType.Type, out var component) && pressureUnits.TryGetValue(cvc.Units, out var unit))`
`709`	`709`	`{`
`710`		`- BrakeSystemComponent component = brakeSystemComponents[cvc.ControlType];`
`711`		`- PressureUnit unit = pressureUnits[cvc.Units];`
`712`		`-`
`713`	`710`	`BrakeSystemPressureUnits[component] = unit;`
`714`	`711`	`}`
`715`	`712`	`}`
`@@ -4992,7 +4989,7 @@ public override void SignalEvent(Event evt)`
`4992`	`4989`	`public virtual float GetDataOf(CabViewControl cvc)`
`4993`	`4990`	`{`
`4994`	`4991`	`float data = 0;`
`4995`		`- switch (cvc.ControlType)`
	`4992`	`+ switch (cvc.ControlType.Type)`
`4996`	`4993`	`{`
`4997`	`4994`	`case CABViewControlTypes.SPEEDOMETER:`
`4998`	`4995`	`{`
`@@ -5090,7 +5087,7 @@ public virtual float GetDataOf(CabViewControl cvc)`
`5090`	`5087`	`if (DynamicBrakePercent > 0 && MaxDynamicBrakeForceN > 0)`
`5091`	`5088`	`{`
`5092`	`5089`	`float rangeFactor;`
`5093`		`- if (cvc.ControlType == CABViewControlTypes.AMMETER_ABS)`
	`5090`	`+ if (cvc.ControlType.Type == CABViewControlTypes.AMMETER_ABS)`
`5094`	`5091`	`{`
`5095`	`5092`	`if (DynamicBrakeMaxCurrentA == 0)`
`5096`	`5093`	`rangeFactor = direction == 0 ? (float)cvc.MaxValue : (float)cvc.MinValue;`
`@@ -5108,11 +5105,11 @@ public virtual float GetDataOf(CabViewControl cvc)`
`5108`	`5105`	`}`
`5109`	`5106`	`if (direction == 1)`
`5110`	`5107`	`data = -data;`
`5111`		`- if (cvc.ControlType == CABViewControlTypes.AMMETER_ABS) data = Math.Abs(data);`
	`5108`	`+ if (cvc.ControlType.Type == CABViewControlTypes.AMMETER_ABS) data = Math.Abs(data);`
`5112`	`5109`	`break;`
`5113`	`5110`	`}`
`5114`	`5111`	`data = this.MotiveForceN / MaxForceN * MaxCurrentA;`
`5115`		`- if (cvc.ControlType == CABViewControlTypes.AMMETER_ABS) data = Math.Abs(data);`
	`5112`	`+ if (cvc.ControlType.Type == CABViewControlTypes.AMMETER_ABS) data = Math.Abs(data);`
`5116`	`5113`	`break;`
`5117`	`5114`	`}`
`5118`	`5115`	`case CABViewControlTypes.LOAD_METER:`
`@@ -5819,7 +5816,7 @@ public virtual float GetDataOf(CabViewControl cvc)`
`5819`	`5816`	`}`
`5820`	`5817`
`5821`	`5818`	`case CABViewControlTypes.ORTS_TCS:`
`5822`		`- TrainControlSystem.CabDisplayControls.TryGetValue(cvc.ControlSubtype - 1, out data);`
	`5819`	`+ TrainControlSystem.CabDisplayControls.TryGetValue(cvc.ControlType.Subtype - 1, out data);`
`5823`	`5820`	`break;`
`5824`	`5821`
`5825`	`5822`	`case CABViewControlTypes.ORTS_BATTERY_SWITCH_COMMAND_SWITCH:`
Original file line number	Diff line number	Diff line change
`@@ -5856,7 +5856,7 @@ public override float GetDataOf(CabViewControl cvc)`
`5856`	`5856`	`{`
`5857`	`5857`	`float data;`
`5858`	`5858`
`5859`		`- switch (cvc.ControlType)`
	`5859`	`+ switch (cvc.ControlType.Type)`
`5860`	`5860`	`{`
`5861`	`5861`	`case CABViewControlTypes.WHISTLE:`
`5862`	`5862`	`data = Horn ? 1 : 0;`
Original file line number	Diff line number	Diff line change
`@@ -1414,7 +1414,7 @@ void SetTrainBrake(ref float brakePercent, float elapsedClockSeconds, float delt`
`1414`	`1414`	`public float GetDataOf(CabViewControl cvc)`
`1415`	`1415`	`{`
`1416`	`1416`	`float data = 0;`
`1417`		`- switch (cvc.ControlType)`
	`1417`	`+ switch (cvc.ControlType.Type)`
`1418`	`1418`	`{`
`1419`	`1419`	`case CABViewControlTypes.ORTS_SELECTED_SPEED:`
`1420`	`1420`	`case CABViewControlTypes.ORTS_SELECTED_SPEED_DISPLAY:`
Original file line number	Diff line number	Diff line change
`@@ -229,7 +229,7 @@ public override void Copy(MSTSWagon copy)`
`229`	`229`	`public float GetDataOf(CabViewControl cvc)`
`230`	`230`	`{`
`231`	`231`	`float data = 0;`
`232`		`- switch (cvc.ControlType)`
	`232`	`+ switch (cvc.ControlType.Type)`
`233`	`233`	`{`
`234`	`234`	`case CABViewControlTypes.ORTS_EOT_ID:`
`235`	`235`	`data = ID;`