src/model/ZoneHVACLowTemperatureRadiantElectric.hpp
| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | /*********************************************************************************************************************** | ||
| 2 | * OpenStudio(R), Copyright (c) Alliance for Energy Innovation, LLC. | ||
| 3 | * See also https://openstudio.net/license | ||
| 4 | ***********************************************************************************************************************/ | ||
| 5 | |||
| 6 | #ifndef MODEL_ZONEHVACLOWTEMPERATURERADIANTELECTRIC_HPP | ||
| 7 | #define MODEL_ZONEHVACLOWTEMPERATURERADIANTELECTRIC_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "Surface.hpp" | ||
| 11 | #include "Surface_Impl.hpp" | ||
| 12 | #include "ZoneHVACComponent.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class Schedule; | ||
| 19 | class HVACComponent; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | class ZoneHVACLowTemperatureRadiantElectric_Impl; | ||
| 24 | |||
| 25 | } // namespace detail | ||
| 26 | |||
| 27 | /** ZoneHVACLowTemperatureRadiantElectric is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:LowTemperatureRadiant:Electric'. */ | ||
| 28 | class MODEL_API ZoneHVACLowTemperatureRadiantElectric : public ZoneHVACComponent | ||
| 29 | { | ||
| 30 | public: | ||
| 31 | /** @name Constructors and Destructors */ | ||
| 32 | //@{ | ||
| 33 | |||
| 34 | explicit ZoneHVACLowTemperatureRadiantElectric(const Model& model, Schedule& availabilitySchedule, Schedule& heatingTemperatureSchedule); | ||
| 35 | |||
| 36 | 22 | virtual ~ZoneHVACLowTemperatureRadiantElectric() override = default; | |
| 37 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 38 | 1 | ZoneHVACLowTemperatureRadiantElectric(const ZoneHVACLowTemperatureRadiantElectric& other) = default; | |
| 39 | 2 | ZoneHVACLowTemperatureRadiantElectric(ZoneHVACLowTemperatureRadiantElectric&& other) = default; | |
| 40 | ✗ | ZoneHVACLowTemperatureRadiantElectric& operator=(const ZoneHVACLowTemperatureRadiantElectric&) = default; | |
| 41 | ✗ | ZoneHVACLowTemperatureRadiantElectric& operator=(ZoneHVACLowTemperatureRadiantElectric&&) = default; | |
| 42 | |||
| 43 | //@} | ||
| 44 | |||
| 45 | static IddObjectType iddObjectType(); | ||
| 46 | |||
| 47 | static std::vector<std::string> radiantSurfaceTypeValues(); | ||
| 48 | |||
| 49 | static std::vector<std::string> temperatureControlTypeValues(); | ||
| 50 | |||
| 51 | /** @name Getters */ | ||
| 52 | |||
| 53 | Schedule availabilitySchedule() const; | ||
| 54 | |||
| 55 | Schedule heatingSetpointTemperatureSchedule() const; | ||
| 56 | |||
| 57 | boost::optional<std::string> radiantSurfaceType() const; | ||
| 58 | |||
| 59 | std::vector<Surface> surfaces() const; | ||
| 60 | |||
| 61 | /** In EnergyPlus 8.2.0 and above this property maps to the EnergyPlus field "Heating Design Capacity" **/ | ||
| 62 | boost::optional<double> maximumElectricalPowertoPanel() const; | ||
| 63 | |||
| 64 | bool isMaximumElectricalPowertoPanelDefaulted() const; | ||
| 65 | |||
| 66 | bool isMaximumElectricalPowertoPanelAutosized() const; | ||
| 67 | |||
| 68 | std::string temperatureControlType() const; | ||
| 69 | |||
| 70 | bool isTemperatureControlTypeDefaulted() const; | ||
| 71 | |||
| 72 | std::string setpointControlType() const; | ||
| 73 | |||
| 74 | bool isSetpointControlTypeDefaulted() const; | ||
| 75 | |||
| 76 | double heatingThrottlingRange() const; | ||
| 77 | |||
| 78 | bool isHeatingThrottlingRangeDefaulted() const; | ||
| 79 | |||
| 80 | /** @name Setters */ | ||
| 81 | |||
| 82 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 83 | |||
| 84 | bool setHeatingSetpointTemperatureSchedule(Schedule& schedule); | ||
| 85 | |||
| 86 | bool setRadiantSurfaceType(const std::string& radiantSurfaceType); | ||
| 87 | |||
| 88 | void resetRadiantSurfaceType(); | ||
| 89 | |||
| 90 | bool setMaximumElectricalPowertoPanel(double maximumElectricalPowertoPanel); | ||
| 91 | |||
| 92 | void resetMaximumElectricalPowertoPanel(); | ||
| 93 | |||
| 94 | void autosizeMaximumElectricalPowertoPanel(); | ||
| 95 | |||
| 96 | bool setTemperatureControlType(const std::string& temperatureControlType); | ||
| 97 | |||
| 98 | void resetTemperatureControlType(); | ||
| 99 | |||
| 100 | bool setSetpointControlType(const std::string& setpointControlType); | ||
| 101 | |||
| 102 | void resetSetpointControlType(); | ||
| 103 | |||
| 104 | bool setHeatingThrottlingRange(double heatingThrottlingRange); | ||
| 105 | |||
| 106 | void resetHeatingThrottlingRange(); | ||
| 107 | |||
| 108 | boost::optional<ThermalZone> thermalZone() const override; | ||
| 109 | |||
| 110 | bool addToThermalZone(ThermalZone& thermalZone); | ||
| 111 | |||
| 112 | void removeFromThermalZone(); | ||
| 113 | |||
| 114 | /** @name Other */ | ||
| 115 | |||
| 116 | boost::optional<double> autosizedMaximumElectricalPowertoPanel() const; | ||
| 117 | |||
| 118 | //@} | ||
| 119 | protected: | ||
| 120 | /// @cond | ||
| 121 | using ImplType = detail::ZoneHVACLowTemperatureRadiantElectric_Impl; | ||
| 122 | |||
| 123 | explicit ZoneHVACLowTemperatureRadiantElectric(std::shared_ptr<detail::ZoneHVACLowTemperatureRadiantElectric_Impl> impl); | ||
| 124 | |||
| 125 | friend class detail::ZoneHVACLowTemperatureRadiantElectric_Impl; | ||
| 126 | friend class Model; | ||
| 127 | friend class IdfObject; | ||
| 128 | friend class openstudio::detail::IdfObject_Impl; | ||
| 129 | /// @endcond | ||
| 130 | private: | ||
| 131 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACLowTemperatureRadiantElectric"); | |
| 132 | }; | ||
| 133 | |||
| 134 | /** \relates ZoneHVACLowTemperatureRadiantElectric*/ | ||
| 135 | using OptionalZoneHVACLowTemperatureRadiantElectric = boost::optional<ZoneHVACLowTemperatureRadiantElectric>; | ||
| 136 | |||
| 137 | /** \relates ZoneHVACLowTemperatureRadiantElectric*/ | ||
| 138 | using ZoneHVACLowTemperatureRadiantElectricVector = std::vector<ZoneHVACLowTemperatureRadiantElectric>; | ||
| 139 | |||
| 140 | } // namespace model | ||
| 141 | } // namespace openstudio | ||
| 142 | |||
| 143 | #endif // MODEL_ZONEHVACLOWTEMPERATURERADIANTELECTRIC_HPP | ||
| 144 |