Removes option to creates an activity evaluation. Now always created.

Author: Chris Jakeman

Source/Documentation/Manual/driving.rst

@@ -621,7 +621,7 @@ within the cabview, see :ref:`here <cabs-odometer>`.
 .. _debriefeval:
 
 
-Debrief Evaluation
+Activity Evaluation
 ------------------
 
 ``Description``
@@ -651,7 +651,7 @@ and here an example about the Options/Simulation tab:
 .. image:: images/dbfeval-options-simulation.png
 
 Checkboxes shown as unchecked in the two above pictures may be checked or 
-unchecked, but don't have effect on activity evaluation.
+unchecked, but don't have any effect on activity evaluation.
 
 A tab named "Evaluation" is present on the F1 Help Information Monitor.
 Once the activity is running it displays dynamic information about the player 
@@ -666,7 +666,7 @@ train performance up to that moment.
 
    \newpage
 
-Clicking **Actual status: (**\ |darr| **)**\  expanded real-time display appears.
+Clicking **Actual status: (**\ |darr| **)**\  shows an expanded real-time display.
 
 
 .. image:: images/dbfeval-evaluation-expanded.png
@@ -677,8 +677,6 @@ Clicking **Actual status: (**\ |darr| **)**\  expanded real-time display appears
 
 Clicking **Actual status: (**\ |uarr| **)**\  collapses all items.
 
-Once the activity has ended, the report file is created and a new window displays it.
-
 .. image:: images/dbfeval-evaluation-ended.png
    :scale: 100%
    :align: center
@@ -688,6 +686,9 @@ Once the activity has ended, the report file is created and a new window display
 
    \newpage
 
+Once the activity has ended, as soon as the player views the Evaluation tab, a report file is 
+created and shown in an editor window as follows.
+
 This report is made up of several sections.
 
 .. image:: images/dbfeval-report.png
@@ -696,13 +697,12 @@ This report is made up of several sections.
 
 .. raw:: latex
 
-    \newpage
+The report file OpenRailsEvaluation.txt is saved alongside the log file OpenRailsLog.txt and
+the default location for this is the Windows Desktop.
 
-Activity saves (F2) will save also the evaluation data.
+The Save Game (F2) command also copies any evaluation report alongside the save files so it can be
+kept and reviewed. This copy is deleted when the other files for that save are deleted.
 
-.. image:: images/dbfeval-resume.png
-   :scale: 100%
-   :align: center
 
 .. _driving-hud:
 

Source/Documentation/Manual/start.rst

@@ -122,13 +122,14 @@ by that locomotive will appear.
 If you instead select a specific activity, you won't have to perform any 
 further selections.
 
-Debrief Evaluation
+Activity Evaluation
 ''''''''''''''''''
 
-During the activity session, data about the activity is stored and may be displayed in real time, and at 
-the end of the activity a report file is generated.
-This provides a summary of the player's skills as a train driver.
-Debrief evaluation is described :ref:`here <debriefeval>`.
+During the activity session, data about performance is stored and may be viewed as the activity progresses.
+At the end of the activity a report file is generated which provides a summary of 
+the player's skills as a train driver.
+
+Activity evaluation is described :ref:`here <debriefeval>`.
 
 If you have selected the related Experimental Option, at runtime you can 
 switch :ref:`Autopilot mode <driving-autopilot>` on or off, which allows you

Source/Menu/ResumeForm.cs

@@ -254,7 +254,7 @@ void LoadSaves()
                                     if (!save.IsMultiplayer ^ Multiplayer)
                                         saves.Add(save);
                                     // Save a warning to show later.
-                                    warning += catalog.GetStringFmt("Warning: Save {0} found from a route with an unexpected name:\n{1}.\n\n", save.RealTime, save.RouteName);
+                                    warning += catalog.GetStringFmt("Warning: Save {0} found from a route with an unexpected name:\n{1}.\n\n", save.File, save.RouteName);
                                 }
                             }
                         }
@@ -390,8 +390,11 @@ void buttonDelete_Click(object sender, EventArgs e)
                     foreach (var fileName in new[] 
                         { Path.GetFileName(save.File)
                         , Path.ChangeExtension(Path.GetFileName(save.File), "png")
-                        , Path.ChangeExtension(Path.GetFileName(save.File), "dbfeval.txt")
-                        })
+                        , Path.ChangeExtension(Path.GetFileName(save.File), "replay")
+                        , Path.ChangeExtension(Path.GetFileName(save.File), "txt")
+                        , Path.ChangeExtension(Path.GetFileName(save.File), "evaluation.txt")
+                        }
+                    )
                     {
                         try
                         {
@@ -437,11 +440,12 @@ void buttonDeleteInvalid_Click(object sender, EventArgs e)
                     var save = new Save(saveFile, Settings.YoungestVersionFailedToRestore);
                     if (save.Valid == false)
                     {
-                        foreach (var fileName in new[] { 
-                            save.File, 
-                            Path.ChangeExtension(save.File, "png"), 
-                            Path.ChangeExtension(save.File, "txt"),
-                            Path.ChangeExtension(save.File, "replay") 
+                        foreach (var fileName in new[] 
+                            { save.File
+                            , Path.ChangeExtension(Path.GetFileName(save.File), "png")
+                            , Path.ChangeExtension(Path.GetFileName(save.File), "replay")
+                            , Path.ChangeExtension(Path.GetFileName(save.File), "txt")
+                            , Path.ChangeExtension(Path.GetFileName(save.File), "evaluation.txt")
                             }
                         )
                         {

Source/ORTS.Settings/UserSettings.cs

@@ -338,8 +338,8 @@ public enum DirectXFeature
         public int CarVibratingLevel { get; set; }
         [Default("OpenRailsLog.txt")]
         public string LoggingFilename { get; set; }
-        [Default("OR-DebriefEval.txt")]
-        public string DebriefEvalFilename { get; set; }//
+        [Default("OpenRailsEvaluation.txt")]
+        public string EvaluationFilename { get; set; }//
         [Default("")] // If left as "", OR will use the user's desktop folder
         public string LoggingPath { get; set; }
         [Default("")]

Source/RunActivity/Program.cs

@@ -43,7 +43,8 @@ static class Program
         public static DispatchViewer DebugViewer;
         public static SoundDebugForm SoundDebugForm;
         public static ORTraceListener ORTraceListener;
-        public static string logFileName = "";
+        public static string logFileName = "";          // contains path to file
+        public static string EvaluationFilename = "";   // contains path to file
 
         /// <summary>
         /// The main entry point for the application.

Source/RunActivity/Viewer3D/Popups/HelpWindow.cs

@@ -49,8 +49,7 @@ public class HelpWindow : Window
         Dictionary<int, string> DbfEvalActDepart = new Dictionary<int, string>();//Debrief eval
 
         Dictionary<string, double> DbfEvalValues = new Dictionary<string, double>();//Debrief eval
-        
-        public static string logFileName { get { return Program.logFileName; } set { Program.logFileName = value; } }
+
         ControlLayout scrollbox;
         ControlLayoutHorizontal line;
 
@@ -548,9 +547,10 @@ public HelpWindow(WindowManager owner)
                             ShowEvaluation(locomotive, nmissedstation, dbfstationstopsremaining, playerTrain, colWidth, lcurvespeeddependent, lbreakcouplers, ndbfEvalTaskAccomplished);
                         }
 
-                        //if (dbfevaliscompleted | dbfevalisfinished | dbfevalissuccessful)
+                        if (dbfevaliscompleted | dbfevalisfinished | dbfevalissuccessful)
                         {
                             ReportEvaluation(owner, cl, locomotive, nmissedstation, labeltext, noverspeedcoupling, dbfstationstopsremaining, playerTrain, colWidth, indicator, lcurvespeeddependent, lbreakcouplers, ndbfEvalTaskAccomplished);
+                            System.Diagnostics.Process.Start("notepad.exe", Program.EvaluationFilename);    //Show debrief eval file
                         }
                     }
                 }));
@@ -597,13 +597,9 @@ private void ReportEvaluation(WindowManager owner, ControlLayout cl, TrainCar lo
             colWidth = (cl.RemainingWidth - cl.TextHeight) / 14;
 
             var activityname = owner.Viewer.Simulator.Activity.Tr_Activity.Tr_Activity_Header.Name.ToString().Trim();
-            logFileName = UserSettings.UserDataFolder + "\\" + GameStateRunActivity.FileStem + ".dbfeval.txt";
-
-            //Ensure we start with an empty file.
-            if (File.Exists(logFileName) && !lDebriefEvalFile) File.Delete(logFileName);
 
             //Create file.
-            if (!lDebriefEvalFile) wDbfEval = new StreamWriter(File.Open(logFileName, FileMode.Create), System.Text.Encoding.UTF8);
+            if (!lDebriefEvalFile) wDbfEval = new StreamWriter(File.Open(Program.EvaluationFilename, FileMode.Create), System.Text.Encoding.UTF8);
 
             labeltext = "";
             //--------------------------------------------------------------------------------
@@ -614,8 +610,8 @@ private void ReportEvaluation(WindowManager owner, ControlLayout cl, TrainCar lo
             //--------------------------------------------------------------------------------
             consolewltext("Version      = " + (VersionInfo.Version.Length > 0 ? VersionInfo.Version : "<none>"));
             consolewltext("Build        = " + VersionInfo.Build);
-            if (logFileName.Length > 0)
-                consolewltext("Debrief file = " + logFileName);
+            if (Program.EvaluationFilename.Length > 0)
+                consolewltext("Debrief file = " + Program.EvaluationFilename);
 
             consolewltext("Executable   = " + Path.GetFileName(Application.ExecutablePath));
             LogSeparator(80);
@@ -627,7 +623,7 @@ private void ReportEvaluation(WindowManager owner, ControlLayout cl, TrainCar lo
             indicator.Color = Color.LightGreen;
             line = scrollbox.AddLayoutHorizontalLineOfText();
             //line.Add(indicator = new Label(colWidth, line.RemainingHeight, Viewer.Catalog.GetString(filename)));
-            line.Add(indicator = new Label(colWidth, line.RemainingHeight, Viewer.Catalog.GetString(logFileName)));
+            line.Add(indicator = new Label(colWidth, line.RemainingHeight, Viewer.Catalog.GetString(Program.EvaluationFilename)));
             indicator.Color = Color.LightGreen;
             line = scrollbox.AddLayoutHorizontalLineOfText();
             labeltext = "-------------";
@@ -996,12 +992,10 @@ private void ReportEvaluation(WindowManager owner, ControlLayout cl, TrainCar lo
             LogSeparator(80);
             writeline();
 
-
             if (!lDebriefEvalFile)
             {
                 lDebriefEvalFile = true;
-                wDbfEval.Close();//Close output file
-                System.Diagnostics.Process.Start("notepad.exe", logFileName);//Show debrief eval file
+                wDbfEval.Close();
             }
         }
 

Source/RunActivity/Viewer3D/Processes/GameStateRunActivity.cs

@@ -55,6 +55,7 @@ public class GameStateRunActivity : GameState
         static Viewer Viewer { get { return Program.Viewer; } set { Program.Viewer = value; } }
         static ORTraceListener ORTraceListener { get { return Program.ORTraceListener; } set { Program.ORTraceListener = value; } }
         static string logFileName { get { return Program.logFileName; } set { Program.logFileName = value; } }
+        static string EvaluationFilename { get { return Program.EvaluationFilename; } set { Program.EvaluationFilename = value; } }
 
         // Prefix with the activity filename so that, when resuming from the Menu.exe, we can quickly find those Saves 
         // that are likely to match the previously chosen route and activity.
@@ -385,13 +386,6 @@ public static void Save()
                     outf.Write(argument);
                 outf.Write(Acttype);
 
-                // The Save command is the only command that doesn't take any action. It just serves as a marker.
-                new SaveCommand(Simulator.Log, FileStem);
-                Simulator.Log.SaveLog(Path.Combine(UserSettings.UserDataFolder, FileStem + ".replay"));
-
-                // Copy the logfile to the save folder
-                CopyLog(Path.Combine(UserSettings.UserDataFolder, FileStem + ".txt"));
-
                 Simulator.Save(outf);
                 Viewer.Save(outf, FileStem);
                 // Save multiplayer parameters
@@ -403,6 +397,19 @@ public static void Save()
                 // Write out position within file so we can check when restoring.
                 outf.Write(outf.BaseStream.Position);
             }
+
+            // Having written .save file, write other files: .replay, .txt, .evaluation.txt
+
+            // The Save command is the only command that doesn't take any action. It just serves as a marker.
+            new SaveCommand(Simulator.Log, FileStem);
+            Simulator.Log.SaveLog(Path.Combine(UserSettings.UserDataFolder, FileStem + ".replay"));
+
+            // Copy the logfile to the save folder
+            CopyLog(Path.Combine(UserSettings.UserDataFolder, FileStem + ".txt"));
+
+            // Copy the evaluation file to the save folder
+            if (File.Exists(Program.EvaluationFilename))
+                File.Copy(Program.EvaluationFilename, Path.Combine(UserSettings.UserDataFolder, FileStem + ".evaluation.txt"), true); 
         }
 
         private static void SaveEvaluation(BinaryWriter outf)
@@ -752,10 +759,8 @@ void InitLogging(UserSettings settings, string[] args, bool appendLog)
                 {
                     fileName = settings.LoggingFilename;
                 }
-                foreach (var ch in Path.GetInvalidFileNameChars())
-                    fileName = fileName.Replace(ch, '.');
+                logFileName = GetFilePath(settings, fileName);
 
-                logFileName = Path.Combine(settings.LoggingPath, fileName);
                 // Ensure we start with an empty file.
                 if (!appendLog)
                     File.Delete(logFileName);
@@ -793,6 +798,33 @@ void InitLogging(UserSettings settings, string[] args, bool appendLog)
                 Console.WriteLine("Logging is disabled, only fatal errors will appear here.");
                 LogSeparator();
             }
+            InitEvaluation(settings);
+        }
+
+        /// <summary>
+        /// Sanitises the user's filename, adds logging path (Windows Desktop by default) and deletes any file already existing.
+        /// </summary>
+        /// <param name="settings"></param>
+        void InitEvaluation(UserSettings settings)
+        {
+            EvaluationFilename = GetFilePath(settings, settings.EvaluationFilename);
+
+            // Ensure we start with an empty file.
+            File.Delete(EvaluationFilename);
+        }
+
+        /// <summary>
+        /// Sanitise user's filename and combine with logging path
+        /// </summary>
+        /// <param name="settings"></param>
+        /// <param name="fileName"></param>
+        /// <returns></returns>
+        private string GetFilePath(UserSettings settings, string fileName)
+        {
+            foreach (var ch in Path.GetInvalidFileNameChars())
+                fileName = fileName.Replace(ch, '.');
+
+            return Path.Combine(settings.LoggingPath, fileName);
         }
 
         #region Loading progress indication calculations