Merge pull request #754 from Csantucci/container-weights-official

Container weights: https://blueprints.launchpad.net/or/+spec/container-weights
Blueprint approved and code merged.

Thanks, Carlo,

Chris

Author: cjakeman

Source/Documentation/Manual/features-rollingstock.rst

@@ -599,6 +599,8 @@ Here below a sample of a ``.load-or`` file::
 	  	"Shape" : "COMMON_Container_3d\\Cont_40ftHC\\container-40ftHC_Triton.s",
 	  	"ContainerType" : "C40ftHC",
 	  	"IntrinsicShapeOffset": [0,1.175,0],
+   		"EmptyMassKG": 2100.,
+		  "MaxMassWhenLoadedKG": 28000.,
 	  }
   }
 
@@ -621,20 +623,30 @@ Here below a sample of a ``.load-or`` file::
   container with respect to the container shape file coordinates. Unfortunately often such 
   offset is not [0,0,0], which would be advisable for newly produced containers. A simple way to 
   state such offset is to use the ``Show Bounding Info`` of ``Shape Viewer``.
+- "EmptyMassKG" is an optional parameter that defines the tare (weight when empty) of the 
+  container. If the parameter is not present, OR uses a default parameter, specific for that 
+  ContainerType.
+- "MaxMassWhenLoadedKG" is an optional parameter that defines the sum of the tare plus the maximum 
+  allowed payload. As above, if the parameter is not present, OR uses a default parameter, specific for that 
+  ContainerType.
+
 
 Pre-setting a .wag file to accommodate containers
 -------------------------------------------------
 
 As a minimum following block must be present in the .wag file for a double stacker::
 
   ORTSFreightAnims (
+		WagonEmptyWeight ( 12.575t )
 		LoadingAreaLength ( 12.20 )
 		AboveLoadingAreaLength ( 12.20 )
 		DoubleStacker ()
 		Offset( 0 0.34 0 )
 		IntakePoint ( 0 6.0 Container)
 		)
 
+- WagonEmptyWeight is the weight of the wagon, when it has neither containers nor other 
+  weighing freight animations on board
 - LoadingAreaLength is the length in meters of the loading area available for containers
 - AboveLoadingAreaLength is the length in meters of the above loading area available 
   for containers (parameter not needed if not double stacker)
@@ -694,9 +706,9 @@ shown here::
 
   		Wagon (
 			  WagonData ( DTTX_620040_A ATW.DTTX_620040 )
-			  LoadData ( 20cmacgm common.containerdata CenterFront)
-			  LoadData ( 20hamburgsud common.containerdata CenterRear)
-			  LoadData ( 40msc common.containerdata Above)			
+			  LoadData ( 20cmacgm common.containerdata CenterFront Empty)
+			  LoadData ( 20hamburgsud common.containerdata CenterRear Loaded)
+			  LoadData ( 40msc common.containerdata Above Random)			
 			  UiD ( 11 )
 		)
 
@@ -707,7 +719,17 @@ present. The meaning of the parameters is as follows:
 - The first parameter is the name of the ``.load-or`` file 
 - The second parameter is the path (having ``Trainset`` as base path) where the ``.load-or``
   file resides 
-- The third parameter indicates where the container is allocated on the wagon.
+- The third parameter indicates where the container is allocated on the wagon
+- The fourth parameter, which is optional, defines the load state of the related container, 
+  which is used to derive the weight of the container. If ``Empty`` is present, the weight 
+  of the empty container is used as actual weight; if ``Loaded`` is present, the maximum 
+  weight (tare + payload) of the container is used; if ``Random`` is present, the weight 
+  is computed as follows: a random number between 0 and 100 is generated. If the number is 
+  below 31, the container is considered empty; else the number is used as percentage of the 
+  maximum weight of the container (tare + payload). The weight of the containers are added to 
+  the empty weight of the wagon, to compute the total weight of the wagon. If the parameter 
+  is not present, the ``Random`` value is assumed.
+
 
 The entry for the container allocated ``Above`` must be the last one.
 
@@ -733,18 +755,19 @@ A minimum ``FreightAnimations`` entry in a ``.wag`` file to have the same pre-lo
 set as in the previous paragraph is as follows::
 
     ORTSFreightAnims (
-	  	LoadingAreaLength ( 14.6 )
-	  	AboveLoadingAreaLength ( 16.15 )
+		  WagonEmptyWeight ( 12.575t )
+		  LoadingAreaLength ( 14.6 )
+		  AboveLoadingAreaLength ( 16.15 )
 		  DoubleStacker ()
 		  Offset( 0 0.34 0 )
 		  IntakePoint ( 0 6.0 Container)
-		  LoadData ( 20cmacgm common.containerdata CenterFront)
-		  LoadData ( 20hamburgsud common.containerdata CenterRear)
-		  LoadData ( 40msc common.containerdata Above)
+		  LoadData ( 20cmacgm common.containerdata CenterFront Empty)
+		  LoadData ( 20hamburgsud common.containerdata CenterRear Loaded)
+		  LoadData ( 40msc common.containerdata Above Random)
 		)
 
 As can be seen, the syntax of the ``LoadData`` entries is the same as in the case of 
-the ``.con``  file.
+the ``.con``  file. Also here the fourth parameter is optional.
 
 Obviously, using ``.wag`` files for this type of info, a different ``.wag`` file must 
 be created for every desired pre-loaded set of containers.
@@ -1048,9 +1071,9 @@ The ``.load-stations-loads-or`` file is a Json file. An example is shown here be
 		{
 			"LoadStationID" : { "wfile" : "w-005354+014849.w", "UiD" :  21, },
 			"LoadData" : [
-				{ "File" : "40HCcai", "Folder" : "common.containerdata", "StackLocation" : 0, },
-				{ "File" : "40HCcai", "Folder" : "common.containerdata", "StackLocation" : 0, },
-				{ "File" : "20cmacgm", "Folder" : "common.containerdata", "StackLocation" : 2, },
+				{ "File" : "40HCcai", "Folder" : "common.containerdata", "StackLocation" : 0, "LoadState" : "Empty"},
+				{ "File" : "40HCcai", "Folder" : "common.containerdata", "StackLocation" : 0, "LoadState" : "Loaded"},
+				{ "File" : "20cmacgm", "Folder" : "common.containerdata", "StackLocation" : 2, "LoadState" : "Random"},
 				{ "File" : "20kline", "Folder" : "common.containerdata", "StackLocation" : 2, },
 				{ "File" : "45HCtriton", "Folder" : "common.containerdata", "StackLocation" : 5, },
 				{ "File" : "45HCtriton", "Folder" : "common.containerdata", "StackLocation" : 5, },
@@ -1081,6 +1104,8 @@ The file can define the population at startup of many container stations.
   index refers to a child stack location.
 - If more than a container is defined for a stack location, they are stacked one above the 
   other.
+- The ``LoadState`` parameter is optional, and has the same meaning and values as the 
+  parameter of the same name which can be present in .con or .wag files.
 
 The container station population file must be written taking into account the constraints 
 of the stack locations (container length must be smaller than stack location lenght, 

Source/ORTS.Common/enums.cs

@@ -72,4 +72,14 @@ public enum LoadPosition
         Above
     }
 
+    /// <summary>
+    /// Defines the loading state of a load (e.g. a container) on a wagon
+    /// </summary>
+    public enum LoadState
+    {
+        Random,
+        Empty,
+        Loaded,
+    }
+
 }

Source/Orts.Formats.Msts/ActivityFile.cs

@@ -296,6 +296,7 @@ public struct LoadData
         public string Name;
         public string Folder;
         public LoadPosition LoadPosition;
+        public LoadState LoadState;
     }
 
     /// <summary>
@@ -1341,8 +1342,15 @@ public Wagon(STFReader stf) {
                     loadData.Folder = stf.ReadString();
                     var positionString = stf.ReadString();
                     Enum.TryParse(positionString, out loadData.LoadPosition);
-                    LoadDataList.Add(loadData);
-                    stf.MustMatch(")");
+                    var state = stf.ReadString();
+                    if (state != ")")
+                    {
+                        Enum.TryParse(state, out loadData.LoadState);
+                        LoadDataList.Add(loadData);
+                        stf.MustMatch(")");
+                    }
+                    else
+                        LoadDataList.Add(loadData);
                 }),
             });
         }

Source/Orts.Formats.OR/ContainerFile.cs

@@ -65,7 +65,8 @@ public class ContainerParameters
         public string ShapeFileName;  
         public string ContainerType;  
         public Vector3 IntrinsicShapeOffset = new Vector3(0f, 1.17f, 0f);
-
+        public float EmptyMassKG = -1;
+        public float MaxMassWhenLoadedKG = -1;
 
         public ContainerParameters(JsonReader json)
         {
@@ -80,6 +81,8 @@ bool TryParse(JsonReader item)
                 case "Shape": ShapeFileName = item.AsString(ShapeFileName); break;
                 case "ContainerType": ContainerType = item.AsString("40ftHC"); break;
                 case "IntrinsicShapeOffset[]": IntrinsicShapeOffset = item.AsVector3(Vector3.Zero); break;
+                case "EmptyMassKG": EmptyMassKG = item.AsFloat(-1); break;
+                case "MaxMassWhenLoadedKG": MaxMassWhenLoadedKG = item.AsFloat(-1); break;
                 default: return false;
             }
             return true;

Source/Orts.Formats.OR/LoadStationsPopulationFile.cs

@@ -22,7 +22,9 @@
 using System.Text;
 using System.IO;
 using Microsoft.Xna.Framework;
+using Orts.Formats.Msts;
 using Orts.Parsers.OR;
+using ORTS.Common;
 
 namespace Orts.Formats.OR
 {
@@ -113,6 +115,7 @@ public class LoadDataEntry
         public string FileName;
         public string FolderName;
         public int StackLocation;
+        public LoadState LoadState;
 
         public LoadDataEntry(JsonReader json)
         {
@@ -126,6 +129,7 @@ bool TryParse(JsonReader item)
                 case "File": FileName = item.AsString(""); break;
                 case "Folder": FolderName = item.AsString(""); break;
                 case "StackLocation": StackLocation = item.AsInteger(0); break;
+                case "LoadState": Enum.TryParse(item.AsString(""), out LoadState); break;
                 default: return false;
             }
             return true;

Source/Orts.Simulation/Simulation/Container.cs

@@ -66,14 +66,17 @@ public enum Status
         public string ShapeFileName;
         public string BaseShapeFileFolderSlash;
         public float MassKG = 2000;
+        public float EmptyMassKG;
+        public float MaxMassWhenLoadedKG;
         public float WidthM = 2.44f;
         public float LengthM = 12.19f;       
         public float HeightM = 2.59f;
         public ContainerType ContainerType = ContainerType.C40ft;
         public bool Flipped = false;
         public static float Length20ftM = 6.095f;
         public static float Length40ftM = 12.19f;
-
+        public static float[] DefaultEmptyMassKG = { 0, 2160, 3900, 4100, 4500, 4700, 4900, 5040 };
+        public static float[] DefaultMaxMassWhenLoadedKG = { 0, 24000, 30500, 30500, 30500, 30500, 30500, 30500 };
         public WorldPosition WorldPosition = new WorldPosition();  // current position of the container
         public float RealRelativeYOffset = 0;
         public float RealRelativeZOffset = 0;
@@ -117,6 +120,8 @@ public virtual void Copy(Container containerCopy)
             ComputeDimensions();
             Flipped = containerCopy.Flipped;
             MassKG = containerCopy.MassKG;
+            EmptyMassKG = containerCopy.EmptyMassKG;
+            MaxMassWhenLoadedKG = containerCopy.MaxMassWhenLoadedKG;
         }
 
         public Container(BinaryReader inf, FreightAnimationDiscrete freightAnimDiscrete, ContainerHandlingItem containerStation, bool fromContainerStation, int stackLocationIndex = 0)
@@ -134,6 +139,8 @@ public Container(BinaryReader inf, FreightAnimationDiscrete freightAnimDiscrete,
             ComputeDimensions();
             Flipped = inf.ReadBoolean();
             MassKG = inf.ReadSingle();
+            EmptyMassKG = inf.ReadSingle();
+            MaxMassWhenLoadedKG = inf.ReadSingle();
             if (fromContainerStation)
             {
                 // compute WorldPosition starting from offsets and position of container station
@@ -231,6 +238,8 @@ public void Save(BinaryWriter outf, bool fromContainerStation = false)
             outf.Write((int)ContainerType);
             outf.Write(Flipped);
             outf.Write(MassKG);
+            outf.Write(EmptyMassKG);
+            outf.Write(MaxMassWhenLoadedKG);
             if (fromContainerStation)
             {
 
@@ -254,6 +263,8 @@ public void LoadFromContainerFile(string loadFilePath, string baseFolder)
             ComputeDimensions();
             IntrinsicShapeOffset = containerParameters.IntrinsicShapeOffset;
             IntrinsicShapeOffset.Z *= -1;
+            EmptyMassKG = containerParameters.EmptyMassKG != -1 ? containerParameters.EmptyMassKG : DefaultEmptyMassKG[(int)ContainerType] ;
+            MaxMassWhenLoadedKG = containerParameters.MaxMassWhenLoadedKG != -1 ? containerParameters.MaxMassWhenLoadedKG : DefaultMaxMassWhenLoadedKG[(int)ContainerType];
         }
 
         public void ComputeWorldPosition (FreightAnimationDiscrete freightAnimDiscrete)
@@ -268,6 +279,24 @@ public void ComputeWorldPosition (FreightAnimationDiscrete freightAnimDiscrete)
             var invWagonMatrix = Matrix.Invert(freightAnimDiscrete.Wagon.WorldPosition.XNAMatrix);
             RelativeContainerMatrix = Matrix.Multiply(WorldPosition.XNAMatrix, invWagonMatrix);
         }
+
+        public void ComputeLoadWeight(LoadState loadState)
+        {
+            switch (loadState)
+            {
+                case LoadState.Empty:
+                    MassKG = EmptyMassKG;
+                    break;
+                case LoadState.Loaded:
+                    MassKG = MaxMassWhenLoadedKG;
+                    break;
+                case LoadState.Random:
+                    var loadPercent = Simulator.Random.Next(101);
+                    if (loadPercent < 30) MassKG = EmptyMassKG;
+                    else MassKG = MaxMassWhenLoadedKG * loadPercent / 100f;
+                    break;
+            }
+        }
     }
 
     public class ContainerManager
@@ -511,14 +540,14 @@ public void PreloadContainerStation(PickupObj thisWorldObj)
                             Trace.TraceWarning($"Ignored missing load {loadFilePath}");
                             continue;
                         }
-                        Preload(loadFilePath, loadDataEntry.StackLocation);
+                        Preload(loadFilePath, loadDataEntry.StackLocation, loadDataEntry.LoadState);
                     }
                     break;
                 }
             }
          }
 
-        public void Preload(string loadFilePath, int stackLocationIndex)
+        public void Preload(string loadFilePath, int stackLocationIndex, LoadState loadState)
         {
             Container container;
             container = new Container(null, loadFilePath, this);
@@ -531,6 +560,8 @@ public void Preload(string loadFilePath, int stackLocationIndex)
                 container.LoadFromContainerFile(loadFilePath, Simulator.BasePath + @"\trains\trainset\");
                 ContainerManager.LoadedContainers.Add(loadFilePath, container);
             }
+            container.ComputeLoadWeight(loadState);
+
             var stackLocation = StackLocations[stackLocationIndex];
             if (stackLocation.Containers != null && stackLocation.Containers.Count >= stackLocation.MaxStackedContainers)
                 Trace.TraceWarning("Stack Location {0} is full, can't lay down container", stackLocationIndex);