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

wip: update XML comments

Browse Source
This commit is contained in:
Erik Meyer
2026-01-28 15:42:44 -05:00
parent 92059aa43c
commit ca77506108
27 changed files with 625 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
src/PepperDash.Essentials.Core/Room/Room.cs
View File

@@ -12,33 +12,54 @@ namespace PepperDash.Essentials.Core
{
//***************************************************************************************************
/// <summary>
/// Abstract base class for Room
/// </summary>
public abstract class Room : Device, IHasFeedback
{
/// <summary>
/// Gets or sets the RoomIsOnFeedback
/// </summary>
public abstract BoolFeedback RoomIsOnFeedback { get; protected set; }
/// <summary>
/// Gets or sets the IsCoolingDownFeedback
/// </summary>
public abstract BoolFeedback IsCoolingDownFeedback { get; protected set; }
/// <summary>
/// Gets or sets the IsWarmingUpFeedback
/// </summary>
public abstract BoolFeedback IsWarmingUpFeedback { get; protected set; }
// In concrete classes, these should be computed from the relevant devices
/// <summary>
/// Gets or sets the CooldownTime
/// </summary>
/// <inheritdoc />
/// <summary>
/// Gets or sets the CooldownTime
/// </summary>
/// <inheritdoc />
public virtual uint CooldownTime { get { return 10000; } }
/// <summary>
/// Gets or sets the WarmupTime
/// </summary>
/// <inheritdoc />
/// <summary>
/// Gets or sets the WarmupTime
/// </summary>
/// <inheritdoc />
public virtual uint WarmupTime { get { return 5000; } }
/// <summary>
/// Gets or sets the Description
/// </summary>
/// <summary>
/// Gets or sets the Description
/// </summary>
public string Description { get; set; }
/// <summary>
/// Gets or sets the HelpMessage
/// </summary>
/// <summary>
/// Gets or sets the HelpMessage
/// </summary>
public string HelpMessage { get; set; }
/// <summary>
/// Room Constructor
/// </summary>
/// <param name="key">room key</param>
/// <param name="name">room name</param>
public Room(string key, string name)
: base(key, name)
{
@@ -59,6 +80,9 @@ namespace PepperDash.Essentials.Core
#region IDeviceWithOutputs Members
/// <summary>
/// Gets the Feedbacks
/// </summary>
public virtual FeedbackCollection<Feedback> Feedbacks
{
get