pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-06 16:25:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: complete XML documentation for all projects with inheritdoc tags

Browse Source 
Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-07-22 15:53:01 +00:00
parent 260677a37f
commit 7987eb8f9b
485 changed files with 8099 additions and 2490 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
src/PepperDash.Essentials.Core/Feedbacks/BoolFeedback.cs
View File

@@ -25,7 +25,7 @@ namespace PepperDash.Essentials.Core
public bool TestValue { get; private set; }
/// <summary>
/// Func that evaluates on FireUpdate
/// Gets or sets the ValueFunc
/// </summary>
public Func<bool> ValueFunc { get; private set; }
@@ -67,6 +67,10 @@ namespace PepperDash.Essentials.Core
ValueFunc = newFunc;
}
/// <summary>
/// FireUpdate method
/// </summary>
/// <inheritdoc />
public override void FireUpdate()
{
bool newValue = InTestMode ? TestValue : ValueFunc.Invoke();
@@ -83,6 +87,9 @@ namespace PepperDash.Essentials.Core
/// Links an input sig
/// </summary>
/// <param name="sig"></param>
/// <summary>
/// LinkInputSig method
/// </summary>
public void LinkInputSig(BoolInputSig sig)
{
LinkedInputSigs.Add(sig);
@@ -93,6 +100,9 @@ namespace PepperDash.Essentials.Core
/// Unlinks an inputs sig
/// </summary>
/// <param name="sig"></param>
/// <summary>
/// UnlinkInputSig method
/// </summary>
public void UnlinkInputSig(BoolInputSig sig)
{
LinkedInputSigs.Remove(sig);
@@ -112,6 +122,9 @@ namespace PepperDash.Essentials.Core
/// Unlinks an input sig to the complement value
/// </summary>
/// <param name="sig"></param>
/// <summary>
/// UnlinkComplementInputSig method
/// </summary>
public void UnlinkComplementInputSig(BoolInputSig sig)
{
LinkedComplementInputSigs.Remove(sig);
@@ -131,6 +144,9 @@ namespace PepperDash.Essentials.Core
///
/// </summary>
/// <param name="feedback"></param>
/// <summary>
/// UnlinkCrestronFeedback method
/// </summary>
public void UnlinkCrestronFeedback(Crestron.SimplSharpPro.DeviceSupport.Feedback feedback)
{
LinkedCrestronFeedbacks.Remove(feedback);
@@ -145,6 +161,9 @@ namespace PepperDash.Essentials.Core
/// Puts this in test mode, sets the test value and fires an update.
/// </summary>
/// <param name="value"></param>
/// <summary>
/// SetTestValue method
/// </summary>
public void SetTestValue(bool value)
{
TestValue = value;

21
src/PepperDash.Essentials.Core/Feedbacks/BoolFeedbackOneShot.cs
View File

@@ -6,15 +6,24 @@ using Crestron.SimplSharp;
using Crestron.SimplSharpPro;
namespace PepperDash.Essentials.Core
{
/// <summary>
/// Represents a BoolFeedbackPulse
/// </summary>
public class BoolFeedbackPulse
{
/// <summary>
/// Gets or sets the TimeoutMs
/// </summary>
public uint TimeoutMs { get; set; }
/// <summary>
/// Defaults to false
/// </summary>
/// <summary>
/// Gets or sets the CanRetrigger
/// </summary>
public bool CanRetrigger { get; set; }
/// <summary>
/// Gets or sets the Feedback
/// </summary>
public BoolFeedback Feedback { get; private set; }
CTimer Timer;
@@ -42,6 +51,9 @@ namespace PepperDash.Essentials.Core
/// Starts the
/// </summary>
/// <param name="timeout"></param>
/// <summary>
/// Start method
/// </summary>
public void Start()
{
if (Timer == null)
@@ -60,6 +72,9 @@ namespace PepperDash.Essentials.Core
Timer.Reset(TimeoutMs);
}
/// <summary>
/// Cancel method
/// </summary>
public void Cancel()
{
if(Timer != null)

27
src/PepperDash.Essentials.Core/Feedbacks/BoolOutputLogicals.cs
View File

@@ -11,9 +11,9 @@ namespace PepperDash.Essentials.Core
public abstract class BoolFeedbackLogic
{
/// <summary>
/// Output representing the "and" value of all connected inputs
/// </summary>
/// <summary>
/// Gets or sets the Output
/// </summary>
public BoolFeedback Output { get; private set; }
/// <summary>
@@ -38,6 +38,9 @@ namespace PepperDash.Essentials.Core
Evaluate();
}
/// <summary>
/// AddOutputsIn method
/// </summary>
public void AddOutputsIn(List<BoolFeedback> outputs)
{
foreach (var o in outputs.Where(o => !OutputsIn.Contains(o)))
@@ -48,6 +51,9 @@ namespace PepperDash.Essentials.Core
Evaluate();
}
/// <summary>
/// RemoveOutputIn method
/// </summary>
public void RemoveOutputIn(BoolFeedback output)
{
// Don't double up outputs
@@ -58,6 +64,9 @@ namespace PepperDash.Essentials.Core
Evaluate();
}
/// <summary>
/// RemoveOutputsIn method
/// </summary>
public void RemoveOutputsIn(List<BoolFeedback> outputs)
{
foreach (var o in outputs)
@@ -68,6 +77,9 @@ namespace PepperDash.Essentials.Core
Evaluate();
}
/// <summary>
/// ClearOutputs method
/// </summary>
public void ClearOutputs()
{
OutputsIn.Clear();
@@ -82,6 +94,9 @@ namespace PepperDash.Essentials.Core
protected abstract void Evaluate();
}
/// <summary>
/// Represents a BoolFeedbackAnd
/// </summary>
public class BoolFeedbackAnd : BoolFeedbackLogic
{
protected override void Evaluate()
@@ -97,6 +112,9 @@ namespace PepperDash.Essentials.Core
}
}
/// <summary>
/// Represents a BoolFeedbackOr
/// </summary>
public class BoolFeedbackOr : BoolFeedbackLogic
{
protected override void Evaluate()
@@ -112,6 +130,9 @@ namespace PepperDash.Essentials.Core
}
}
/// <summary>
/// Represents a BoolFeedbackLinq
/// </summary>
public class BoolFeedbackLinq : BoolFeedbackLogic
{
readonly Func<IEnumerable<BoolFeedback>, bool> _predicate;

30
src/PepperDash.Essentials.Core/Feedbacks/FeedbackBase.cs
View File

@@ -13,18 +13,32 @@ namespace PepperDash.Essentials.Core
{
public event EventHandler<FeedbackEventArgs> OutputChange;
/// <summary>
/// Gets or sets the Key
/// </summary>
public string Key { get; private set; }
/// <summary>
/// Gets or sets the BoolValue
/// </summary>
/// <inheritdoc />
public virtual bool BoolValue { get { return false; } }
/// <summary>
/// Gets or sets the IntValue
/// </summary>
public virtual int IntValue { get { return 0; } }
/// <summary>
/// Gets or sets the StringValue
/// </summary>
public virtual string StringValue { get { return ""; } }
/// <summary>
/// Gets or sets the SerialValue
/// </summary>
public virtual string SerialValue { get { return ""; } }
/// <summary>
/// Feedbacks can be put into test mode for simulation of events without real data.
/// Using JSON debugging methods and the Set/ClearTestValue methods, we can simulate
/// Feedback behaviors
/// </summary>
/// <summary>
/// Gets or sets the InTestMode
/// </summary>
public bool InTestMode { get; protected set; }
/// <summary>
@@ -44,9 +58,9 @@ namespace PepperDash.Essentials.Core
/// <summary>
/// Clears test mode and fires update.
/// </summary>
/// <summary>
/// ClearTestValue method
/// </summary>
public void ClearTestValue()
{
InTestMode = false;

18
src/PepperDash.Essentials.Core/Feedbacks/FeedbackEventArgs.cs
View File

@@ -6,9 +6,18 @@ using Crestron.SimplSharp;
namespace PepperDash.Essentials.Core
{
/// <summary>
/// Represents a FeedbackEventArgs
/// </summary>
public class FeedbackEventArgs : EventArgs
{
/// <summary>
/// Gets or sets the BoolValue
/// </summary>
public bool BoolValue { get; private set; }
/// <summary>
/// Gets or sets the IntValue
/// </summary>
public int IntValue { get; private set; }
public ushort UShortValue
{
@@ -17,7 +26,13 @@ namespace PepperDash.Essentials.Core
return (ushort)IntValue;
}
}
/// <summary>
/// Gets or sets the StringValue
/// </summary>
public string StringValue { get; private set; }
/// <summary>
/// Gets or sets the Type
/// </summary>
public eFeedbackEventType Type { get; private set; }
public FeedbackEventArgs(bool value)
@@ -39,6 +54,9 @@ namespace PepperDash.Essentials.Core
}
}
/// <summary>
/// Enumeration of eFeedbackEventType values
/// </summary>
public enum eFeedbackEventType
{
TypeBool,

28
src/PepperDash.Essentials.Core/Feedbacks/IntFeedback.cs
View File

@@ -7,14 +7,26 @@ using Crestron.SimplSharpPro;
namespace PepperDash.Essentials.Core
{
/// <summary>
/// Represents a IntFeedback
/// </summary>
public class IntFeedback : Feedback
{
/// <summary>
/// Gets or sets the IntValue
/// </summary>
public override int IntValue { get { return _IntValue; } } // ValueFunc.Invoke(); } }
int _IntValue;
/// <summary>
/// Gets or sets the UShortValue
/// </summary>
public ushort UShortValue { get { return (ushort)_IntValue; } }
//public override eCueType Type { get { return eCueType.Int; } }
/// <summary>
/// Gets or sets the TestValue
/// </summary>
public int TestValue { get; private set; }
/// <summary>
@@ -57,6 +69,10 @@ namespace PepperDash.Essentials.Core
}
/// <summary>
/// FireUpdate method
/// </summary>
/// <inheritdoc />
public override void FireUpdate()
{
var newValue = InTestMode ? TestValue : ValueFunc.Invoke();
@@ -68,17 +84,26 @@ namespace PepperDash.Essentials.Core
}
}
/// <summary>
/// LinkInputSig method
/// </summary>
public void LinkInputSig(UShortInputSig sig)
{
LinkedInputSigs.Add(sig);
UpdateSig(sig);
}
/// <summary>
/// UnlinkInputSig method
/// </summary>
public void UnlinkInputSig(UShortInputSig sig)
{
LinkedInputSigs.Remove(sig);
}
/// <summary>
/// ToString method
/// </summary>
public override string ToString()
{
return (InTestMode ? "TEST -- " : "") + IntValue.ToString();
@@ -88,6 +113,9 @@ namespace PepperDash.Essentials.Core
/// Puts this in test mode, sets the test value and fires an update.
/// </summary>
/// <param name="value"></param>
/// <summary>
/// SetTestValue method
/// </summary>
public void SetTestValue(int value)
{
TestValue = value;

21
src/PepperDash.Essentials.Core/Feedbacks/SerialFeedback.cs
View File

@@ -19,7 +19,7 @@ namespace PepperDash.Essentials.Core
//public override eCueType Type { get { return eCueType.Serial; } }
/// <summary>
/// Used in testing. Set/Clear functions
/// Gets or sets the TestValue
/// </summary>
public string TestValue { get; private set; }
@@ -34,11 +34,18 @@ namespace PepperDash.Essentials.Core
{
}
/// <summary>
/// FireUpdate method
/// </summary>
/// <inheritdoc />
public override void FireUpdate()
{
throw new NotImplementedException("This feedback type does not use Funcs");
}
/// <summary>
/// FireUpdate method
/// </summary>
public void FireUpdate(string newValue)
{
_SerialValue = newValue;
@@ -46,17 +53,26 @@ namespace PepperDash.Essentials.Core
OnOutputChange(newValue);
}
/// <summary>
/// LinkInputSig method
/// </summary>
public void LinkInputSig(StringInputSig sig)
{
LinkedInputSigs.Add(sig);
UpdateSig(sig);
}
/// <summary>
/// UnlinkInputSig method
/// </summary>
public void UnlinkInputSig(StringInputSig sig)
{
LinkedInputSigs.Remove(sig);
}
/// <summary>
/// ToString method
/// </summary>
public override string ToString()
{
return (InTestMode ? "TEST -- " : "") + SerialValue;
@@ -66,6 +82,9 @@ namespace PepperDash.Essentials.Core
/// Puts this in test mode, sets the test value and fires an update.
/// </summary>
/// <param name="value"></param>
/// <summary>
/// SetTestValue method
/// </summary>
public void SetTestValue(string value)
{
TestValue = value;

26
src/PepperDash.Essentials.Core/Feedbacks/StringFeedback.cs
View File

@@ -8,18 +8,24 @@ using Crestron.SimplSharpPro;
namespace PepperDash.Essentials.Core
{
/// <summary>
/// Represents a StringFeedback
/// </summary>
public class StringFeedback : Feedback
{
/// <summary>
/// Gets or sets the StringValue
/// </summary>
public override string StringValue { get { return _StringValue; } } // ValueFunc.Invoke(); } }
string _StringValue;
/// <summary>
/// Used in testing. Set/Clear functions
/// Gets or sets the TestValue
/// </summary>
public string TestValue { get; private set; }
/// <summary>
/// Evaluated on FireUpdate
/// Gets or sets the ValueFunc
/// </summary>
public Func<string> ValueFunc { get; private set; }
List<StringInputSig> LinkedInputSigs = new List<StringInputSig>();
@@ -57,6 +63,10 @@ namespace PepperDash.Essentials.Core
ValueFunc = newFunc;
}
/// <summary>
/// FireUpdate method
/// </summary>
/// <inheritdoc />
public override void FireUpdate()
{
var newValue = InTestMode ? TestValue : ValueFunc.Invoke();
@@ -68,17 +78,26 @@ namespace PepperDash.Essentials.Core
}
}
/// <summary>
/// LinkInputSig method
/// </summary>
public void LinkInputSig(StringInputSig sig)
{
LinkedInputSigs.Add(sig);
UpdateSig(sig);
}
/// <summary>
/// UnlinkInputSig method
/// </summary>
public void UnlinkInputSig(StringInputSig sig)
{
LinkedInputSigs.Remove(sig);
}
/// <summary>
/// ToString method
/// </summary>
public override string ToString()
{
return (InTestMode ? "TEST -- " : "") + StringValue;
@@ -88,6 +107,9 @@ namespace PepperDash.Essentials.Core
/// Puts this in test mode, sets the test value and fires an update.
/// </summary>
/// <param name="value"></param>
/// <summary>
/// SetTestValue method
/// </summary>
public void SetTestValue(string value)
{
TestValue = value;