refactor: rearrange and add solution for 4-series

src/PepperDash.Essentials.Core/Room/Combining/IEssentialsRoomCombiner.cs

@@ -0,0 +1,97 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using Crestron.SimplSharp;
+
+using PepperDash.Core;
+
+namespace PepperDash.Essentials.Core
+{
+    /// <summary>
+    /// Describes the functionality for an EssentailsRoomCombiner device
+    /// </summary>
+    public interface IEssentialsRoomCombiner : IKeyed
+    {
+        /// <summary>
+        /// Indicates that the room combination scenario has changed
+        /// </summary>
+        event EventHandler<EventArgs> RoomCombinationScenarioChanged;
+
+        /// <summary>
+        /// The current room combination scenario
+        /// </summary>
+        IRoomCombinationScenario CurrentScenario { get; }
+
+        /// <summary>
+        /// When true, indicates the current mode is auto mode
+        /// </summary>
+        BoolFeedback IsInAutoModeFeedback {get;}
+
+        /// <summary>
+        /// Sets auto mode
+        /// </summary>
+        void SetAutoMode();
+
+        /// <summary>
+        /// Sets manual mode
+        /// </summary>
+        void SetManualMode();
+
+        /// <summary>
+        /// Toggles the current mode between auto and manual
+        /// </summary>
+        void ToggleMode();
+
+        /// <summary>
+        /// The available room combinatino scenarios
+        /// </summary>
+        List<IRoomCombinationScenario> RoomCombinationScenarios { get; }
+
+        /// <summary>
+        /// The partition
+        /// </summary>
+        List<IPartitionController> Partitions { get; }
+
+        /// <summary>
+        /// Toggles the state of a manual partition sensor
+        /// </summary>
+        /// <param name="partitionKey"></param>
+        void TogglePartitionState(string partitionKey);
+
+        /// <summary>
+        /// Sets the room combination scenario (if in manual mode)
+        /// </summary>
+        /// <param name="scenarioKey"></param>
+        void SetRoomCombinationScenario(string scenarioKey);
+    }
+
+    public interface IRoomCombinationScenario : IKeyName
+    {
+        /// <summary>
+        /// When true, indicates that this room combination scenario is active
+        /// </summary>
+        BoolFeedback IsActiveFeedback { get; }
+
+        /// <summary>
+        /// Activates this room combination scenario
+        /// </summary>
+        void Activate();
+
+        /// <summary>
+        /// Deactivates this room combination scenario
+        /// </summary>
+        void Deactivate();
+
+        /// <summary>
+        /// The state of the partitions that would activate this scenario
+        /// </summary>
+        List<PartitionState> PartitionStates { get; }
+
+        /// <summary>
+        /// The mapping of UIs by key to rooms by key
+        /// </summary>
+        Dictionary<string, string> UiMap { get; set; }
+    }
+
+}