Merge pull request #677 from peternewell/diesel-mechanic#4

Correct double heading bug

Author: peternewell

Source/Documentation/Manual/physics.rst

@@ -696,7 +696,7 @@ needs to be set to "Mechanic".
 
 Two ORTS mechanical gearbox configurations can be set up.
 
-These two gearboxes can be selected by the use of the following parameter:
+These three gearboxes can be selected by the use of the following parameter:
 
 ``ORTSGearBoxType ( A )`` - represents a semi-automatic pre-selector gearbox that gives 
 a continuous power output that is not interrupted when changing gears.
@@ -706,6 +706,9 @@ although there is a break in tractive effort when changing from one gear to anot
 the engine speed is reduced by a shaft brake if needed, so that there is no need for 
 the driver to adjust the throttle.
 
+``ORTSGearBoxType ( C )`` - represents a semi-automatic pre-selector type gear box where 
+there is a need for the driver to adjust the throttle before making a gear change.
+
 One of three possible types of main clutch are selectable for each of the above gear box 
 types, as follows:
 
@@ -726,14 +729,20 @@ to coast with the engine in gear.
 
 ``GearBoxNumberOfGears`` - The number of gears available in the gear box.
 
-Currently only a BASIC model configuration is available (ie no user defined traction curves or 
-diesel engine curves are supported). OR calculates the tractive force curves for each gear based 
+Currently a BASIC model configuration is available (ie no user defined traction curves or 
+diesel engine curves are supported), or an ADVANCED configuration (ie the user defines the diesel engine 
+parameters including the torque curve. Two diesel engines of the same type can be installed on the same 
+locomotive or railcar using the advanced diesel engine block. Where two engines are installed it is 
+assumed they will each drive a separate axle or bogie via a separate, identical gear box. Two or more 
+locomotives or power cars in the same consist should also now operate correctly.
+
+OR calculates the tractive force curves for each gear based 
 on the "inbuilt" torque curve of a typical diesel engine. 
 
 ``GearBoxMaxSpeedForGears`` - sets the maximum speed for each gear, corresponding to maximum engine 
 rpm and maximum power . As an example, the values for a typical British Railways first generation dmu are:
 
-GearBoxMaxSpeedForGears( 15.3 27 41 65.5 ) The default values are in mph, although other units can be entered. 
+``GearBoxMaxSpeedForGears( 15.3 27 41 65.5 )`` - The default values are in mph, although other units can be entered. 
 In the above case the maximum permitted speed of the train is 70 mph; a small amount of ‘overspeed’ being allowed
  in top gear. The fourth gear speed of 65.5 mph corresponds to the maximum engine rpm set in the eng file by 
  ``DieselEngineMaxRPM``. The diesel engine may continue to ‘runaway’ above its normal ‘maximum speed’ until it 
@@ -746,10 +755,15 @@ ORTSDieselEngineGovenorRpM ( 2000 )
 
 If under any circumstances the engine reaches ``ORTSDieselEngineGovenorRpM`` then the diesel engine will automatically be shut down.
 
-"ORTSGearBoxTractiveForceAtSpeed" - The tractive force available in each gear at the speed indicated in GearBoxMaxSpeedForGears. Units 
+``ORTSGearBoxTractiveForceAtSpeed`` - The tractive force available in each gear at the speed indicated in GearBoxMaxSpeedForGears. Units 
 by default are in N, however lbf, N or kN. Published values for tractive effort of geared locomotives and multiple units 
 are generally those at the maximum speed for each gear.
 
+``ORTSReverseGearboxIndication`` - Some gearboxes have a "reverse" gearing arrangement, ie N-4-3-2-1. This parameter allows the 
+gear selector to display gears in the correct order for this type of gearbox arrangement. If using this parameter, note in the 
+above example that ``GearBoxMaxSpeedForGears`` and ``ORTSGearBoxTractiveForceatSpeed`` need to list the gears in the order 4-3-2-1 
+rather than in ascending order.
+
 Hence a typical gear configuration for a diesel mechanic locomotive might look like the following:
 
  ORTSDieselTransmissionType ( Mechanic )

Source/Orts.Simulation/Simulation/RollingStocks/MSTSDieselLocomotive.cs

@@ -1,4 +1,4 @@
-// COPYRIGHT 2009, 2010, 2011, 2012, 2013 by the Open Rails project.
+// COPYRIGHT 2009, 2010, 2011, 2012, 2013 by the Open Rails project.
 // 
 // This file is part of Open Rails.
 // 
@@ -189,6 +189,7 @@ public override void Parse(string lowercasetoken, STFReader stf)
                     break;
                 case "engine(ortsdieselengines":
                 case "engine(gearboxnumberofgears":
+                case "engine(ortsreversegearboxindication":
                 case "engine(gearboxdirectdrivegear":
                 case "engine(ortsmainclutchtype":
                 case "engine(ortsgearboxtype":
@@ -851,7 +852,7 @@ public override float GetDataOf(CabViewControl cvc)
             {
                 case CABViewControlTypes.GEARS:
                     if (DieselEngines.HasGearBox)
-                        data = DieselEngines[0].GearBox.CurrentGearIndex + 1;
+                        data = DieselEngines[0].GearBox.GearIndication;
                     break;
 
                 case CABViewControlTypes.FUEL_GAUGE:
@@ -937,7 +938,7 @@ public override string GetStatus()
                 Simulator.Catalog.GetParticularString("Engine", GetStringAttribute.GetPrettyName(DieselEngines[0].State)));
             if (DieselEngines.HasGearBox)
                 status.AppendFormat("{0} = {1}\n", Simulator.Catalog.GetString("Gear"),
-                DieselEngines[0].GearBox.CurrentGearIndex < 0 ? Simulator.Catalog.GetParticularString("Gear", "N") : (DieselEngines[0].GearBox.CurrentGearIndex + 1).ToString());
+                DieselEngines[0].GearBox.CurrentGearIndex < 0 ? Simulator.Catalog.GetParticularString("Gear", "N") : (DieselEngines[0].GearBox.GearIndication).ToString());
             status.AppendLine();
             status.AppendFormat("{0} = {1}\n",
                 Simulator.Catalog.GetString("Battery switch"),
@@ -964,7 +965,7 @@ public override string GetDebugStatus()
 
             if (DieselEngines.HasGearBox && DieselTransmissionType == DieselTransmissionTypes.Mechanic)
             {
-                status.AppendFormat("\t{0} {1}-{2}", Simulator.Catalog.GetString("Gear"), DieselEngines[0].GearBox.CurrentGearIndex < 0 ? Simulator.Catalog.GetString("N") : (DieselEngines[0].GearBox.CurrentGearIndex + 1).ToString(), DieselEngines[0].GearBox.GearBoxType);
+                    status.AppendFormat("\t{0} {1}-{2}", Simulator.Catalog.GetString("Gear"), DieselEngines[0].GearBox.CurrentGearIndex < 0 ? Simulator.Catalog.GetString("N") : (DieselEngines[0].GearBox.GearIndication).ToString(), DieselEngines[0].GearBox.GearBoxType);
             }
                 status.AppendFormat("\t{0} {1}\t\t{2}\n",
                 Simulator.Catalog.GetString("Fuel"),

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

@@ -433,6 +433,7 @@ public float OdometerM
         public MSTSNotchController DPDynamicBrakeController;
 
         private int PreviousGearBoxNotch;
+        private int previousChangedGearBoxNotch;
 
         public float EngineBrakeIntervention = -1;
         public float TrainBrakeIntervention = -1;
@@ -1265,6 +1266,8 @@ public override void Save(BinaryWriter outf)
             outf.Write(GenericItem2);
             outf.Write(RemoteControlGroup);
             outf.Write(DPUnitID);
+            outf.Write(PreviousGearBoxNotch);
+            outf.Write(previousChangedGearBoxNotch);
 
             base.Save(outf);
 
@@ -1318,6 +1321,8 @@ public override void Restore(BinaryReader inf)
             GenericItem2 = inf.ReadBoolean();
             RemoteControlGroup = inf.ReadInt32();
             DPUnitID = inf.ReadInt32();
+            PreviousGearBoxNotch = inf.ReadInt32();
+            previousChangedGearBoxNotch = inf.ReadInt32();
 
             base.Restore(inf);
 
@@ -1820,6 +1825,54 @@ public override void Update(float elapsedClockSeconds)
                 }
             }
 
+            var gearloco = this as MSTSDieselLocomotive;
+
+            // Pass Gearbox commands
+            // Note - at the moment there is only one GearBox Controller created, but a gearbox for each diesel engine is created. 
+            // This code keeps all gearboxes in the locomotive aligned with the first engine and gearbox.
+            if (gearloco != null && gearloco.DieselTransmissionType == MSTSDieselLocomotive.DieselTransmissionTypes.Mechanic && GearBoxController.CurrentNotch != previousChangedGearBoxNotch)
+            {
+                // pass gearbox command key to other gearboxes in the same locomotive, only do the current locomotive
+
+                if (gearloco == this)
+                {
+
+                    int ii = 0;
+                    foreach (var eng in gearloco.DieselEngines.DEList)
+                    {
+                        // don't change the first engine as this is the reference for all the others
+                        if (ii != 0)
+                        {
+                            gearloco.DieselEngines[ii].GearBox.currentGearIndex = gearloco.DieselEngines[0].GearBox.CurrentGearIndex;
+                        }
+
+                        ii = ii + 1;
+                    }
+                }
+
+                // pass gearbox command key to other locomotives in train, don't treat the player locomotive in this fashion.
+                foreach (TrainCar car in Train.Cars)
+                {
+                    var dieselloco = this as MSTSDieselLocomotive;
+                    var locog = car as MSTSDieselLocomotive;
+
+                    if (locog != null && dieselloco != null && car != this && !locog.IsLeadLocomotive())
+                    {
+
+                        locog.DieselEngines[0].GearBox.currentGearIndex = dieselloco.DieselEngines[0].GearBox.CurrentGearIndex;
+
+                        locog.GearBoxController.CurrentNotch = dieselloco.DieselEngines[0].GearBox.CurrentGearIndex + 1;
+                        locog.GearboxGearIndex = dieselloco.DieselEngines[0].GearBox.CurrentGearIndex + 1;
+                        locog.GearBoxController.SetValue((float)dieselloco.GearBoxController.CurrentNotch);
+
+                        locog.Simulator.Confirmer.ConfirmWithPerCent(CabControl.GearBox, CabSetting.Increase, locog.GearBoxController.CurrentNotch);
+                        locog.AlerterReset(TCSEvent.GearBoxChanged);
+                        locog.SignalGearBoxChangeEvents();
+                    }
+                }
+
+                previousChangedGearBoxNotch = GearBoxController.CurrentNotch; // reset loop until next gear change
+            }
 
             TrainControlSystem.Update(elapsedClockSeconds);
 
@@ -2007,7 +2060,6 @@ public override void Update(float elapsedClockSeconds)
             UpdateHornAndBell(elapsedClockSeconds);
 
             UpdateSoundVariables(elapsedClockSeconds);
-
             PrevMotiveForceN = MotiveForceN;
             base.Update(elapsedClockSeconds);
 
@@ -3579,8 +3631,10 @@ public virtual void StartGearBoxIncrease()
         {
             if (GearBoxController != null)
             {
+                
                 if (this is MSTSDieselLocomotive)
                 {
+
                     var dieselloco = this as MSTSDieselLocomotive;
 
                     if (dieselloco.DieselTransmissionType == MSTSDieselLocomotive.DieselTransmissionTypes.Mechanic)
@@ -3589,7 +3643,7 @@ public virtual void StartGearBoxIncrease()
                         if (dieselloco.DieselEngines[0].GearBox.GearBoxType != TypesGearBox.C)
                         {
                             GearBoxController.StartIncrease();
-                            Simulator.Confirmer.ConfirmWithPerCent(CabControl.GearBox, CabSetting.Increase, GearBoxController.CurrentNotch);
+                            Simulator.Confirmer.ConfirmWithPerCent(CabControl.GearBox, CabSetting.Increase, dieselloco.DieselEngines[0].GearBox.GearIndication);
                             AlerterReset(TCSEvent.GearBoxChanged);
                             SignalGearBoxChangeEvents();
                             dieselloco.DieselEngines[0].GearBox.clutchOn = false;
@@ -3602,7 +3656,7 @@ public virtual void StartGearBoxIncrease()
                             if (ThrottlePercent == 0)
                             {
                                 GearBoxController.StartIncrease();
-                                Simulator.Confirmer.ConfirmWithPerCent(CabControl.GearBox, CabSetting.Increase, GearBoxController.CurrentNotch);
+                                Simulator.Confirmer.ConfirmWithPerCent(CabControl.GearBox, CabSetting.Increase, dieselloco.DieselEngines[0].GearBox.GearIndication );
                                 AlerterReset(TCSEvent.GearBoxChanged);
                                 SignalGearBoxChangeEvents();
                                 dieselloco.DieselEngines[0].GearBox.clutchOn = false;
@@ -3652,7 +3706,7 @@ public virtual void StartGearBoxDecrease()
                         if (dieselloco.DieselEngines[0].GearBox.GearBoxType != TypesGearBox.C)
                         {
                             GearBoxController.StartDecrease();
-                            Simulator.Confirmer.ConfirmWithPerCent(CabControl.GearBox, CabSetting.Decrease, GearBoxController.CurrentNotch);
+                            Simulator.Confirmer.ConfirmWithPerCent(CabControl.GearBox, CabSetting.Decrease, dieselloco.DieselEngines[0].GearBox.GearIndication);
                             AlerterReset(TCSEvent.GearBoxChanged);
                             SignalGearBoxChangeEvents();
                             dieselloco.DieselEngines[0].GearBox.clutchOn = false;
@@ -3663,7 +3717,8 @@ public virtual void StartGearBoxDecrease()
                             if (ThrottlePercent == 0)
                             {
                                 GearBoxController.StartDecrease();
-                                Simulator.Confirmer.ConfirmWithPerCent(CabControl.GearBox, CabSetting.Decrease, GearBoxController.CurrentNotch);
+                                Trace.TraceInformation("Controller Decrease - Current Notch {0} Indication {1} GearIndex {2}", GearBoxController.CurrentNotch, dieselloco.DieselEngines[0].GearBox.GearIndication, dieselloco.DieselEngines[0].GearBox.CurrentGearIndex);
+                                Simulator.Confirmer.ConfirmWithPerCent(CabControl.GearBox, CabSetting.Decrease, dieselloco.DieselEngines[0].GearBox.GearIndication);
                                 AlerterReset(TCSEvent.GearBoxChanged);
                                 SignalGearBoxChangeEvents();
                                 dieselloco.DieselEngines[0].GearBox.clutchOn = false;
@@ -3746,7 +3801,7 @@ private void SignalGearBoxChangeEvents()
             var dieselloco = this as MSTSDieselLocomotive;
             if (change != 0)
             {
-                //new GarBoxCommand(Simulator.Log, change > 0, controller.CurrentValue, Simulator.ClockTime);
+                //new GearBoxCommand(Simulator.Log, change > 0, controller.CurrentValue, Simulator.ClockTime);
                 SignalEvent(change > 0 ? Event.GearUp : Event.GearDown);
                 AlerterReset(TCSEvent.GearBoxChanged);
             }
@@ -5229,7 +5284,7 @@ public virtual float GetDataOf(CabViewControl cvc)
                         {
                             var dieselLoco = this as MSTSDieselLocomotive;
                             if (dieselLoco.DieselEngines.HasGearBox)
-                                data = dieselLoco.DieselEngines[0].GearBox.CurrentGearIndex + 1;
+                                data = dieselLoco.DieselEngines[0].GearBox.GearIndication;
                         }
                         break;
                     }