src/model/ZoneHVACBaseboardConvectiveElectric.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_ZONEHVACBASEBOARDCONVECTIVEELECTRIC_HPP | ||
| 7 | #define MODEL_ZONEHVACBASEBOARDCONVECTIVEELECTRIC_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 ZoneHVACBaseboardConvectiveElectric_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** ZoneHVACBaseboardConvectiveElectric is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:Baseboard:Convective:Electric'. */ | ||
| 26 | class MODEL_API ZoneHVACBaseboardConvectiveElectric : public ZoneHVACComponent | ||
| 27 | { | ||
| 28 | |||
| 29 | public: | ||
| 30 | explicit ZoneHVACBaseboardConvectiveElectric(const Model& model); | ||
| 31 | |||
| 32 | 27 | virtual ~ZoneHVACBaseboardConvectiveElectric() override = default; | |
| 33 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 34 | ✗ | ZoneHVACBaseboardConvectiveElectric(const ZoneHVACBaseboardConvectiveElectric& other) = default; | |
| 35 | ✗ | ZoneHVACBaseboardConvectiveElectric(ZoneHVACBaseboardConvectiveElectric&& other) = default; | |
| 36 | ✗ | ZoneHVACBaseboardConvectiveElectric& operator=(const ZoneHVACBaseboardConvectiveElectric&) = default; | |
| 37 | ✗ | ZoneHVACBaseboardConvectiveElectric& operator=(ZoneHVACBaseboardConvectiveElectric&&) = default; | |
| 38 | |||
| 39 | static IddObjectType iddObjectType(); | ||
| 40 | |||
| 41 | Schedule availabilitySchedule() const; | ||
| 42 | |||
| 43 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 44 | |||
| 45 | /** In EnergyPlus 8.2.0 and up, this property maps to the EnergyPLus field "Heating Design Capacity" | ||
| 46 | **/ | ||
| 47 | boost::optional<double> nominalCapacity() const; | ||
| 48 | |||
| 49 | bool isNominalCapacityAutosized() const; | ||
| 50 | |||
| 51 | bool setNominalCapacity(double nominalCapacity); | ||
| 52 | |||
| 53 | void autosizeNominalCapacity(); | ||
| 54 | |||
| 55 | double efficiency() const; | ||
| 56 | |||
| 57 | bool isEfficiencyDefaulted() const; | ||
| 58 | |||
| 59 | bool setEfficiency(double efficiency); | ||
| 60 | |||
| 61 | void resetEfficiency(); | ||
| 62 | |||
| 63 | /** Returns the optional ThermalZone that this ZoneHVACBaseboardConvectiveElectric is attached to | ||
| 64 | **/ | ||
| 65 | boost::optional<ThermalZone> thermalZone() const override; | ||
| 66 | |||
| 67 | /** Adds this ZoneHVACBaseboardConvectiveElectric to the thermal zone. Returns true if the operation was | ||
| 68 | * successful. | ||
| 69 | **/ | ||
| 70 | bool addToThermalZone(ThermalZone& thermalZone); | ||
| 71 | |||
| 72 | /** Detaches this ZoneHVACBaseboardConvectiveElectric from the associated ThermalZone. | ||
| 73 | * If there is no attached ThermalZone there is no effect. | ||
| 74 | **/ | ||
| 75 | void removeFromThermalZone(); | ||
| 76 | |||
| 77 | boost::optional<double> autosizedNominalCapacity() const; | ||
| 78 | |||
| 79 | protected: | ||
| 80 | /// @cond | ||
| 81 | using ImplType = detail::ZoneHVACBaseboardConvectiveElectric_Impl; | ||
| 82 | |||
| 83 | explicit ZoneHVACBaseboardConvectiveElectric(std::shared_ptr<detail::ZoneHVACBaseboardConvectiveElectric_Impl> impl); | ||
| 84 | |||
| 85 | friend class detail::ZoneHVACBaseboardConvectiveElectric_Impl; | ||
| 86 | friend class Model; | ||
| 87 | friend class IdfObject; | ||
| 88 | friend class openstudio::detail::IdfObject_Impl; | ||
| 89 | |||
| 90 | /// @endcond | ||
| 91 | |||
| 92 | private: | ||
| 93 | REGISTER_LOGGER("openstudio.model.ZoneHVACBaseboardConvectiveElectric"); | ||
| 94 | }; | ||
| 95 | |||
| 96 | /** \relates ZoneHVACBaseboardConvectiveElectric*/ | ||
| 97 | using OptionalZoneHVACBaseboardConvectiveElectric = boost::optional<ZoneHVACBaseboardConvectiveElectric>; | ||
| 98 | |||
| 99 | /** \relates ZoneHVACBaseboardConvectiveElectric*/ | ||
| 100 | using ZoneHVACBaseboardConvectiveElectricVector = std::vector<ZoneHVACBaseboardConvectiveElectric>; | ||
| 101 | |||
| 102 | } // namespace model | ||
| 103 | } // namespace openstudio | ||
| 104 | |||
| 105 | #endif // MODEL_ZONEHVACBASEBOARDCONVECTIVEELECTRIC_HPP | ||
| 106 |