src/model/ZoneHVACBaseboardRadiantConvectiveElectric.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_ZONEHVACBASEBOARDRADIANTCONVECTIVEELECTRIC_HPP | ||
| 7 | #define MODEL_ZONEHVACBASEBOARDRADIANTCONVECTIVEELECTRIC_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class ThermalZone; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class ZoneHVACBaseboardRadiantConvectiveElectric_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** ZoneHVACBaseboardRadiantConvectiveElectric is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:Baseboard:RadiantConvective:Electric'. */ | ||
| 26 | class MODEL_API ZoneHVACBaseboardRadiantConvectiveElectric : public ZoneHVACComponent | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit ZoneHVACBaseboardRadiantConvectiveElectric(const Model& model); | ||
| 33 | |||
| 34 | 2 | virtual ~ZoneHVACBaseboardRadiantConvectiveElectric() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | ✗ | ZoneHVACBaseboardRadiantConvectiveElectric(const ZoneHVACBaseboardRadiantConvectiveElectric& other) = default; | |
| 37 | ✗ | ZoneHVACBaseboardRadiantConvectiveElectric(ZoneHVACBaseboardRadiantConvectiveElectric&& other) = default; | |
| 38 | ✗ | ZoneHVACBaseboardRadiantConvectiveElectric& operator=(const ZoneHVACBaseboardRadiantConvectiveElectric&) = default; | |
| 39 | ✗ | ZoneHVACBaseboardRadiantConvectiveElectric& operator=(ZoneHVACBaseboardRadiantConvectiveElectric&&) = default; | |
| 40 | |||
| 41 | //@} | ||
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | static std::vector<std::string> heatingDesignCapacityMethodValues(); | ||
| 46 | |||
| 47 | /** @name Getters */ | ||
| 48 | //@{ | ||
| 49 | |||
| 50 | Schedule availabilitySchedule() const; | ||
| 51 | |||
| 52 | std::string heatingDesignCapacityMethod() const; | ||
| 53 | |||
| 54 | boost::optional<double> heatingDesignCapacity() const; | ||
| 55 | |||
| 56 | bool isHeatingDesignCapacityAutosized() const; | ||
| 57 | |||
| 58 | double heatingDesignCapacityPerFloorArea() const; | ||
| 59 | |||
| 60 | double fractionofAutosizedHeatingDesignCapacity() const; | ||
| 61 | |||
| 62 | double efficiency() const; | ||
| 63 | |||
| 64 | double fractionRadiant() const; | ||
| 65 | |||
| 66 | double fractionofRadiantEnergyIncidentonPeople() const; | ||
| 67 | |||
| 68 | //@} | ||
| 69 | /** @name Setters */ | ||
| 70 | //@{ | ||
| 71 | |||
| 72 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 73 | |||
| 74 | bool setHeatingDesignCapacityMethod(const std::string& heatingDesignCapacityMethod); | ||
| 75 | |||
| 76 | bool setHeatingDesignCapacity(double heatingDesignCapacity); | ||
| 77 | |||
| 78 | void autosizeHeatingDesignCapacity(); | ||
| 79 | |||
| 80 | bool setHeatingDesignCapacityPerFloorArea(double heatingDesignCapacityPerFloorArea); | ||
| 81 | |||
| 82 | bool setFractionofAutosizedHeatingDesignCapacity(double fractionofAutosizedHeatingDesignCapacity); | ||
| 83 | |||
| 84 | bool setEfficiency(double efficiency); | ||
| 85 | |||
| 86 | bool setFractionRadiant(double fractionRadiant); | ||
| 87 | |||
| 88 | bool setFractionofRadiantEnergyIncidentonPeople(double fractionofRadiantEnergyIncidentonPeople); | ||
| 89 | |||
| 90 | //@} | ||
| 91 | /** @name Other */ | ||
| 92 | //@{ | ||
| 93 | |||
| 94 | /** Returns the optional ThermalZone that this ZoneHVACBaseboardRadiantConvectiveElectric is attached to | ||
| 95 | **/ | ||
| 96 | boost::optional<ThermalZone> thermalZone() const override; | ||
| 97 | |||
| 98 | /** Adds this ZoneHVACBaseboardRadiantConvectiveElectric to the thermal zone. Returns true if the operation was | ||
| 99 | * successful. | ||
| 100 | **/ | ||
| 101 | bool addToThermalZone(ThermalZone& thermalZone); | ||
| 102 | |||
| 103 | /** Detaches this ZoneHVACBaseboardRadiantConvectiveElectric from the associated ThermalZone. | ||
| 104 | * If there is no attached ThermalZone there is no effect. | ||
| 105 | **/ | ||
| 106 | void removeFromThermalZone(); | ||
| 107 | |||
| 108 | boost::optional<double> autosizedHeatingDesignCapacity() const; | ||
| 109 | |||
| 110 | //@} | ||
| 111 | protected: | ||
| 112 | /// @cond | ||
| 113 | using ImplType = detail::ZoneHVACBaseboardRadiantConvectiveElectric_Impl; | ||
| 114 | |||
| 115 | explicit ZoneHVACBaseboardRadiantConvectiveElectric(std::shared_ptr<detail::ZoneHVACBaseboardRadiantConvectiveElectric_Impl> impl); | ||
| 116 | |||
| 117 | friend class detail::ZoneHVACBaseboardRadiantConvectiveElectric_Impl; | ||
| 118 | friend class Model; | ||
| 119 | friend class IdfObject; | ||
| 120 | friend class openstudio::detail::IdfObject_Impl; | ||
| 121 | /// @endcond | ||
| 122 | private: | ||
| 123 | REGISTER_LOGGER("openstudio.model.ZoneHVACBaseboardRadiantConvectiveElectric"); | ||
| 124 | }; | ||
| 125 | |||
| 126 | /** \relates ZoneHVACBaseboardRadiantConvectiveElectric*/ | ||
| 127 | using OptionalZoneHVACBaseboardRadiantConvectiveElectric = boost::optional<ZoneHVACBaseboardRadiantConvectiveElectric>; | ||
| 128 | |||
| 129 | /** \relates ZoneHVACBaseboardRadiantConvectiveElectric*/ | ||
| 130 | using ZoneHVACBaseboardRadiantConvectiveElectricVector = std::vector<ZoneHVACBaseboardRadiantConvectiveElectric>; | ||
| 131 | |||
| 132 | } // namespace model | ||
| 133 | } // namespace openstudio | ||
| 134 | |||
| 135 | #endif // MODEL_ZONEHVACBASEBOARDRADIANTCONVECTIVEELECTRIC_HPP | ||
| 136 |