Merge pull request #347 from Csantucci/multiple-horn-blows

https://blueprints.launchpad.net/or/+spec/horn-blow-sequence American horn blow sequence for AI trains

Author: Csantucci

Source/Contrib/TrackViewer/Editing/WaitPointDialog.xaml

@@ -43,7 +43,7 @@
             <RadioButton GroupName="shuntingOption" Name="selectBlowHorn" VerticalAlignment="Center" 
                          Content="Blow horn for" Width="105" Checked="Option_CheckChanged" />
             <TextBox Height="23" Name="blowHornSeconds" Width="35" PreviewTextInput="NumberValidationTextBox" KeyDown="OnKeyDownHandler" TextChanged="TwoDigits_TextChanged"/>
-            <Label Content="seconds. "/>
+            <Label Content="seconds.  11 = American horn sequence."/>
         </StackPanel>
         <Separator/>
         <StackPanel Orientation="Horizontal">

Source/Contrib/TrackViewer/Editing/WaitPointDialog.xaml.cs

@@ -84,7 +84,7 @@ public WaitPointDialog(int mouseX, int mouseY, int currentWaitTimeS)
             {
                 aiRequestPassRed.IsChecked = true;
             }
-            else if (currentWaitTimeS >= 60011 && currentWaitTimeS <= 60020)
+            else if (currentWaitTimeS >= 60011 && currentWaitTimeS <= 60021)
             {
                 int seconds = currentWaitTimeS - 60010;
                 blowHornSeconds.Text = seconds.ToString(System.Globalization.CultureInfo.CurrentCulture);
@@ -134,18 +134,18 @@ public int GetWaitTime()
             }
             if (selectBlowHorn.IsChecked == true)
             {
-                // coding is 60011 to 60020
+                // coding is 60011 to 60021; 60021 used for American Horn Sequence
                 int seconds = GetIntOrZero(blowHornSeconds.Text);
                 if (seconds < 0)
                 {
                     // we need to allow 0 itself (which we get from an empty string) otherwise it is not even possible to go from '1' to '2' or so.
                     seconds = 1;
                     blowHornSeconds.Text = "1";
                 }
-                if (seconds > 10)
+                if (seconds > 11)
                 {
-                    seconds = 10;
-                    blowHornSeconds.Text = "10";
+                    seconds = 11;
+                    blowHornSeconds.Text = "11";
                 }
                 return 60010 + seconds;
             }

Source/Documentation/Manual/operation.rst

@@ -1819,8 +1819,12 @@ AI Train Horn Blow
 ------------------
 
 Horn blow by AI trains is achieved by inserting into the AI train path a 
-waiting point with a waiting time value between 60011 (1 second horn blow) and 
-60020 (10 seconds horn blow).
+waiting point.
+If the waiting time value is between 60011 (1 second horn blow) and 
+60020 (10 seconds horn blow), a single horn blow is generated.
+If the waiting time value is 60021, a horn blow sequence is generated, 
+with the pattern long blow - long blow - short blow - long blow (North 
+American horn pattern at level crossings).
 
 The AI train will not stop at these waiting points, but will continue at its 
 regular speed.
@@ -1857,7 +1861,22 @@ is inserted into the activity file following the line::
 
 (note that the number in the brackets may be different), then AI trains will 
 blow their horn at level crossings for a random time between 2 and 5 
-seconds.The level crossing must be defined as such in the MSTS route editor. 
+seconds. The level crossing must be defined as such in the MSTS route editor. 
+
+If line::
+
+    ORTSAIHornAtCrossings ( 1 )
+
+is followed by line::
+
+	ORTSAICrossingHornPattern ( US )
+
+instead of a single horn blow, a horn blow sequence will be generated
+for all AI trains before crossings,  
+with the pattern long blow - long blow - short blow - long blow (North 
+American horn pattern at level crossings). 
+
+
 *Simple* road crossings, not defined as level crossings, may also be present in 
 the route. The AI train will not blow the horn at these crossings. Examining 
 the route with TrackViewer allows identification of the true level crossings. 

Source/ORTS.Common/enums.cs

@@ -42,4 +42,20 @@ public static Direction Flip(Direction direction)
                 return Direction.Forward;
         }
     }
+
+    /// <summary>
+    /// A type of horn pattern used by AI trains at level crossings.
+    /// </summary>
+    public enum LevelCrossingHornPattern
+    {
+        /// <summary>
+        /// A single blast just before the crossing.
+        /// </summary>
+        Single,
+
+        /// <summary>
+        /// A long-long-short-long pattern used in the United States and Canada.
+        /// </summary>
+        US,
+    }
 }

Source/Orts.Formats.Msts/ActivityFile.cs

@@ -273,6 +273,7 @@
 using System.Text;
 using System.IO;
 using Orts.Parsers.Msts; // For class S (seconds)
+using ORTS.Common;
 
 namespace Orts.Formats.Msts
 {
@@ -492,23 +493,25 @@ public class Tr_Activity_File {
         public Traffic_Definition Traffic_Definition;
         public PlatformNumPassengersWaiting PlatformNumPassengersWaiting;
         public ActivityRestrictedSpeedZones ActivityRestrictedSpeedZones;
-        public int ORTSAIHornAtCrossings = -1;
+        public bool AIBlowsHornAtLevelCrossings { get; private set; } = false;
+        public LevelCrossingHornPattern AILevelCrossingHornPattern { get; private set; } = LevelCrossingHornPattern.Single;
 
 
         public Tr_Activity_File(STFReader stf) {
             stf.MustMatch("(");
-            stf.ParseBlock(new STFReader.TokenProcessor[] {
+            var parser = new List<STFReader.TokenProcessor> {
                 new STFReader.TokenProcessor("player_service_definition",()=>{ Player_Service_Definition = new Player_Service_Definition(stf); }),
                 new STFReader.TokenProcessor("nextserviceuid",()=>{ NextServiceUID = stf.ReadIntBlock(null); }),
                 new STFReader.TokenProcessor("nextactivityobjectuid",()=>{ NextActivityObjectUID = stf.ReadIntBlock(null); }),
-                new STFReader.TokenProcessor("ortsaihornatcrossings", ()=>{ ORTSAIHornAtCrossings = stf.ReadIntBlock(ORTSAIHornAtCrossings); }),
                 new STFReader.TokenProcessor("events",()=>{ Events = new Events(stf); }),
                 new STFReader.TokenProcessor("traffic_definition",()=>{ Traffic_Definition = new Traffic_Definition(stf); }),
                 new STFReader.TokenProcessor("activityobjects",()=>{ ActivityObjects = new ActivityObjects(stf); }),
                 new STFReader.TokenProcessor("platformnumpassengerswaiting",()=>{ PlatformNumPassengersWaiting = new PlatformNumPassengersWaiting(stf); }),  // 35 files. To test, use EUROPE1\ACTIVITIES\aftstorm.act
                 new STFReader.TokenProcessor("activityfailedsignals",()=>{ ActivityFailedSignals = new ActivityFailedSignals(stf); }),
                 new STFReader.TokenProcessor("activityrestrictedspeedzones",()=>{ ActivityRestrictedSpeedZones = new ActivityRestrictedSpeedZones(stf); }),   // 27 files. To test, use EUROPE1\ACTIVITIES\lclsrvce.act
-            });
+            };
+            parser.AddRange(ORSpecificDataTokenProcessors(stf));
+            stf.ParseBlock(parser);
         }
 
         // Used for explore in activity mode
@@ -525,14 +528,28 @@ public Tr_Activity_File()
         public void InsertORSpecificData(STFReader stf)
         {
             stf.MustMatch("(");
-            stf.ParseBlock(new STFReader.TokenProcessor[] {
-                new STFReader.TokenProcessor("ortsaihornatcrossings", ()=>{ ORTSAIHornAtCrossings = stf.ReadIntBlock(ORTSAIHornAtCrossings); }),
+            var parser = new List<STFReader.TokenProcessor> {
                 new STFReader.TokenProcessor("events",()=>
                 {
                     if ( Events == null) Events = new Events(stf);
                     else Events.InsertORSpecificData (stf);
                 }
                 ),
+            };
+            parser.AddRange(ORSpecificDataTokenProcessors(stf));
+            stf.ParseBlock(parser);
+        }
+
+        private IEnumerable<STFReader.TokenProcessor> ORSpecificDataTokenProcessors(STFReader stf)
+        {
+            yield return new STFReader.TokenProcessor("ortsaihornatcrossings", () =>
+            {
+                AIBlowsHornAtLevelCrossings = stf.ReadIntBlock(Convert.ToInt32(AIBlowsHornAtLevelCrossings)) > 0;
+            });
+            yield return new STFReader.TokenProcessor("ortsaicrossinghornpattern", () =>
+            {
+                if (Enum.TryParse<LevelCrossingHornPattern>(stf.ReadStringBlock(""), ignoreCase: true, out var value))
+                    AILevelCrossingHornPattern = value;
             });
         }
     }

Source/Orts.Formats.OR/AuxActionRef.cs

@@ -16,6 +16,7 @@
 // along with Open Rails.  If not, see <http://www.gnu.org/licenses/>.
 
 using Newtonsoft.Json;
+using Newtonsoft.Json.Converters;
 using ORTS.Common;
 using System;
 using System.Collections.Generic;
@@ -358,12 +359,16 @@ public class AuxActionHorn : AuxActionRef
         public int Delay;
         [JsonProperty("RequiredDistance")]
         public float RequiredDistance;
+        [JsonProperty("Pattern")]
+        [JsonConverter(typeof(StringEnumConverter))]
+        public LevelCrossingHornPattern Pattern { get; private set; }
 
-        public AuxActionHorn(bool isGeneric, int delay = 2, float requiredDistance = 0) :    //WorldLocation? location, float requiredSpeedMpS, , int endSignalIndex = -1, AUX_ACTION actionType = AUX_ACTION.SOUND_HORN, , float requiredDistance = 0) :
-            base(AUX_ACTION.SOUND_HORN ,isGeneric)                                          //location, requiredSpeedMpS, , endSignalIndex, actionType, delay, requiredDistance)
+        public AuxActionHorn(bool isGeneric, int delay = 2, float requiredDistance = 0, LevelCrossingHornPattern hornPattern = LevelCrossingHornPattern.Single) :    //WorldLocation? location, float requiredSpeedMpS, , int endSignalIndex = -1, AUX_ACTION actionType = AUX_ACTION.SOUND_HORN, , float requiredDistance = 0) :
+            base(AUX_ACTION.SOUND_HORN, isGeneric)                                          //location, requiredSpeedMpS, , endSignalIndex, actionType, delay, requiredDistance)
         {
             Delay = delay;
             RequiredDistance = requiredDistance;
+            Pattern = hornPattern;
         }
 
         public static void Register(string key)
@@ -376,6 +381,7 @@ public void SaveProperties(AuxActionHorn action)
         {
             Delay = action.Delay;
             RequiredDistance = action.RequiredDistance;
+            Pattern = action.Pattern;
         }
     }
 

Source/Orts.Parsers.Msts/STFReader.cs

@@ -1477,7 +1477,7 @@ public void ParseFile(ParsingBreak breakout, TokenProcessor[] processors)
         /// <summary>Parse an STF file until the end of block ')' marker, using the array of lower case tokens, with a processor delegate/lambda
         /// </summary>
         /// <param name="processors">Array of lower case token, and the delegate/lambda to call when matched.</param>
-        public void ParseBlock(TokenProcessor[] processors)
+        public void ParseBlock(IEnumerable<TokenProcessor> processors)
         { // Press F10 'Step Over' to jump to the next token
 #line hidden
             while (!EndOfBlock())

Source/Orts.Simulation/Simulation/AIs/AI.cs

@@ -79,10 +79,10 @@ public AI(Simulator simulator, CancellationToken cancellation, double activitySt
 #endif
             if (simulator.Activity != null && simulator.Activity.Tr_Activity.Tr_Activity_File.Traffic_Definition != null)
             {
-                foreach (var sd in simulator.Activity.Tr_Activity.Tr_Activity_File.Traffic_Definition.ServiceDefinitionList)
+                var activityFile = simulator.Activity.Tr_Activity.Tr_Activity_File;
+                foreach (var sd in activityFile.Traffic_Definition.ServiceDefinitionList)
                 {
-                    AITrain train = CreateAITrain(sd,
-                    simulator.Activity.Tr_Activity.Tr_Activity_File.Traffic_Definition.TrafficFile.TrafficDefinition, simulator.TimetableMode);
+                    AITrain train = CreateAITrain(sd, activityFile.Traffic_Definition.TrafficFile.TrafficDefinition, simulator.TimetableMode);
                     if (cancellation.IsCancellationRequested) // ping loader watchdog
                         return;
                 }