src/model/ZoneHVACHighTemperatureRadiant.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_ZONEHVACHIGHTEMPERATURERADIANT_HPP | ||
| 7 | #define MODEL_ZONEHVACHIGHTEMPERATURERADIANT_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class Surface; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class ZoneHVACHighTemperatureRadiant_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** ZoneHVACHighTemperatureRadiant is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:HighTemperatureRadiant'. */ | ||
| 26 | class MODEL_API ZoneHVACHighTemperatureRadiant : public ZoneHVACComponent | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit ZoneHVACHighTemperatureRadiant(const Model& model); | ||
| 33 | |||
| 34 | 2 | virtual ~ZoneHVACHighTemperatureRadiant() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | ✗ | ZoneHVACHighTemperatureRadiant(const ZoneHVACHighTemperatureRadiant& other) = default; | |
| 37 | ✗ | ZoneHVACHighTemperatureRadiant(ZoneHVACHighTemperatureRadiant&& other) = default; | |
| 38 | ✗ | ZoneHVACHighTemperatureRadiant& operator=(const ZoneHVACHighTemperatureRadiant&) = default; | |
| 39 | ✗ | ZoneHVACHighTemperatureRadiant& operator=(ZoneHVACHighTemperatureRadiant&&) = default; | |
| 40 | |||
| 41 | //@} | ||
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | static std::vector<std::string> fuelTypeValues(); | ||
| 46 | |||
| 47 | static std::vector<std::string> temperatureControlTypeValues(); | ||
| 48 | |||
| 49 | /** @name Getters */ | ||
| 50 | //@{ | ||
| 51 | |||
| 52 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 53 | |||
| 54 | /** In EnergyPlus 8.2.0 and above this property maps to the EnergyPlus field "Heating Design Capacity" **/ | ||
| 55 | boost::optional<double> maximumPowerInput() const; | ||
| 56 | |||
| 57 | bool isMaximumPowerInputAutosized() const; | ||
| 58 | |||
| 59 | std::string fuelType() const; | ||
| 60 | |||
| 61 | double combustionEfficiency() const; | ||
| 62 | |||
| 63 | double fractionofInputConvertedtoRadiantEnergy() const; | ||
| 64 | |||
| 65 | double fractionofInputConvertedtoLatentEnergy() const; | ||
| 66 | |||
| 67 | double fractionofInputthatIsLost() const; | ||
| 68 | |||
| 69 | std::string temperatureControlType() const; | ||
| 70 | |||
| 71 | double heatingThrottlingRange() const; | ||
| 72 | |||
| 73 | boost::optional<Schedule> heatingSetpointTemperatureSchedule() const; | ||
| 74 | |||
| 75 | double fractionofRadiantEnergyIncidentonPeople() const; | ||
| 76 | |||
| 77 | //@} | ||
| 78 | /** @name Setters */ | ||
| 79 | //@{ | ||
| 80 | |||
| 81 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 82 | |||
| 83 | void resetAvailabilitySchedule(); | ||
| 84 | |||
| 85 | bool setMaximumPowerInput(double maximumPowerInput); | ||
| 86 | |||
| 87 | void autosizeMaximumPowerInput(); | ||
| 88 | |||
| 89 | bool setFuelType(const std::string& fuelType); | ||
| 90 | |||
| 91 | bool setCombustionEfficiency(double combustionEfficiency); | ||
| 92 | |||
| 93 | bool setFractionofInputConvertedtoRadiantEnergy(double fractionofInputConvertedtoRadiantEnergy); | ||
| 94 | |||
| 95 | bool setFractionofInputConvertedtoLatentEnergy(double fractionofInputConvertedtoLatentEnergy); | ||
| 96 | |||
| 97 | bool setFractionofInputthatIsLost(double fractionofInputthatIsLost); | ||
| 98 | |||
| 99 | bool setTemperatureControlType(const std::string& temperatureControlType); | ||
| 100 | |||
| 101 | bool setHeatingThrottlingRange(double heatingThrottlingRange); | ||
| 102 | |||
| 103 | bool setHeatingSetpointTemperatureSchedule(Schedule& schedule); | ||
| 104 | |||
| 105 | void resetHeatingSetpointTemperatureSchedule(); | ||
| 106 | |||
| 107 | bool setFractionofRadiantEnergyIncidentonPeople(double fractionofRadiantEnergyIncidentonPeople); | ||
| 108 | |||
| 109 | //@} | ||
| 110 | /** @name Other */ | ||
| 111 | //@{ | ||
| 112 | |||
| 113 | boost::optional<ThermalZone> thermalZone() const override; | ||
| 114 | |||
| 115 | bool addToThermalZone(ThermalZone& thermalZone); | ||
| 116 | |||
| 117 | void removeFromThermalZone(); | ||
| 118 | //@} | ||
| 119 | |||
| 120 | boost::optional<double> autosizedMaximumPowerInput() const; | ||
| 121 | |||
| 122 | protected: | ||
| 123 | /// @cond | ||
| 124 | using ImplType = detail::ZoneHVACHighTemperatureRadiant_Impl; | ||
| 125 | |||
| 126 | explicit ZoneHVACHighTemperatureRadiant(std::shared_ptr<detail::ZoneHVACHighTemperatureRadiant_Impl> impl); | ||
| 127 | |||
| 128 | friend class detail::ZoneHVACHighTemperatureRadiant_Impl; | ||
| 129 | friend class Model; | ||
| 130 | friend class IdfObject; | ||
| 131 | friend class openstudio::detail::IdfObject_Impl; | ||
| 132 | /// @endcond | ||
| 133 | private: | ||
| 134 | REGISTER_LOGGER("openstudio.model.ZoneHVACHighTemperatureRadiant"); | ||
| 135 | }; | ||
| 136 | |||
| 137 | /** \relates ZoneHVACHighTemperatureRadiant*/ | ||
| 138 | using OptionalZoneHVACHighTemperatureRadiant = boost::optional<ZoneHVACHighTemperatureRadiant>; | ||
| 139 | |||
| 140 | /** \relates ZoneHVACHighTemperatureRadiant*/ | ||
| 141 | using ZoneHVACHighTemperatureRadiantVector = std::vector<ZoneHVACHighTemperatureRadiant>; | ||
| 142 | |||
| 143 | } // namespace model | ||
| 144 | } // namespace openstudio | ||
| 145 | |||
| 146 | #endif // MODEL_ZONEHVACHIGHTEMPERATURERADIANT_HPP | ||
| 147 |