Improve Debug Outputs for TTTrain.cs

Author: Roeterdink

Source/Orts.Simulation/Simulation/Timetables/TTTrain.cs

@@ -27,6 +27,7 @@
 // #define DEBUG_EXTRAINFO
 // #define DEBUG_TRACEINFO
 // #define DEBUG_TTANALYSIS
+// #define DEBUG_DELAYS
 // DEBUG flag for debug prints
 
 using System;
@@ -70,6 +71,8 @@ public class TTTrain : AITrain
                                                             // required direction on leaving pool (if applicable)
         public string ForcedConsistName = String.Empty;     // forced consist name for extraction from pool
 
+        public string ttanalysisreport = String.Empty;      // string holding last analysis report, to avoid continouos output of same string
+
         // Timetable Commands info
         public List<WaitInfo> WaitList = null;                            //used when in timetable mode for wait instructions
         public Dictionary<int, List<WaitInfo>> WaitAnyList = null;        //used when in timetable mode for waitany instructions
@@ -1239,7 +1242,7 @@ public bool PostInit(bool activateTrain)
 
                 File.AppendAllText(@"C:\temp\checktrain.txt", "--------\n");
                 File.AppendAllText(@"C:\temp\checktrain.txt", "PostInit at " + actTime.ToString("HH:mm:ss") + "\n");
-                File.AppendAllText(@"C:\temp\checktrain.txt", "Train : " + Number.ToString() + "\n");
+                File.AppendAllText(@"C:\temp\checktrain.txt", "Train : " + Number.ToString() + " ( AI : " + OrgAINumber.ToString() + " )\n");
                 File.AppendAllText(@"C:\temp\checktrain.txt", "Name  : " + Name + "\n");
                 File.AppendAllText(@"C:\temp\checktrain.txt", "Frght : " + IsFreight.ToString() + "\n");
                 File.AppendAllText(@"C:\temp\checktrain.txt", "Length: " + Length.ToString() + "\n");
@@ -4037,6 +4040,11 @@ public override void UpdateStationState(float elapsedClockSeconds, int presentTi
             }
 #endif
 
+#if DEBUG_DELAYS
+            if (Delay.HasValue && Delay.Value.TotalMinutes > 5)
+                Trace.TraceInformation("{0} at {1} : + {2}", Name, thisStation.PlatformItem.Name, Delay.Value.ToString());
+#endif
+
             if (CheckTrain)
             {
                 DateTime baseDTdCT = new DateTime();
@@ -8156,6 +8164,13 @@ public void FinalizeTimetableCommands()
 #if DEBUG_TRACEINFO
                             Trace.TraceInformation("Train : " + Name);
                             Trace.TraceInformation("WAIT : Search for : {0} - found {1}", reqWait.referencedTrainName, otherTrain == null ? -1 : otherTrain.Number);
+#endif
+#if DEBUG_DELAYS
+                            if (otherTrain == null)
+                            {
+                                Trace.TraceInformation("Train : " + Name);
+                                Trace.TraceInformation("WAIT : Search for : {0} - not found", reqWait.referencedTrainName);
+                            }
 #endif
                             if (otherTrain != null)
                             {
@@ -8170,6 +8185,13 @@ public void FinalizeTimetableCommands()
 #if DEBUG_TRACEINFO
                             Trace.TraceInformation("Train : " + Name);
                             Trace.TraceInformation("FOLLOW : Search for : {0} - found {1}", reqWait.referencedTrainName, otherTrain == null ? -1 : otherTrain.Number);
+#endif
+#if DEBUG_DELAYS
+                            if (otherTrain == null)
+                            {
+                                Trace.TraceInformation("Train : " + Name);
+                                Trace.TraceInformation("FOLLOW : Search for : {0} - not found", reqWait.referencedTrainName);
+                            }
 #endif
                             if (otherTrain != null)
                             {
@@ -8185,6 +8207,14 @@ public void FinalizeTimetableCommands()
                             Trace.TraceInformation("Train : " + Name);
                             Trace.TraceInformation("CONNECT : Search for : {0} - found {1}", reqWait.referencedTrainName, otherTrain == null ? -1 : otherTrain.Number);
 #endif
+#if DEBUG_DELAYS
+                            if (otherTrain == null)
+                            {
+                                Trace.TraceInformation("Train : " + Name);
+                                Trace.TraceInformation("CONNECT : Search for : {0} - not found", reqWait.referencedTrainName);
+                            }
+#endif
+
                             if (otherTrain != null)
                             {
                                 ProcessConnectRequest(reqWait, otherTrain, ref newWaitItems);
@@ -9593,6 +9623,7 @@ public bool CheckEndOfRoutePositionTT()
                         MovementState = AI_MOVEMENT_STATE.TURNTABLE;
                         if (CheckTrain)
                         {
+                            File.AppendAllText(@"C:\temp\checktrain.txt", "TURNTABLE : Pool : " + thisTurntablePool.PoolName + " : Table state set to " + ActiveTurntable.MovingTableState.ToString() + "\n");
                             File.AppendAllText(@"C:\temp\checktrain.txt", "Moving table access ; Movement State : " + MovementState + "\n");
                         }
                         return (endOfRoute);
@@ -11508,6 +11539,11 @@ public int GetUnitsToDetach(DetachInfo.DetachUnitsInfo detachUnits, int numberOf
 
                 default:
                     iunits = numberOfUnits;
+                    if (iunits > Cars.Count - 1)
+                    {
+                        Trace.TraceInformation("Train {0} : no. of units to detach ({1}) : value too large, only {2} units on train\n", Name, iunits, Cars.Count);
+                        iunits = Cars.Count - 1;
+                    }
                     frontpos = detachUnits == DetachInfo.DetachUnitsInfo.unitsAtFront;
                     break;
             }
@@ -12659,12 +12695,13 @@ public void TTAnalysisUpdateStationState1(int presentTime, StationStop thisStati
         {
 
             DateTime baseDTA = new DateTime();
+            DateTime presentDTA = baseDTA.AddSeconds(AI.clockTime);
             DateTime arrTimeA = baseDTA.AddSeconds(presentTime);
             DateTime depTimeA = baseDTA.AddSeconds(thisStation.ActualDepart);
 
             var sob = new StringBuilder();
             sob.AppendFormat("{0};{1};{2};{3};{4};{5};{6};{7};{8};{9};{10};{11};{12}",
-                Number, AI.clockTime, Name, Delay, thisStation.PlatformItem.Name, thisStation.arrivalDT.ToString("HH:mm:ss"), thisStation.departureDT.ToString("HH:mm:ss"),
+                Number, presentDTA.ToString("HH:mm:ss"), Name, Delay, thisStation.PlatformItem.Name, thisStation.arrivalDT.ToString("HH:mm:ss"), thisStation.departureDT.ToString("HH:mm:ss"),
                 arrTimeA.ToString("HH:mm:ss"), depTimeA.ToString("HH:mm:ss"), "", "", "", "");
             File.AppendAllText(@"C:\temp\TTAnalysis.csv", sob.ToString() + "\n");
         }
@@ -12721,9 +12758,16 @@ public void TTAnalysisUpdateStationState2()
             DateTime baseDT = new DateTime();
             DateTime stopTime = baseDT.AddSeconds(AI.clockTime);
 
-            var sob = new StringBuilder();
-            sob.AppendFormat("{0};{1};{2};{3};{4};{5};{6};{7};{8};{9};{10};{11};{12}", Number, AI.clockTime, Name, Delay, "", "", "", "", "", "", stopTime.ToString("HH:mm:ss"), signalstring.ToString(), waitforstring.ToString());
-            File.AppendAllText(@"C:\temp\TTAnalysis.csv", sob.ToString() + "\n");
+            // output string only if different from last output
+
+            if (waitforstring.ToString() != ttanalysisreport)
+            {
+                ttanalysisreport = waitforstring.ToString();
+
+                var sob = new StringBuilder();
+                sob.AppendFormat("{0};{1};{2};{3};{4};{5};{6};{7};{8};{9};{10};{11};{12}", Number, stopTime.ToString("HH:mm:ss"), Name, Delay, "", "", "", "", "", "", stopTime.ToString("HH:mm:ss"), signalstring.ToString(), waitforstring.ToString());
+                File.AppendAllText(@"C:\temp\TTAnalysis.csv", sob.ToString() + "\n");
+            }
         }
 
         public void TTAnalysisUpdateBrakingState1()
@@ -12780,9 +12824,14 @@ public void TTAnalysisUpdateBrakingState1()
                 DateTime baseDT = new DateTime();
                 DateTime stopTime = baseDT.AddSeconds(AI.clockTime);
 
-                var sob = new StringBuilder();
-                sob.AppendFormat("{0};{1};{2};{3};{4};{5};{6};{7};{8};{9};{10};{11};{12}", Number, AI.clockTime, Name, Delay, "", "", "", "", "", "", stopTime.ToString("HH:mm:ss"), signalstring.ToString(), waitforstring.ToString());
-                File.AppendAllText(@"C:\temp\TTAnalysis.csv", sob.ToString() + "\n");
+                if (waitforstring.ToString() != ttanalysisreport)
+                {
+                    ttanalysisreport = waitforstring.ToString();
+
+                    var sob = new StringBuilder();
+                    sob.AppendFormat("{0};{1};{2};{3};{4};{5};{6};{7};{8};{9};{10};{11};{12}", Number, stopTime.ToString("HH:mm:ss"), Name, Delay, "", "", "", "", "", "", stopTime.ToString("HH:mm:ss"), signalstring.ToString(), waitforstring.ToString());
+                    File.AppendAllText(@"C:\temp\TTAnalysis.csv", sob.ToString() + "\n");
+                }
             }
         }
 
@@ -12846,9 +12895,14 @@ public void TTAnalysisUpdateBrakingState2()
             DateTime baseDT = new DateTime();
             DateTime stopTime = baseDT.AddSeconds(AI.clockTime);
 
-            var sob = new StringBuilder();
-            sob.AppendFormat("{0};{1};{2};{3};{4};{5};{6};{7};{8};{9};{10};{11};{12}", Number, AI.clockTime, Name, Delay, "", "", "", "", "", "", stopTime.ToString("HH:mm:ss"), signalstring.ToString(), waitforstring.ToString());
-            File.AppendAllText(@"C:\temp\TTAnalysis.csv", sob.ToString() + "\n");
+            if (waitforstring.ToString() != ttanalysisreport)
+            {
+                ttanalysisreport = waitforstring.ToString();
+
+                var sob = new StringBuilder();
+                sob.AppendFormat("{0};{1};{2};{3};{4};{5};{6};{7};{8};{9};{10};{11};{12}", Number, stopTime.ToString("HH:mm:ss"), Name, Delay, "", "", "", "", "", "", stopTime.ToString("HH:mm:ss"), signalstring.ToString(), waitforstring.ToString());
+                File.AppendAllText(@"C:\temp\TTAnalysis.csv", sob.ToString() + "\n");
+            }
         }
 
         public void TTAnalysisStartMoving(String info)
@@ -12858,8 +12912,9 @@ public void TTAnalysisStartMoving(String info)
 
             var sob = new StringBuilder();
             sob.AppendFormat("{0};{1};{2};{3};{4};{5};{6};{7};{8};{9};{10};{11};{12}",
-                Number, AI.clockTime, Name, Delay, "", "", "", "", "", moveTimeA.ToString("HH:mm:ss"), "", "", info);
+                Number, moveTimeA.ToString("HH:mm:ss"), Name, Delay, "", "", "", "", "", moveTimeA.ToString("HH:mm:ss"), "", "", info);
             File.AppendAllText(@"C:\temp\TTAnalysis.csv", sob.ToString() + "\n");
+            ttanalysisreport = String.Empty;
         }
     }
 
@@ -13310,6 +13365,13 @@ public DetachInfo(TTTrain thisTrain, TTTrainCommands commandInfo, bool atActivat
             bool portionDefined = false;
             bool formedTrainDefined = false;
 
+            if (commandInfo.CommandQualifiers == null || commandInfo.CommandQualifiers.Count < 1)
+            {
+                Trace.TraceInformation("Train {0} : missing detach command qualifiers", thisTrain.Name);
+                Valid = false;
+                return;
+            }
+
             foreach (TTTrainCommands.TTTrainComQualifiers Qualifier in commandInfo.CommandQualifiers)
             {
                 switch (Qualifier.QualifierName.Trim().ToLower())