Adds JoinMapAdvanced class and updates SIMPLAtcJoinMap and SIMPLAtcMessenger accordingly

PepperDashEssentials/AppServer/Messengers/SIMPLAtcMessenger.cs

@@ -124,9 +124,9 @@ namespace PepperDash.Essentials.AppServer.Messengers
 			this.PostStatusMessage(new
 			{				
 				calls = GetCurrentCallList(),
-				currentCallString = EISC.GetString(JoinMap.GetJoinForKey(SIMPLAtcJoinMap.CurrentCallName)),
+				currentCallString = EISC.GetString(JoinMap.CurrentCallName.JoinNumber),
-				currentDialString = EISC.GetString(JoinMap.GetJoinForKey(SIMPLAtcJoinMap.CurrentDialString)),
+				currentDialString = EISC.GetString(JoinMap.CurrentDialString.JoinNumber),
-                isInCall = EISC.GetString(JoinMap.GetJoinForKey(SIMPLAtcJoinMap.HookState)) == "Connected"
+                isInCall = EISC.GetString(JoinMap.HookState.JoinNumber) == "Connected"
 			});
 		}
 
@@ -138,26 +138,26 @@ namespace PepperDash.Essentials.AppServer.Messengers
 		{
             //EISC.SetStringSigAction(SCurrentDialString, s => PostStatusMessage(new { currentDialString = s }));
 
-            EISC.SetStringSigAction(JoinMap.GetJoinForKey(SIMPLAtcJoinMap.HookState), s => 
+            EISC.SetStringSigAction(JoinMap.HookState.JoinNumber, s => 
 			{
 				CurrentCallItem.Status = (eCodecCallStatus)Enum.Parse(typeof(eCodecCallStatus), s, true);
                 //GetCurrentCallList();
 				SendFullStatus();
 			});
 
-            EISC.SetStringSigAction(JoinMap.GetJoinForKey(SIMPLAtcJoinMap.CurrentCallNumber), s => 
+            EISC.SetStringSigAction(JoinMap.CurrentCallNumber.JoinNumber, s => 
 			{
 				CurrentCallItem.Number = s;
                 SendCallsList();
 			});
 
-            EISC.SetStringSigAction(JoinMap.GetJoinForKey(SIMPLAtcJoinMap.CurrentCallName), s =>
+            EISC.SetStringSigAction(JoinMap.CurrentCallName.JoinNumber, s =>
             {
                 CurrentCallItem.Name = s;
                 SendCallsList();
             });
 
-            EISC.SetStringSigAction(JoinMap.GetJoinForKey(SIMPLAtcJoinMap.CallDirection), s =>
+            EISC.SetStringSigAction(JoinMap.CallDirection.JoinNumber, s =>
             {
                 CurrentCallItem.Direction = (eCodecCallDirection)Enum.Parse(typeof(eCodecCallDirection), s, true);
                 SendCallsList();
@@ -170,13 +170,13 @@ namespace PepperDash.Essentials.AppServer.Messengers
 			// Add straight pulse calls
 			Action<string, uint> addAction = (s, u) =>
 				AppServerController.AddAction(MessagePath + s, new Action(() => EISC.PulseBool(u, 100)));
-            addAction("/endCallById", JoinMap.GetJoinForKey(SIMPLAtcJoinMap.EndCall));
+            addAction("/endCallById", JoinMap.EndCall.JoinNumber);
-            addAction("/endAllCalls", JoinMap.GetJoinForKey(SIMPLAtcJoinMap.EndCall));
+            addAction("/endAllCalls", JoinMap.EndCall.JoinNumber);
-            addAction("/acceptById", JoinMap.GetJoinForKey(SIMPLAtcJoinMap.IncomingAnswer));
+            addAction("/acceptById", JoinMap.IncomingAnswer.JoinNumber);
-            addAction("/rejectById", JoinMap.GetJoinForKey(SIMPLAtcJoinMap.IncomingReject));
+            addAction("/rejectById", JoinMap.IncomingReject.JoinNumber);
 
-            var speeddialStart = JoinMap.GetJoinForKey(SIMPLAtcJoinMap.SpeedDialStart);
+            var speeddialStart = JoinMap.SpeedDialStart.JoinNumber;
-            var speeddialEnd = JoinMap.GetJoinForKey(SIMPLAtcJoinMap.SpeedDialStart) + JoinMap.GetJoinSpanForKey(SIMPLAtcJoinMap.SpeedDialStart);
+            var speeddialEnd = JoinMap.SpeedDialStart.JoinNumber + JoinMap.SpeedDialStart.JoinSpan;
 
             var speedDialIndex = 1;
             for (uint i = speeddialStart; i < speeddialEnd; i++)
@@ -188,7 +188,7 @@ namespace PepperDash.Essentials.AppServer.Messengers
 			// Get status
 			AppServerController.AddAction(MessagePath + "/fullStatus", new Action(SendFullStatus));
 			// Dial on string
-            AppServerController.AddAction(MessagePath + "/dial", new Action<string>(s => EISC.SetString(JoinMap.GetJoinForKey(SIMPLAtcJoinMap.CurrentDialString), s)));
+            AppServerController.AddAction(MessagePath + "/dial", new Action<string>(s => EISC.SetString(JoinMap.CurrentDialString.JoinNumber, s)));
 			// Pulse DTMF
 			AppServerController.AddAction(MessagePath + "/dtmf", new Action<string>(s =>
 			{

PepperDashEssentials/AppServer/Messengers/SIMPLVtcMessenger.cs

@@ -397,8 +397,8 @@ namespace PepperDash.Essentials.AppServer.Messengers
             addAction("/acceptById", JoinMap.GetJoinForKey(SIMPLVtcJoinMap.IncomingAnswer));
             addAction("/rejectById", JoinMap.GetJoinForKey(SIMPLVtcJoinMap.IncomingReject));
 
-            var speeddialStart = JoinMap.GetJoinForKey(SIMPLAtcJoinMap.SpeedDialStart);
+            var speeddialStart = JoinMap.GetJoinForKey(SIMPLVtcJoinMap.SpeedDialStart);
-            var speeddialEnd = JoinMap.GetJoinForKey(SIMPLAtcJoinMap.SpeedDialStart) + JoinMap.GetJoinSpanForKey(SIMPLAtcJoinMap.SpeedDialStart);
+            var speeddialEnd = JoinMap.GetJoinForKey(SIMPLVtcJoinMap.SpeedDialStart) + JoinMap.GetJoinSpanForKey(SIMPLVtcJoinMap.SpeedDialStart);
 
             var speedDialIndex = 1;
             for (uint i = speeddialStart; i < speeddialEnd; i++)

PepperDashEssentials/AppServer/SIMPLJoinMaps/SIMPLAtcJoinMap.cs

@@ -3,61 +3,71 @@ using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using Crestron.SimplSharp;
+using Crestron.SimplSharp.Reflection;
 
 using PepperDash.Essentials.Core;
 
 
 namespace PepperDash.Essentials.AppServer
 {
-    public class SIMPLAtcJoinMap : JoinMapBase
+    public class SIMPLAtcJoinMap : JoinMapBaseAdvanced
     {
-        public const string EndCall = "EndCall";
+        [JoinName("EndCall")]
-        public const string IncomingAnswer = "IncomingAnswer";
+        public JoinDataComplete EndCall = new JoinDataComplete( new JoinData() {  JoinNumber = 21, JoinSpan = 1 }, new JoinMetadata() { Label = "Hang Up", JoinCapabilities = eJoinCapabilities.ToSIMPL,  JoinType = eJoinType.Digital });
-        public const string IncomingReject = "IncomingReject";
+        [JoinName("IncomingAnswer")]
-        public const string SpeedDialStart = "SpeedDialStart";
+        public JoinDataComplete IncomingAnswer = new JoinDataComplete(new JoinData() { JoinNumber = 51, JoinSpan = 1 }, new JoinMetadata() { Label = "Answer Incoming Call", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
-        public const string CurrentDialString = "CurrentDialString";
+        [JoinName("IncomingReject")]
-        public const string CurrentCallNumber = "CurrentCallNumber";
+        public JoinDataComplete IncomingReject = new JoinDataComplete(new JoinData() { JoinNumber = 52, JoinSpan = 1 }, new JoinMetadata() { Label = "Reject Incoming Call", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
-        public const string CurrentCallName = "CurrentCallName";
+        [JoinName("SpeedDialStart")]
-        public const string HookState = "HookState";
+        public JoinDataComplete SpeedDialStart = new JoinDataComplete(new JoinData() { JoinNumber = 41, JoinSpan = 4 }, new JoinMetadata() { Label = "Speed Dial", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
-        public const string CallDirection = "CallDirection";
+        [JoinName("CurrentDialString")]
-        public const string Dtmf0 = "0";
+        public JoinDataComplete CurrentDialString = new JoinDataComplete(new JoinData() { JoinNumber = 1, JoinSpan = 1 }, new JoinMetadata() { Label = "Current Dial String", JoinCapabilities = eJoinCapabilities.ToFromSIMPL, JoinType = eJoinType.Serial });
-        public const string Dtmf1 = "1";
+        [JoinName("CurrentCallNumber")]
-        public const string Dtmf2 = "2";
+        public JoinDataComplete CurrentCallNumber = new JoinDataComplete(new JoinData() { JoinNumber = 11, JoinSpan = 1 }, new JoinMetadata() { Label = "Current Call Number", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinType = eJoinType.Serial });
-        public const string Dtmf3 = "3";
+        [JoinName("CurrentCallName")]
-        public const string Dtmf4 = "4";
+        public JoinDataComplete CurrentCallName = new JoinDataComplete(new JoinData() { JoinNumber = 12, JoinSpan = 1 }, new JoinMetadata() { Label = "Current Call Name", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinType = eJoinType.Serial });
-        public const string Dtmf5 = "5";
+        [JoinName("CurrentHookStateCallName")]
-        public const string Dtmf6 = "6";
+        public JoinDataComplete HookState = new JoinDataComplete(new JoinData() { JoinNumber = 21, JoinSpan = 1 }, new JoinMetadata() { Label = "Current Hook State", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinType = eJoinType.Serial });
-        public const string Dtmf7 = "7";
+        [JoinName("CallDirection")]
-        public const string Dtmf8 = "8";
+        public JoinDataComplete CallDirection = new JoinDataComplete(new JoinData() { JoinNumber = 22, JoinSpan = 1 }, new JoinMetadata() { Label = "Current Call Direction", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinType = eJoinType.Serial });
-        public const string Dtmf9 = "9";
+        [JoinName("0")]
-        public const string DtmfStar = "*";
+        public JoinDataComplete Dtmf0 = new JoinDataComplete(new JoinData() { JoinNumber = 10, JoinSpan = 1 }, new JoinMetadata() { Label = "DTMF 0", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
-        public const string DtmfPound = "#";
+        [JoinName("1")]
-    
+        public JoinDataComplete Dtmf1 = new JoinDataComplete(new JoinData() { JoinNumber = 1, JoinSpan = 1 }, new JoinMetadata() { Label = "DTMF 1", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
+        [JoinName("2")]
+        public JoinDataComplete Dtmf2 = new JoinDataComplete(new JoinData() { JoinNumber = 2, JoinSpan = 1 }, new JoinMetadata() { Label = "DTMF 2", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
+        [JoinName("3")]
+        public JoinDataComplete Dtmf3 = new JoinDataComplete(new JoinData() { JoinNumber = 3, JoinSpan = 1 }, new JoinMetadata() { Label = "DTMF 3", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
+        [JoinName("4")]
+        public JoinDataComplete Dtmf4 = new JoinDataComplete(new JoinData() { JoinNumber = 4, JoinSpan = 1 }, new JoinMetadata() { Label = "DTMF 4", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
+        [JoinName("5")]
+        public JoinDataComplete Dtmf5 = new JoinDataComplete(new JoinData() { JoinNumber = 5, JoinSpan = 1 }, new JoinMetadata() { Label = "DTMF 5", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
+        [JoinName("6")]
+        public JoinDataComplete Dtmf6 = new JoinDataComplete(new JoinData() { JoinNumber = 6, JoinSpan = 1 }, new JoinMetadata() { Label = "DTMF 6", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
+        [JoinName("7")]
+        public JoinDataComplete Dtmf7 = new JoinDataComplete(new JoinData() { JoinNumber = 7, JoinSpan = 1 }, new JoinMetadata() { Label = "DTMF 7", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
+        [JoinName("8")]
+        public JoinDataComplete Dtmf8 = new JoinDataComplete(new JoinData() { JoinNumber = 8, JoinSpan = 1 }, new JoinMetadata() { Label = "DTMF 8", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
+        [JoinName("9")]
+        public JoinDataComplete Dtmf9 = new JoinDataComplete(new JoinData() { JoinNumber = 9, JoinSpan = 1 }, new JoinMetadata() { Label = "DTMF 9", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
+        [JoinName("*")]
+        public JoinDataComplete DtmfStar = new JoinDataComplete(new JoinData() { JoinNumber = 11, JoinSpan = 1 }, new JoinMetadata() { Label = "DTMF *", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
+        [JoinName("#")]
+        public JoinDataComplete DtmfPound = new JoinDataComplete(new JoinData() { JoinNumber = 12, JoinSpan = 1 }, new JoinMetadata() { Label = "DTMF #", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinType = eJoinType.Digital });
 
         public SIMPLAtcJoinMap()
         {
-            Joins.Add(EndCall, new JoinMetadata() { JoinNumber = 21, Label = "Hang Up", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
+            // Add all the JoinDataComplete properties to the Joins Dictionary
-            Joins.Add(IncomingAnswer, new JoinMetadata() { JoinNumber = 51, Label = "Answer Incoming Call", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
+            GetType()
-            Joins.Add(IncomingReject, new JoinMetadata() { JoinNumber = 52, Label = "Reject Incoming Call", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
+                .GetCType()
-            Joins.Add(SpeedDialStart, new JoinMetadata() { JoinNumber = 41, Label = "Speed Dial", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 4, JoinType = eJoinType.Digital });
+                .GetProperties()
-            Joins.Add(CurrentDialString, new JoinMetadata() { JoinNumber = 1, Label = "Current Dial String", JoinCapabilities = eJoinCapabilities.ToFromSIMPL, JoinSpan = 1, JoinType = eJoinType.Serial });
+                .Where(x => x.PropertyType == typeof(uint))
-            Joins.Add(CurrentCallNumber, new JoinMetadata() { JoinNumber = 11, Label = "Current Call Number", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinSpan = 1, JoinType = eJoinType.Serial });
+                .ToList()
-            Joins.Add(CurrentCallName, new JoinMetadata() { JoinNumber = 12, Label = "Current Call Name", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinSpan = 1, JoinType = eJoinType.Serial });
+                .ForEach(prop => 
-            Joins.Add(HookState, new JoinMetadata() { JoinNumber = 21, Label = "Current Hook State", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinSpan = 1, JoinType = eJoinType.Serial });
+                    {
-            Joins.Add(CallDirection, new JoinMetadata() { JoinNumber = 22, Label = "Current Call Direction", JoinCapabilities = eJoinCapabilities.FromSIMPL, JoinSpan = 1, JoinType = eJoinType.Serial });
+                        var join = (JoinDataComplete)prop.GetValue(this, null);
-            Joins.Add(Dtmf1, new JoinMetadata() { JoinNumber = 1, Label = "DTMF 1", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
+                        Joins.Add(join.GetNameAttribute(), join);
-            Joins.Add(Dtmf2, new JoinMetadata() { JoinNumber = 2, Label = "DTMF 2", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
+                    });
-            Joins.Add(Dtmf3, new JoinMetadata() { JoinNumber = 3, Label = "DTMF 3", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
-            Joins.Add(Dtmf4, new JoinMetadata() { JoinNumber = 4, Label = "DTMF 4", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
-            Joins.Add(Dtmf5, new JoinMetadata() { JoinNumber = 5, Label = "DTMF 5", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
-            Joins.Add(Dtmf6, new JoinMetadata() { JoinNumber = 6, Label = "DTMF 6", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
-            Joins.Add(Dtmf7, new JoinMetadata() { JoinNumber = 7, Label = "DTMF 7", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
-            Joins.Add(Dtmf8, new JoinMetadata() { JoinNumber = 8, Label = "DTMF 8", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
-            Joins.Add(Dtmf9, new JoinMetadata() { JoinNumber = 9, Label = "DTMF 9", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
-            Joins.Add(Dtmf0, new JoinMetadata() { JoinNumber = 10, Label = "DTMF 0", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
-            Joins.Add(DtmfStar, new JoinMetadata() { JoinNumber = 11, Label = "DTMF *", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
-            Joins.Add(DtmfPound, new JoinMetadata() { JoinNumber = 12, Label = "DTMF #", JoinCapabilities = eJoinCapabilities.ToSIMPL, JoinSpan = 1, JoinType = eJoinType.Digital });
-
         }
 
         public override void OffsetJoinNumbers(uint joinStart)

essentials-framework/Essentials Core/PepperDashEssentialsBase/JoinMaps/JoinMapBase.cs

@@ -3,6 +3,7 @@ using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using Crestron.SimplSharp;
+using Crestron.SimplSharp.Reflection;
 
 using PepperDash.Core;
 using PepperDash.Essentials.Core.Config;
@@ -37,6 +38,7 @@ namespace PepperDash.Essentials.Core
     /// <summary>
     /// Base class for join maps
     /// </summary>
+    [Obsolete("This is being deprecated in favor of JoinMapBaseAdvanced")]
     public abstract class JoinMapBase
     {
         /// <summary>
@@ -65,7 +67,7 @@ namespace PepperDash.Essentials.Core
             Debug.Console(0, "Analogs:");
             var analogs = Joins.Where(j => (j.Value.JoinType & eJoinType.Analog) == eJoinType.Analog).ToDictionary(j => j.Key, j => j.Value);
             PrintJoinList(GetSortedJoins(analogs));
-            
+
             Debug.Console(0, "Serials:");
             var serials = Joins.Where(j => (j.Value.JoinType & eJoinType.Serial) == eJoinType.Serial).ToDictionary(j => j.Key, j => j.Value);
             PrintJoinList(GetSortedJoins(serials));
@@ -128,6 +130,102 @@ namespace PepperDash.Essentials.Core
 
     }
 
+    /// <summary>
+    /// Base class for join maps
+    /// </summary>
+    public abstract class JoinMapBaseAdvanced
+    {
+        /// <summary>
+        /// Modifies all the join numbers by adding the offset.  This should never be called twice
+        /// </summary>
+        /// <param name="joinStart"></param>
+        public abstract void OffsetJoinNumbers(uint joinStart);
+
+        /// <summary>
+        /// The collection of joins and associated metadata
+        /// </summary>
+        public Dictionary<string, JoinDataComplete> Joins = new Dictionary<string, JoinDataComplete>();
+
+        /// <summary>
+        /// Prints the join information to console
+        /// </summary>
+        public void PrintJoinMapInfo()
+        {
+            Debug.Console(0, "{0}:\n", this.GetType().Name);
+
+            // Get the joins of each type and print them
+            Debug.Console(0, "Digitals:");
+            var digitals = Joins.Where(j => (j.Value.Metadata.JoinType & eJoinType.Digital) == eJoinType.Digital).ToDictionary(j => j.Key, j => j.Value);
+            PrintJoinList(GetSortedJoins(digitals));
+
+            Debug.Console(0, "Analogs:");
+            var analogs = Joins.Where(j => (j.Value.Metadata.JoinType & eJoinType.Analog) == eJoinType.Analog).ToDictionary(j => j.Key, j => j.Value);
+            PrintJoinList(GetSortedJoins(analogs));
+            
+            Debug.Console(0, "Serials:");
+            var serials = Joins.Where(j => (j.Value.Metadata.JoinType & eJoinType.Serial) == eJoinType.Serial).ToDictionary(j => j.Key, j => j.Value);
+            PrintJoinList(GetSortedJoins(serials));
+
+        }
+
+        /// <summary>
+        /// Returns  a sorted list by JoinNumber
+        /// </summary>
+        /// <param name="joins"></param>
+        /// <returns></returns>
+        List<KeyValuePair<string, JoinDataComplete>> GetSortedJoins(Dictionary<string, JoinDataComplete> joins)
+        {
+            var sortedJoins = joins.ToList();
+
+            sortedJoins.Sort((pair1, pair2) => pair1.Value.JoinNumber.CompareTo(pair2.Value.JoinNumber));
+
+            return sortedJoins;
+        }
+
+        void PrintJoinList(List<KeyValuePair<string, JoinDataComplete>> joins)
+        {
+            foreach (var join in joins)
+            {
+                Debug.Console(0,
+                    @"Join Number: {0} | JoinSpan: '{1}' | Label: '{2}' | Type: '{3}' | Capabilities: '{4}'",
+                        join.Value.JoinNumber,
+                        join.Value.JoinSpan,
+                        join.Value.Metadata.Label,
+                        join.Value.Metadata.JoinType.ToString(),
+                        join.Value.Metadata.JoinCapabilities.ToString());
+            }
+        }
+
+        /// <summary>
+        /// Returns the join number for the join with the specified key
+        /// </summary>
+        /// <param name="key"></param>
+        /// <returns></returns>
+        public uint GetJoinForKey(string key)
+        {
+            if (Joins.ContainsKey(key))
+                return Joins[key].JoinNumber;
+            else
+                return 0;
+        }
+
+
+
+        /// <summary>
+        /// Returns the join span for the join with the specified key
+        /// </summary>
+        /// <param name="key"></param>
+        /// <returns></returns>
+        public uint GetJoinSpanForKey(string key)
+        {
+            if (Joins.ContainsKey(key))
+                return Joins[key].JoinSpan;
+
+            else return 0;
+        }
+
+    }
+
     /// <summary>
     /// Read = Provides feedback to SIMPL
     /// Write = Responds to sig values from SIMPL
@@ -155,10 +253,23 @@ namespace PepperDash.Essentials.Core
     }
 
     /// <summary>
-    /// Data describing the join
+    /// Metadata describing the join
     /// </summary>
     public class JoinMetadata
     {
+        /// <summary>
+        /// Join number (based on join offset value)
+        /// </summary>
+        [JsonProperty("joinNumber")]
+        [Obsolete]
+        public uint JoinNumber { get; set; }
+        /// <summary>
+        /// Join range span.  If join indicates the start of a range of joins, this indicated the maximum number of joins in the range
+        /// </summary>
+        [Obsolete]
+        [JsonProperty("joinSpan")]
+        public uint JoinSpan { get; set; }
+
         /// <summary>
         /// A label for the join to better describe it's usage
         /// </summary>
@@ -170,16 +281,6 @@ namespace PepperDash.Essentials.Core
         [JsonProperty("joinType")]
         public eJoinType JoinType { get; set; }
         /// <summary>
-        /// Join number (based on join offset value)
-        /// </summary>
-        [JsonProperty("joinNumber")]
-        public uint JoinNumber { get; set; }
-        /// <summary>
-        /// Join range span.  If join indicates the start of a range of joins, this indicated the maximum number of joins in the range
-        /// </summary>
-        [JsonProperty("joinSpan")]
-        public uint JoinSpan { get; set; }
-        /// <summary>
         /// Indicates whether the join is read and/or write
         /// </summary>
         [JsonProperty("joinCapabilities")]
@@ -191,4 +292,74 @@ namespace PepperDash.Essentials.Core
         public string[] ValidValues { get; set; }
 
     }
+
+    /// <summary>
+    /// Data describing the join.  Can be 
+    /// </summary>
+    public class JoinData
+    {
+        /// <summary>
+        /// Join number (based on join offset value)
+        /// </summary>
+        [JsonProperty("joinNumber")]
+        public uint JoinNumber { get; set; }
+        /// <summary>
+        /// Join range span.  If join indicates the start of a range of joins, this indicated the maximum number of joins in the range
+        /// </summary>
+        [JsonProperty("joinSpan")]
+        public uint JoinSpan { get; set; }
+    }
+
+    /// <summary>
+    /// A class to aggregate the JoinData and JoinMetadata for a join
+    /// </summary>
+    public class JoinDataComplete
+    {
+        JoinData _Data { get; set; }
+        public JoinMetadata Metadata { get; set; }
+
+        public JoinDataComplete(JoinData data, JoinMetadata metadata)
+        {
+            _Data = data;
+            Metadata = metadata;
+        }
+
+        public uint JoinNumber
+        {
+            get { return _Data.JoinNumber; }
+            set { _Data.JoinNumber = value; }
+        }
+
+        public uint JoinSpan
+        {
+            get { return _Data.JoinSpan; }
+        }
+
+        public string GetNameAttribute()
+        {
+            string name = string.Empty;
+            JoinNameAttribute attribute = (JoinNameAttribute)Attribute.GetCustomAttribute(typeof(JoinDataComplete), typeof(JoinNameAttribute));
+            if (attribute != null)
+            {
+                name = attribute.Name;
+            }
+            return name;
+        }
+    }
+
+    [AttributeUsage(AttributeTargets.Field)]
+    public class JoinNameAttribute : Attribute
+    {
+        private string _name;
+        public string Name
+        {
+            get { return this.Name; }
+            set { this._name = value; }
+        }
+
+        public JoinNameAttribute(string name)
+        {
+            this._name = name;
+        }
+    }
 }