diff --git a/src/PepperDash.Essentials.Core/Timers/CountdownTimer.cs b/src/PepperDash.Essentials.Core/Timers/CountdownTimer.cs index c00eb014..24ff6a1a 100644 --- a/src/PepperDash.Essentials.Core/Timers/CountdownTimer.cs +++ b/src/PepperDash.Essentials.Core/Timers/CountdownTimer.cs @@ -14,8 +14,19 @@ namespace PepperDash.Essentials.Core /// public class SecondsCountdownTimer: IKeyed { + /// + /// Event fired when the timer starts + /// public event EventHandler HasStarted; + + /// + /// Event fired when the timer finishes + /// public event EventHandler HasFinished; + + /// + /// Event fired when the timer is cancelled + /// public event EventHandler WasCancelled; /// @@ -33,6 +44,7 @@ namespace PepperDash.Essentials.Core /// Gets or sets the PercentFeedback /// public IntFeedback PercentFeedback { get; private set; } + /// /// Gets or sets the TimeRemainingFeedback /// diff --git a/src/PepperDash.Essentials.Core/Timers/RetriggerableTimer.cs b/src/PepperDash.Essentials.Core/Timers/RetriggerableTimer.cs index ee734489..f06ba3cd 100644 --- a/src/PepperDash.Essentials.Core/Timers/RetriggerableTimer.cs +++ b/src/PepperDash.Essentials.Core/Timers/RetriggerableTimer.cs @@ -27,6 +27,11 @@ namespace PepperDash.Essentials.Core.Timers private CTimer _timer; private long _timerIntervalMs; + /// + /// Constructor + /// + /// key of the timer + /// configuration for the timer public RetriggerableTimer(string key, DeviceConfig config) : base(key, config.Name) { @@ -98,7 +103,7 @@ namespace PepperDash.Essentials.Core.Timers /// /// Executes the Elapsed action from confing when the timer elapses /// - /// + /// action to be executed private void TimerElapsedCallback(object action) { Debug.LogMessage(LogEventLevel.Debug, this, "Timer Elapsed. Executing Action"); @@ -144,15 +149,27 @@ namespace PepperDash.Essentials.Core.Timers /// public class RetriggerableTimerPropertiesConfig { + /// + /// Start the timer on device activation + /// [JsonProperty("startTimerOnActivation")] public bool StartTimerOnActivation { get; set; } + /// + /// Timer interval in milliseconds + /// [JsonProperty("timerIntervalMs")] public long TimerIntervalMs { get; set; } + /// + /// Events and their associated actions + /// [JsonProperty("events")] public Dictionary Events { get; set; } + /// + /// Constructor + /// public RetriggerableTimerPropertiesConfig() { Events = new Dictionary(); @@ -164,7 +181,14 @@ namespace PepperDash.Essentials.Core.Timers /// public enum eRetriggerableTimerEvents { + /// + /// Elapsed event + /// Elapsed, + + /// + /// Stopped event + /// Stopped, } @@ -173,11 +197,19 @@ namespace PepperDash.Essentials.Core.Timers /// public class RetriggerableTimerFactory : EssentialsDeviceFactory { + /// + /// Constructor + /// public RetriggerableTimerFactory() { TypeNames = new List() { "retriggerabletimer" }; } + /// + /// BuildDevice method + /// + /// device config + /// public override EssentialsDevice BuildDevice(DeviceConfig dc) { Debug.LogMessage(LogEventLevel.Debug, "Factory Attempting to create new RetriggerableTimer Device"); diff --git a/src/PepperDash.Essentials.Core/Touchpanels/CrestronTouchpanelPropertiesConfig.cs b/src/PepperDash.Essentials.Core/Touchpanels/CrestronTouchpanelPropertiesConfig.cs index 1358b1b9..2cc9ab9a 100644 --- a/src/PepperDash.Essentials.Core/Touchpanels/CrestronTouchpanelPropertiesConfig.cs +++ b/src/PepperDash.Essentials.Core/Touchpanels/CrestronTouchpanelPropertiesConfig.cs @@ -7,72 +7,93 @@ namespace PepperDash.Essentials.Core /// public class CrestronTouchpanelPropertiesConfig { - [JsonProperty("control")] /// /// Gets or sets the ControlProperties /// + [JsonProperty("control")] public EssentialsControlPropertiesConfig ControlProperties { get; set; } - [JsonProperty("ipId", NullValueHandling = NullValueHandling.Ignore)] /// /// Gets or sets the IpId /// + [JsonProperty("ipId", NullValueHandling = NullValueHandling.Ignore)] public string IpId { get; set; } - [JsonProperty("defaultRoomKey", NullValueHandling = NullValueHandling.Ignore)] /// /// Gets or sets the DefaultRoomKey /// + [JsonProperty("defaultRoomKey", NullValueHandling = NullValueHandling.Ignore)] public string DefaultRoomKey { get; set; } - [JsonProperty("roomListKey", NullValueHandling = NullValueHandling.Ignore)] /// /// Gets or sets the RoomListKey /// + [JsonProperty("roomListKey", NullValueHandling = NullValueHandling.Ignore)] public string RoomListKey { get; set; } - [JsonProperty("sgdFile", NullValueHandling = NullValueHandling.Ignore)] /// /// Gets or sets the SgdFile /// + [JsonProperty("sgdFile", NullValueHandling = NullValueHandling.Ignore)] public string SgdFile { get; set; } - [JsonProperty("projectName", NullValueHandling = NullValueHandling.Ignore)] /// /// Gets or sets the ProjectName /// + [JsonProperty("projectName", NullValueHandling = NullValueHandling.Ignore)] public string ProjectName { get; set; } + /// + /// Gets or sets the ShowVolumeGauge + /// [JsonProperty("showVolumeGauge", NullValueHandling = NullValueHandling.Ignore)] public bool? ShowVolumeGauge { get; set; } + /// + /// Gets or sets the UsesSplashPage + /// [JsonProperty("usesSplashPage", NullValueHandling = NullValueHandling.Ignore)] public bool? UsesSplashPage { get; set; } + /// + /// Gets or sets the ShowDate + /// [JsonProperty("showDate", NullValueHandling = NullValueHandling.Ignore)] public bool? ShowDate { get; set; } + /// + /// Gets or sets the ShowTime + /// [JsonProperty("showTime", NullValueHandling = NullValueHandling.Ignore)] public bool? ShowTime { get; set; } - [JsonProperty("setup", NullValueHandling = NullValueHandling.Ignore)] /// /// Gets or sets the Setup /// + [JsonProperty("setup", NullValueHandling = NullValueHandling.Ignore)] public UiSetupPropertiesConfig Setup { get; set; } - [JsonProperty("headerStyle", NullValueHandling = NullValueHandling.Ignore)] /// /// Gets or sets the HeaderStyle /// + [JsonProperty("headerStyle", NullValueHandling = NullValueHandling.Ignore)] public string HeaderStyle { get; set; } + /// + /// Gets or sets the IncludeInFusionRoomHealth + /// [JsonProperty("includeInFusionRoomHealth", NullValueHandling = NullValueHandling.Ignore)] public bool? IncludeInFusionRoomHealth { get; set; } + /// + /// Gets or sets the ScreenSaverTimeoutMin + /// [JsonProperty("screenSaverTimeoutMin", NullValueHandling = NullValueHandling.Ignore)] public uint? ScreenSaverTimeoutMin { get; set; } + /// + /// Gets or sets the ScreenSaverMovePositionIntervalMs + /// [JsonProperty("screenSaverMovePositionIntervalMs", NullValueHandling = NullValueHandling.Ignore)] public uint? ScreenSaverMovePositionIntervalMs { get; set; } @@ -84,8 +105,15 @@ namespace PepperDash.Essentials.Core [JsonProperty("sourcesOverflowCount", NullValueHandling = NullValueHandling.Ignore)] public int? SourcesOverflowCount { get; set; } + /// + /// Constructor + /// public CrestronTouchpanelPropertiesConfig() : this(false) { } + /// + /// Constructor + /// + /// set values to default if true public CrestronTouchpanelPropertiesConfig(bool setDefaultValues = false) { if(!setDefaultValues) { return; } @@ -112,6 +140,9 @@ namespace PepperDash.Essentials.Core /// public class UiSetupPropertiesConfig { + /// + /// Gets or sets the IsVisible + /// [JsonProperty("isVisible", NullValueHandling = NullValueHandling.Ignore)] public bool IsVisible { get; set; } } diff --git a/src/PepperDash.Essentials.Core/Touchpanels/Interfaces.cs b/src/PepperDash.Essentials.Core/Touchpanels/Interfaces.cs index 6f59aba1..0e74ed93 100644 --- a/src/PepperDash.Essentials.Core/Touchpanels/Interfaces.cs +++ b/src/PepperDash.Essentials.Core/Touchpanels/Interfaces.cs @@ -12,6 +12,9 @@ namespace PepperDash.Essentials.Core /// public interface IHasBasicTriListWithSmartObject { + /// + /// Gets the Panel + /// BasicTriListWithSmartObject Panel { get; } } } \ No newline at end of file diff --git a/src/PepperDash.Essentials.Core/Touchpanels/Keyboards/HabaneroKeyboardController.cs b/src/PepperDash.Essentials.Core/Touchpanels/Keyboards/HabaneroKeyboardController.cs index b45ea649..89346ae7 100644 --- a/src/PepperDash.Essentials.Core/Touchpanels/Keyboards/HabaneroKeyboardController.cs +++ b/src/PepperDash.Essentials.Core/Touchpanels/Keyboards/HabaneroKeyboardController.cs @@ -27,8 +27,14 @@ namespace PepperDash.Essentials.Core.Touchpanels.Keyboards /// public StringFeedback OutputFeedback { get; private set; } + /// + /// Gets or sets the IsVisible + /// public bool IsVisible { get; private set; } + /// + /// Gets or sets the DotComButtonString + /// public string DotComButtonString { get; set; } /// @@ -441,21 +447,33 @@ namespace PepperDash.Essentials.Core.Touchpanels.Keyboards } /// - /// + /// Event args for keyboard key presses /// public class KeyboardControllerPressEventArgs : EventArgs { + /// + /// Gets or sets the Text + /// public string Text { get; private set; } + /// /// Gets or sets the SpecialKey /// public KeyboardSpecialKey SpecialKey { get; private set; } + /// + /// Constructor + /// + /// public KeyboardControllerPressEventArgs(string text) { Text = text; } + /// + /// Constructor + /// + /// special keyboard key public KeyboardControllerPressEventArgs(KeyboardSpecialKey key) { SpecialKey = key; @@ -467,6 +485,29 @@ namespace PepperDash.Essentials.Core.Touchpanels.Keyboards /// public enum KeyboardSpecialKey { - None = 0, Backspace, Clear, GoButton, SecondaryButton + /// + /// None + /// + None = 0, + + /// + /// Backspace + /// + Backspace, + + /// + /// Clear + /// + Clear, + + /// + /// GoButton + /// + GoButton, + + /// + /// SecondaryButton + /// + SecondaryButton } } \ No newline at end of file diff --git a/src/PepperDash.Essentials.Core/Touchpanels/ModalDialog.cs b/src/PepperDash.Essentials.Core/Touchpanels/ModalDialog.cs index e094aebb..e3545cd0 100644 --- a/src/PepperDash.Essentials.Core/Touchpanels/ModalDialog.cs +++ b/src/PepperDash.Essentials.Core/Touchpanels/ModalDialog.cs @@ -113,8 +113,13 @@ namespace PepperDash.Essentials.Core /// Shows the dialog /// /// Number of buttons to show. 0, 1, 2 - /// The amount of time to show the dialog. Use 0 for no timeout. - /// If the progress bar gauge needs to count down instead of up + /// Title text + /// Icon name + /// Message text + /// Button 1 text + /// Button 2 text + /// True to show the gauge + /// True to show the cancel "X" button /// The action to run when the dialog is dismissed. Parameter will be 1 or 2 if button pressed, or 0 if dialog times out /// True when modal is created. public bool PresentModalDialog(uint numberOfButtons, string title, string iconName, diff --git a/src/PepperDash.Essentials.Core/Touchpanels/Mpc3Touchpanel.cs b/src/PepperDash.Essentials.Core/Touchpanels/Mpc3Touchpanel.cs index fa20ca84..92764f22 100644 --- a/src/PepperDash.Essentials.Core/Touchpanels/Mpc3Touchpanel.cs +++ b/src/PepperDash.Essentials.Core/Touchpanels/Mpc3Touchpanel.cs @@ -19,6 +19,13 @@ namespace PepperDash.Essentials.Core.Touchpanels readonly Dictionary _buttons; + /// + /// Constructor + /// + /// device key + /// device name + /// control system processor + /// dictionary of keypad buttons public Mpc3TouchpanelController(string key, string name, CrestronControlSystem processor, Dictionary buttons) : base(key, name) { @@ -348,12 +355,21 @@ namespace PepperDash.Essentials.Core.Touchpanels /// public class KeypadButton { + /// + /// Gets or sets the EventTypes + /// [JsonProperty("eventTypes")] public Dictionary EventTypes { get; set; } + /// + /// Gets or sets the Feedback + /// [JsonProperty("feedback")] public KeypadButtonFeedback Feedback { get; set; } + /// + /// Constructor + /// public KeypadButton() { EventTypes = new Dictionary(); @@ -361,17 +377,20 @@ namespace PepperDash.Essentials.Core.Touchpanels } } - /// - /// Represents a KeypadButtonFeedback - /// + /// + /// Represents a KeypadButtonFeedback + /// public class KeypadButtonFeedback { + /// + /// Gets or sets the DeviceKey + /// [JsonProperty("deviceKey")] - /// - /// Gets or sets the DeviceKey - /// public string DeviceKey { get; set; } + /// + /// Gets or sets the FeedbackName + /// [JsonProperty("feedbackName")] public string FeedbackName { get; set; } } diff --git a/src/PepperDash.Essentials.Core/Touchpanels/TriListExtensions.cs b/src/PepperDash.Essentials.Core/Touchpanels/TriListExtensions.cs index 232dff33..2d026dbb 100644 --- a/src/PepperDash.Essentials.Core/Touchpanels/TriListExtensions.cs +++ b/src/PepperDash.Essentials.Core/Touchpanels/TriListExtensions.cs @@ -44,6 +44,13 @@ namespace PepperDash.Essentials.Core return tl.BooleanOutput[sigNum].SetBoolSigAction(a); } + /// + /// Attaches a void Action to a TriList's output sig's UserObject, to be run on press + /// + /// trilist + /// number of the signal + /// action to run when the signal is true (pressed) + /// public static BoolOutputSig SetSigTrueAction(this BasicTriList tl, uint sigNum, Action a) { return tl.BooleanOutput[sigNum].SetBoolSigAction(b => { if(b) a(); }); @@ -53,9 +60,6 @@ namespace PepperDash.Essentials.Core /// Attaches a void Action to a TriList's output sig's UserObject, to be run on release /// /// The sig - /// - /// SetSigFalseAction method - /// public static BoolOutputSig SetSigFalseAction(this BasicTriList tl, uint sigNum, Action a) { return tl.BooleanOutput[sigNum].SetBoolSigAction(b => { if (!b) a(); }); @@ -143,43 +147,35 @@ namespace PepperDash.Essentials.Core } /// - /// - /// + /// SetUShortSigAction method + /// /// /// /// The Sig - /// - /// SetUShortSigAction method - /// - public static UShortOutputSig SetUShortSigAction(this UShortOutputSig sig, Action a) + public static UShortOutputSig SetUShortSigAction(this UShortOutputSig sig, Action a) { sig.UserObject = a; return sig; } + /// - /// + /// SetUShortSigAction method /// /// /// /// /// - /// - /// SetUShortSigAction method - /// public static UShortOutputSig SetUShortSigAction(this BasicTriList tl, uint sigNum, Action a) { return tl.UShortOutput[sigNum].SetUShortSigAction(a); } /// - /// + /// SetStringSigAction method /// /// /// /// - /// - /// SetStringSigAction method - /// public static StringOutputSig SetStringSigAction(this StringOutputSig sig, Action a) { sig.UserObject = a; @@ -187,50 +183,50 @@ namespace PepperDash.Essentials.Core } /// - /// + /// SetStringSigAction method /// /// /// /// /// - /// - /// SetStringSigAction method - /// public static StringOutputSig SetStringSigAction(this BasicTriList tl, uint sigNum, Action a) { return tl.StringOutput[sigNum].SetStringSigAction(a); } /// - /// + /// ClearSigAction method /// /// /// - /// - /// ClearSigAction method - /// public static Sig ClearSigAction(this Sig sig) { sig.UserObject = null; return sig; } + /// + /// ClearBoolSigAction method + /// + /// trilist + /// signal number to clear + /// public static BoolOutputSig ClearBoolSigAction(this BasicTriList tl, uint sigNum) { return ClearSigAction(tl.BooleanOutput[sigNum]) as BoolOutputSig; } - /// - /// ClearUShortSigAction method - /// + /// + /// ClearUShortSigAction method + /// public static UShortOutputSig ClearUShortSigAction(this BasicTriList tl, uint sigNum) { return ClearSigAction(tl.UShortOutput[sigNum]) as UShortOutputSig; } - /// - /// ClearStringSigAction method - /// + /// + /// ClearStringSigAction method + /// public static StringOutputSig ClearStringSigAction(this BasicTriList tl, uint sigNum) { return ClearSigAction(tl.StringOutput[sigNum]) as StringOutputSig; @@ -270,9 +266,6 @@ namespace PepperDash.Essentials.Core /// /// /// - /// - /// PulseBool method - /// public static void PulseBool(this BasicTriList tl, uint sigNum) { tl.BooleanInput[sigNum].Pulse(); @@ -284,9 +277,6 @@ namespace PepperDash.Essentials.Core /// /// /// - /// - /// PulseBool method - /// public static void PulseBool(this BasicTriList tl, uint sigNum, int ms) { tl.BooleanInput[sigNum].Pulse(ms); @@ -308,6 +298,13 @@ namespace PepperDash.Essentials.Core tl.StringInput[sigNum].StringValue = value; } + /// + /// Helper method to set the value of a string Sig on TriList with encoding + /// + /// trilist + /// signal number to set + /// string value to set + /// string encoding to use public static void SetString(this BasicTriList tl, uint sigNum, string value, eStringEncoding encoding) { tl.StringInput[sigNum].StringEncoding = encoding; @@ -320,9 +317,6 @@ namespace PepperDash.Essentials.Core /// /// /// - /// - /// GetBool method - /// public static bool GetBool(this BasicTriList tl, uint sigNum) { return tl.BooleanOutput[sigNum].BoolValue; @@ -334,9 +328,6 @@ namespace PepperDash.Essentials.Core /// /// /// - /// - /// GetUshort method - /// public static ushort GetUshort(this BasicTriList tl, uint sigNum) { return tl.UShortOutput[sigNum].UShortValue; @@ -348,9 +339,6 @@ namespace PepperDash.Essentials.Core /// /// /// - /// - /// GetString method - /// public static string GetString(this BasicTriList tl, uint sigNum) { return tl.StringOutput[sigNum].StringValue; diff --git a/src/PepperDash.Essentials.Core/TriListBridges/HandlerBridge.cs b/src/PepperDash.Essentials.Core/TriListBridges/HandlerBridge.cs index 7e887f5b..13676e2d 100644 --- a/src/PepperDash.Essentials.Core/TriListBridges/HandlerBridge.cs +++ b/src/PepperDash.Essentials.Core/TriListBridges/HandlerBridge.cs @@ -9,6 +9,9 @@ using Crestron.SimplSharpPro.DeviceSupport; namespace PepperDash.Essentials.Core { + /// + /// Abstract base class for TriList handler bridges + /// public abstract class HandlerBridge { /// diff --git a/src/PepperDash.Essentials.Core/UI PageManagers/BlurayPageManager.cs b/src/PepperDash.Essentials.Core/UI PageManagers/BlurayPageManager.cs index a18d8b6e..d14058bd 100644 --- a/src/PepperDash.Essentials.Core/UI PageManagers/BlurayPageManager.cs +++ b/src/PepperDash.Essentials.Core/UI PageManagers/BlurayPageManager.cs @@ -10,6 +10,11 @@ namespace PepperDash.Essentials.Core.PageManagers { IDiscPlayerControls Player; + /// + /// Constructor + /// + /// player controls object + /// trilist object public DiscPlayerMediumPageManager(IDiscPlayerControls player, BasicTriListWithSmartObject trilist) : base(player.DisplayUiType) { @@ -17,10 +22,10 @@ namespace PepperDash.Essentials.Core.PageManagers TriList = trilist; } - /// - /// Show method - /// - /// + /// + /// Show method + /// + /// public override void Show() { uint offset = GetOffsetJoin(); @@ -40,10 +45,10 @@ namespace PepperDash.Essentials.Core.PageManagers } } - /// - /// Hide method - /// - /// + /// + /// Hide method + /// + /// public override void Hide() { TriList.BooleanInput[BackingPageJoin].BoolValue = false; diff --git a/src/PepperDash.Essentials.Core/UI PageManagers/PageManager.cs b/src/PepperDash.Essentials.Core/UI PageManagers/PageManager.cs index a6f8761f..ed5f0fff 100644 --- a/src/PepperDash.Essentials.Core/UI PageManagers/PageManager.cs +++ b/src/PepperDash.Essentials.Core/UI PageManagers/PageManager.cs @@ -10,10 +10,19 @@ namespace PepperDash.Essentials.Core.PageManagers /// public abstract class PageManager { + /// + /// ActiveJoins list + /// protected List ActiveJoins = new List(); + /// + /// Show method + /// public abstract void Show(); + /// + /// Hide method + /// public abstract void Hide(); /// @@ -21,9 +30,6 @@ namespace PepperDash.Essentials.Core.PageManagers /// /// 1 through 49, as defined in some constants somewhere! /// - /// - /// GetOffsetJoin method - /// public uint GetOffsetJoin(uint deviceType) { return 10000 + (deviceType * 100); @@ -38,30 +44,40 @@ namespace PepperDash.Essentials.Core.PageManagers BasicTriList TriList; uint BackingPageJoin; + /// + /// Constructor + /// + /// device + /// trilist object public DefaultPageManager(IUiDisplayInfo device, BasicTriList trilist) { TriList = trilist; BackingPageJoin = GetOffsetJoin(device.DisplayUiType) + 1; } + /// + /// Constructor + /// + /// back page join + /// trilist object public DefaultPageManager(uint join, BasicTriList trilist) { TriList = trilist; BackingPageJoin = join; } - /// - /// Show method - /// - /// + /// + /// Show method + /// + /// public override void Show() { TriList.BooleanInput[BackingPageJoin].BoolValue = true; } - /// - /// Hide method - /// + /// + /// Hide method + /// public override void Hide() { TriList.BooleanInput[BackingPageJoin].BoolValue = false; @@ -73,17 +89,44 @@ namespace PepperDash.Essentials.Core.PageManagers /// public abstract class MediumLeftSwitchablePageManager : PageManager { + /// + /// TriList object + /// protected BasicTriListWithSmartObject TriList; + + /// + /// Left subpage join + /// protected uint LeftSubpageJoin; + + /// + /// Backing page join + /// protected uint BackingPageJoin; + + /// + /// All left subpages + /// protected uint[] AllLeftSubpages; + + /// + /// Display UI Type + /// protected uint DisplayUiType; + /// + /// Constructor + /// + /// UI type protected MediumLeftSwitchablePageManager(uint displayUiType) { DisplayUiType = displayUiType; } + /// + /// Interlock left subpage + /// + /// protected void InterlockLeftSubpage(uint join) { join = join + GetOffsetJoin(); @@ -92,12 +135,19 @@ namespace PepperDash.Essentials.Core.PageManagers LeftSubpageJoin = join; } + /// + /// Clear left interlock + /// protected void ClearLeftInterlock() { foreach (var p in AllLeftSubpages) TriList.BooleanInput[GetOffsetJoin() + p].BoolValue = false; } + /// + /// Get offset join + /// + /// protected uint GetOffsetJoin() { return GetOffsetJoin(DisplayUiType); diff --git a/src/PepperDash.Essentials.Core/UI PageManagers/SetTopBoxThreePanelPageManager.cs b/src/PepperDash.Essentials.Core/UI PageManagers/SetTopBoxThreePanelPageManager.cs index 7c78464e..338f47dc 100644 --- a/src/PepperDash.Essentials.Core/UI PageManagers/SetTopBoxThreePanelPageManager.cs +++ b/src/PepperDash.Essentials.Core/UI PageManagers/SetTopBoxThreePanelPageManager.cs @@ -9,16 +9,19 @@ using Serilog.Events; namespace PepperDash.Essentials.Core.PageManagers { - /// - /// Represents a ThreePanelPlusOnePageManager - /// + /// + /// Represents a ThreePanelPlusOnePageManager + /// public class ThreePanelPlusOnePageManager : PageManager { + /// + /// The trilist + /// protected BasicTriListWithSmartObject TriList; - /// - /// Gets or sets the Position5TabsId - /// + /// + /// Gets or sets the Position5TabsId + /// public uint Position5TabsId { get; set; } /// @@ -32,12 +35,12 @@ namespace PepperDash.Essentials.Core.PageManagers protected uint[] FixedVisibilityJoins; /// - /// + /// Gets or sets the current visible item in position 5 /// protected uint CurrentVisiblePosition5Item; /// - /// + /// Constructor /// /// public ThreePanelPlusOnePageManager(BasicTriListWithSmartObject trilist) @@ -85,10 +88,10 @@ namespace PepperDash.Essentials.Core.PageManagers (uo as Action)(args.Sig.BoolValue); } - /// - /// Hide method - /// - /// + /// + /// Hide method + /// + /// public override void Hide() { var fixedSigs = FixedVisibilityJoins.Select(u => TriList.BooleanInput[u]).ToList(); @@ -119,25 +122,27 @@ namespace PepperDash.Essentials.Core.PageManagers - /// - /// Represents a SetTopBoxThreePanelPageManager - /// + /// + /// Represents a SetTopBoxThreePanelPageManager + /// public class SetTopBoxThreePanelPageManager : ThreePanelPlusOnePageManager { ISetTopBoxControls SetTopBox; DevicePresetsView PresetsView; - /// - /// Gets or sets the DpadSmartObjectId - /// + /// + /// Gets or sets the DpadSmartObjectId + /// public uint DpadSmartObjectId { get; set; } - /// - /// Gets or sets the NumberPadSmartObjectId - /// + + /// + /// Gets or sets the NumberPadSmartObjectId + /// public uint NumberPadSmartObjectId { get; set; } - /// - /// Gets or sets the PresetsSmartObjectId - /// + + /// + /// Gets or sets the PresetsSmartObjectId + /// public uint PresetsSmartObjectId { get; set; } /// @@ -198,10 +203,10 @@ namespace PepperDash.Essentials.Core.PageManagers } } - /// - /// Show method - /// - /// + /// + /// Show method + /// + /// public override void Show() { if(PresetsView != null) @@ -209,10 +214,10 @@ namespace PepperDash.Essentials.Core.PageManagers base.Show(); } - /// - /// Hide method - /// - /// + /// + /// Hide method + /// + /// public override void Hide() { if (PresetsView != null) diff --git a/src/PepperDash.Essentials.Core/UI PageManagers/SetTopBoxTwoPanelPageManager.cs b/src/PepperDash.Essentials.Core/UI PageManagers/SetTopBoxTwoPanelPageManager.cs index 73465e57..0e5b520a 100644 --- a/src/PepperDash.Essentials.Core/UI PageManagers/SetTopBoxTwoPanelPageManager.cs +++ b/src/PepperDash.Essentials.Core/UI PageManagers/SetTopBoxTwoPanelPageManager.cs @@ -4,14 +4,19 @@ using PepperDash.Essentials.Core.Presets; namespace PepperDash.Essentials.Core.PageManagers { - /// - /// Represents a SetTopBoxMediumPageManager - /// + /// + /// Represents a SetTopBoxMediumPageManager + /// public class SetTopBoxMediumPageManager : MediumLeftSwitchablePageManager { ISetTopBoxControls SetTopBox; DevicePresetsView PresetsView; + /// + /// Constructor + /// + /// set top box controls device + /// trilist device public SetTopBoxMediumPageManager(ISetTopBoxControls stb, BasicTriListWithSmartObject trilist) : base(stb.DisplayUiType) { @@ -21,10 +26,10 @@ namespace PepperDash.Essentials.Core.PageManagers PresetsView = new DevicePresetsView(trilist, stb.TvPresets); } - /// - /// Show method - /// - /// + /// + /// Show method + /// + /// public override void Show() { if(PresetsView != null) @@ -54,10 +59,10 @@ namespace PepperDash.Essentials.Core.PageManagers } } - /// - /// Hide method - /// - /// + /// + /// Hide method + /// + /// public override void Hide() { TriList.BooleanInput[BackingPageJoin].BoolValue = false; diff --git a/src/PepperDash.Essentials.Core/UI PageManagers/SinglePageManager.cs b/src/PepperDash.Essentials.Core/UI PageManagers/SinglePageManager.cs index 4438e89d..3eb0cf80 100644 --- a/src/PepperDash.Essentials.Core/UI PageManagers/SinglePageManager.cs +++ b/src/PepperDash.Essentials.Core/UI PageManagers/SinglePageManager.cs @@ -4,32 +4,37 @@ using PepperDash.Essentials.Core; namespace PepperDash.Essentials.Core.PageManagers { - /// - /// Represents a SinglePageManager - /// + /// + /// Represents a SinglePageManager + /// public class SinglePageManager : PageManager { BasicTriList TriList; uint BackingPageJoin; + /// + /// Constructor + /// + /// join for thepage + /// trilist public SinglePageManager(uint pageJoin, BasicTriList trilist) { TriList = trilist; BackingPageJoin = pageJoin; } - /// - /// Show method - /// - /// + /// + /// Show method + /// + /// public override void Show() { TriList.BooleanInput[BackingPageJoin].BoolValue = true; } - /// - /// Hide method - /// + /// + /// Hide method + /// public override void Hide() { TriList.BooleanInput[BackingPageJoin].BoolValue = false;