Merge branch 'master' into TrainCarOperationsBugfixes

Author: mbm-OR

Source/Contrib/ContentManager/ContentInfo.cs

@@ -27,11 +27,18 @@
 using System.Runtime.Serialization.Formatters.Binary;
 using System.Text;
 using Path = ORTS.ContentManager.Models.Path;
+using ORTS.Common;
 
 namespace ORTS.ContentManager
 {
     public static class ContentInfo
     {
+        // will be set from ConntentManagerGUI constructor
+        public static bool IsMetric = false;
+        public static bool IsUK = false;
+        public static bool IsImperialBHP = false; // using default; seems only used for steam locos
+        public static bool IsImperialBTUpS = false;  // using default; seems only be used for steam locos
+
         public static string GetText(Content content)
         {
             var details = new StringBuilder();
@@ -179,16 +186,39 @@ public static string GetText(Content content)
                 {
                     var data = new Consist(content);
                     details.AppendFormat("Name:\t{1}{0}", Environment.NewLine, data.Name);
-                    details.AppendFormat("Car ID:\tDirection:\tName:\t{0}", Environment.NewLine);
+                    details.AppendFormat("NumEngines:\t{1}{0}", Environment.NewLine, data.NumEngines);
+                    details.AppendFormat("NumCars:\t{1}{0}", Environment.NewLine, data.NumCars);
+                    details.AppendFormat("MaxSpeed:\t{1}{0}", Environment.NewLine, FormatStrings.FormatSpeedLimit(data.MaxSpeedMps, IsMetric));
+                    details.AppendFormat("Weight:\t{1}{0}", Environment.NewLine, FormatStrings.FormatLargeMass(data.MassKG, IsMetric, IsUK));
+                    details.AppendFormat("Length:\t{1}{0}", Environment.NewLine, FormatStrings.FormatShortDistanceDisplay(data.LengthM, IsMetric));
+                    details.AppendFormat("Power:\t{1}{0}", Environment.NewLine, FormatStrings.FormatPower(data.MaxPowerW, IsMetric, IsImperialBHP, IsImperialBTUpS));
+                    details.AppendFormat("MaxTE:\t{1}{0}", Environment.NewLine, FormatStrings.FormatForce(data.MaxTractiveForceN, IsMetric));
+                    details.AppendFormat("MinCouplerStrength:\t{1}{0}", Environment.NewLine, FormatStrings.FormatForce(data.MinCouplerStrengthN, IsMetric));
+                    if (!IsMetric && !IsUK) { details.AppendFormat("HPT:\t{1}{0}", Environment.NewLine, FormatHPT(data.MaxPowerW, data.MassKG)); }
+                    if (!IsMetric && !IsUK) { details.AppendFormat("TPOB:\t{1}{0}", Environment.NewLine, FormatTPOB(data.MassKG, data.NumOperativeBrakes)); }
+                    details.AppendLine();
+                    details.AppendFormat("Car ID:\tDirection:\tWeight:\tName:\t{0}", Environment.NewLine);
                     foreach (var car in data.Cars)
-                        details.AppendFormat("{1}\t{2}\t\u0001{3}\u0002Car\u0001{0}", Environment.NewLine, car.ID, car.Direction, car.Name);
+                        details.AppendFormat("{1}\t{2}\t{3}\t\u0001{4}\u0002Car\u0001{0}", Environment.NewLine, car.ID, car.Direction, car.IsEngine ? "Engine" : FormatMassBar(car.MassKG), car.Name);
                     details.AppendFormat("{0}", Environment.NewLine);
                 }
                 else if (content.Type == ContentType.Car)
                 {
                     var data = new Car(content);
                     details.AppendFormat("Type:\t{1}{0}", Environment.NewLine, data.Type);
+                    details.AppendFormat("SubType:\t{1}{0}", Environment.NewLine, data.SubType);
                     details.AppendFormat("Name:\t{1}{0}", Environment.NewLine, data.Name);
+                    details.AppendFormat("Weight:\t{1} ({2}){0}", Environment.NewLine, FormatStrings.FormatMass(data.MassKG, IsMetric), FormatStrings.FormatLargeMass(data.MassKG, IsMetric, IsUK));
+                    details.AppendFormat("Length:\t{1}{0}", Environment.NewLine, FormatStrings.FormatShortDistanceDisplay(data.LengthM, IsMetric));
+                    if (data.Type == CarType.Engine)
+                    {
+                        details.AppendFormat("MaxPowerW:\t{1}{0}", Environment.NewLine, FormatStrings.FormatPower(data.MaxPowerW, IsMetric, IsImperialBHP, IsImperialBTUpS));
+                        details.AppendFormat("MaxForce:\t{1}{0}", Environment.NewLine, FormatStrings.FormatForce(data.MaxForceN, IsMetric));
+                        details.AppendFormat("MaxSpeed:\t{1}{0}", Environment.NewLine, FormatStrings.FormatSpeedLimit(data.MaxSpeedMps, IsMetric));
+                    }
+                    details.AppendFormat("MaxBrakeF:\t{1}{0}", Environment.NewLine, FormatStrings.FormatForce(data.MaxBarkeForceN, IsMetric));
+                    details.AppendFormat("MinCouplerStrength:\t{1}{0}", Environment.NewLine, FormatStrings.FormatForce(data.MinCouplerStrengthN, IsMetric));
+                    details.AppendLine();
                     details.AppendFormat("Description:\t{0}{0}{1}{0}{0}", Environment.NewLine, data.Description);
                 }
                 else if (content is ContentMSTSCab)
@@ -215,5 +245,46 @@ static string FormatDateTime(DateTime dateTime)
         {
             return String.Format("{0} {1}", dateTime.Day - 1, dateTime.ToLongTimeString());
         }
+
+        /// <summary>
+        /// Create a simple bar graph (string of asterisk) for the car mass.
+        /// </summary>
+        /// <param name="massKg"></param>
+        /// <returns>String of asterisk representing the mass.</returns>
+        static string FormatMassBar(float massKg)
+        {
+            string massBar;
+            var range = (int)Math.Ceiling(massKg / 20000);
+            if (massKg < 1.0) { massBar = "?";  }
+            else if (range > 8) { massBar = new string('*', 8) + '>'; }
+            else { massBar = new string('*', range); }
+            return massBar;
+        }
+
+        /// <summary>
+        /// Calculate and format horsepower per ton for consist, rounded to one decimal.
+        /// </summary>
+        /// <param name="consistPowerW"></param>
+        /// <param name="consistMassKG"></param>
+        /// <returns>horsepower-per-ton formated to one decimal.</returns>
+        //TODO: implement UK and metric version
+        static string FormatHPT(float consistPowerW, float consistMassKG)
+        {
+            var hpt = consistMassKG > 0 ? W.ToHp(consistPowerW) / Kg.ToTUS(consistMassKG) : 0;
+            return string.Format("{0:0.0}", hpt);
+        }
+
+        /// <summary>
+        /// Calculate and format tons per operative brake for consist, rounded to an integer.
+        /// </summary>
+        /// <param name="consistMassKG"></param>
+        /// <param name="consistNumOpBrakes"></param>
+        /// <returns>tons-per-operative-brake formated to an integer.</returns>
+        //TODO: implement UK and metric version
+        static string FormatTPOB(float consistMassKG, float consistNumOpBrakes)
+        {
+            var tpob = consistNumOpBrakes > 0 ? Kg.ToTUS(consistMassKG) / consistNumOpBrakes : 0;
+            return string.Format("{0:0}", tpob);
+        }
     }
 }

Source/Contrib/ContentManager/ContentManagerGUI.Designer.cs

@@ -75,6 +75,17 @@ public ContentManagerGUI()
             Settings = new UserSettings(new string[0]);
             ContentManager = new ContentManager(Settings.Folders);
 
+            // add unit settings to ContentInfo static class; only considering explict setting or system setting
+            if (Settings.Units == "Metric") { ContentInfo.IsMetric = true; }
+            else if (Settings.Units == "UK") { ContentInfo.IsUK = true; }
+            else // setting is Automatic or Route
+            {
+                ContentInfo.IsMetric = System.Globalization.RegionInfo.CurrentRegion.IsMetric;
+                // special cases
+                if (System.Globalization.RegionInfo.CurrentRegion.Name == "UK") { ContentInfo.IsUK = true; }
+                else if (System.Globalization.RegionInfo.CurrentRegion.Name == "CA") { ContentInfo.IsMetric = false; } // Canada is metric, but RRs use imperial US
+            }
+
             // Start off the tree with the Content Manager itself at the root and expand to show packages.
             treeViewContent.Nodes.Add(CreateContentNode(ContentManager));
             treeViewContent.Nodes[0].Expand();

Source/Contrib/ContentManager/ContentManagerGUI.cs

@@ -33,25 +33,41 @@ public enum CarType
     public class Car
     {
         public readonly CarType Type;
+        public readonly string SubType;
         public readonly string Name;
         public readonly string Description;
+        public readonly float MassKG;
+        public readonly float LengthM;
+        public readonly float MaxBarkeForceN;
+        public readonly float MaxPowerW;
+        public readonly float MaxForceN;
+        public readonly float MaxSpeedMps;
+        public readonly float MinCouplerStrengthN;
 
         public Car(Content content)
         {
             Debug.Assert(content.Type == ContentType.Car);
+
+            // .eng files also have a wagon block
+            var wagFile = new WagonFile(content.PathName);
+            Type = CarType.Wagon;
+            SubType = wagFile.WagonType;
+            Name = wagFile.Name;
+            MassKG = wagFile.MassKG;
+            LengthM = wagFile.WagonSize.LengthM;
+            MaxBarkeForceN = wagFile.MaxBrakeForceN;
+            MinCouplerStrengthN = wagFile.MinCouplerStrengthN;
+
             if (System.IO.Path.GetExtension(content.PathName).Equals(".eng", StringComparison.OrdinalIgnoreCase))
             {
-                var file = new EngineFile(content.PathName);
+                var engFile = new EngineFile(content.PathName);
                 Type = CarType.Engine;
-                Name = file.Name;
-                Description = file.Description;
-            }
-            else if (System.IO.Path.GetExtension(content.PathName).Equals(".wag", StringComparison.OrdinalIgnoreCase))
-            {
-                var file = new WagonFile(content.PathName);
-                Type = CarType.Wagon;
-                Name = file.Name;
-                Description = "";
+                SubType = engFile.EngineType;
+                Name = engFile.Name;
+                MaxPowerW = engFile.MaxPowerW;
+                MaxForceN = engFile.MaxForceN;
+                MaxSpeedMps = engFile.MaxSpeedMps;
+                Description = engFile.Description;
             }
         }
     }

Source/Contrib/ContentManager/Models/Car.cs

@@ -19,14 +19,26 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.IO;
 using System.Linq;
+using System.Runtime.CompilerServices;
 using System.Text;
 
 namespace ORTS.ContentManager.Models
 {
     public class Consist
     {
         public readonly string Name;
+        public readonly string NumEngines; // using "+" between DPU sets
+        public readonly string NumCars;
+        public readonly float MaxSpeedMps;
+        public readonly float LengthM = 0F;
+        public readonly float MassKG = 0F;
+        public readonly float MaxPowerW = 0F;
+        public readonly float MaxTractiveForceN = 0F;
+        public readonly float MaxBrakeForce = 0F;
+        public readonly int NumOperativeBrakes = 0;
+        public readonly float MinCouplerStrengthN = 9.999e8f;  // impossible high force
 
         public readonly IEnumerable<Car> Cars;
 
@@ -37,9 +49,60 @@ public Consist(Content content)
             {
                 var file = new ConsistFile(content.PathName);
                 Name = file.Name;
+                MaxSpeedMps = file.Train.TrainCfg.MaxVelocity.A;
 
-                Cars = from car in file.Train.TrainCfg.WagonList
-                           select new Car(car);
+                var EngCount = 0;
+                var WagCount = 0;
+                var Separator = ""; // when set, indicates that subsequent engines are in a separate block
+
+                var basePath = System.IO.Path.Combine(System.IO.Path.Combine(content.Parent.PathName, "Trains"), "Trainset");
+
+                var CarList = new List<Car>();
+                foreach (Wagon wag in file.Train.TrainCfg.WagonList)
+                {
+                    float wagonMassKG = 0;
+                    try
+                    {
+                        var fileType = wag.IsEngine ? ".eng" : ".wag";
+                        var filePath = System.IO.Path.Combine(System.IO.Path.Combine(basePath, wag.Folder), wag.Name + fileType);
+                        var wagonFile = new WagonFile(filePath);
+                        var engFile = wag.IsEngine ? new EngineFile(filePath) : null;
+
+                        LengthM += wagonFile.WagonSize.LengthM;
+                        MassKG += wagonFile.MassKG;
+                        wagonMassKG = wagonFile.MassKG;
+                        MaxBrakeForce += wagonFile.MaxBrakeForceN;
+                        MinCouplerStrengthN = Math.Min(MinCouplerStrengthN, wagonFile.MinCouplerStrengthN);
+                        if (wagonFile.MaxBrakeForceN > 0) { NumOperativeBrakes++; }
+
+                        if (wag.IsEngine && engFile.MaxForceN > 25000)  // exclude legacy driving trailers / cab-cars
+                        {
+                            EngCount++;
+
+                            MaxPowerW += engFile.MaxPowerW;
+                            MaxTractiveForceN += engFile.MaxForceN;
+                        }
+                        else if (!wag.IsEOT && wagonFile.WagonSize.LengthM > 1.1) // exclude legacy EOT
+                        {
+                            WagCount++;
+                        }
+                    } catch (IOException e) // continue without details when eng/wag file does not exist
+                    {
+                        if (wag.IsEngine) { EngCount++; } else { WagCount++; }
+                    }
+
+                    if (!wag.IsEngine && EngCount > 0)
+                    {
+                        NumEngines = NumEngines + Separator + EngCount.ToString();
+                        EngCount = 0; Separator = "+";
+                    }
+
+                    CarList.Add(new Car(wag, wagonMassKG));
+                }
+                if (EngCount > 0) { NumEngines = NumEngines + Separator + EngCount.ToString(); }
+                if (NumEngines == null) { NumEngines = "0"; }
+                NumCars = WagCount.ToString();
+                Cars = CarList;
             }
         }
 
@@ -53,12 +116,16 @@ public class Car
             public readonly string ID;
             public readonly string Name;
             public readonly Direction Direction;
+            public readonly bool IsEngine;
+            public readonly float MassKG;
 
-            internal Car(Wagon car)
+            internal Car(Wagon car, float massKg)
             {
                 ID = car.UiD.ToString();
                 Name = car.Folder + "/" + car.Name;
                 Direction = car.Flip ? Consist.Direction.Backwards : Consist.Direction.Forwards;
+                IsEngine = car.IsEngine;
+                MassKG = massKg;
             }
         }
     }

Source/Contrib/ContentManager/Models/Consist.cs

@@ -1870,7 +1870,7 @@ Following activity features are randomized:
   will be shown in red in the train operations window and will squeal 
   if an .sms file named BrakesStuck.sms is present in the 
   ``<Train Simulator\Sound>`` directory. `Here 
-  <http://www.interazioni-educative.it/Varie/BrakesStuckSound.zip>`_ 
+  <https://static.openrails.org/files/BrakesStuckSound.zip>`_ 
   an example of such file. 
   Of course when this event occurs it is advisable to uncouple the 
   wagon as soon as possible from the train. No more than a car will