src/model/ZoneHVACBaseboardConvectiveWater.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_ZONEHVACBASEBOARDCONVECTIVEWATER_HPP | ||
| 7 | #define MODEL_ZONEHVACBASEBOARDCONVECTIVEWATER_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | #include "ThermalZone.hpp" | ||
| 12 | #include "Model.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | namespace model { | ||
| 16 | |||
| 17 | class Schedule; | ||
| 18 | class StraightComponent; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class ZoneHVACBaseboardConvectiveWater_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** ZoneHVACBaseboardConvectiveWater is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:Baseboard:Convective:Water'. */ | ||
| 27 | class MODEL_API ZoneHVACBaseboardConvectiveWater : public ZoneHVACComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | ZoneHVACBaseboardConvectiveWater(const Model& model, Schedule& availabilitySchedule, StraightComponent& heatingCoilBaseboard); | ||
| 34 | |||
| 35 | 1 | virtual ~ZoneHVACBaseboardConvectiveWater() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | ✗ | ZoneHVACBaseboardConvectiveWater(const ZoneHVACBaseboardConvectiveWater& other) = default; | |
| 38 | ✗ | ZoneHVACBaseboardConvectiveWater(ZoneHVACBaseboardConvectiveWater&& other) = default; | |
| 39 | ✗ | ZoneHVACBaseboardConvectiveWater& operator=(const ZoneHVACBaseboardConvectiveWater&) = default; | |
| 40 | ✗ | ZoneHVACBaseboardConvectiveWater& operator=(ZoneHVACBaseboardConvectiveWater&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | Schedule availabilitySchedule() const; | ||
| 50 | |||
| 51 | StraightComponent heatingCoil() const; | ||
| 52 | |||
| 53 | //@} | ||
| 54 | /** @name Setters */ | ||
| 55 | //@{ | ||
| 56 | |||
| 57 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 58 | |||
| 59 | bool setHeatingCoil(const StraightComponent& heatingCoilBaseboard); | ||
| 60 | |||
| 61 | /** Returns the optional ThermalZone that this ZoneHVACBaseboardConvectiveWater is attached to | ||
| 62 | **/ | ||
| 63 | boost::optional<ThermalZone> thermalZone() const override; | ||
| 64 | |||
| 65 | /** Adds this ZoneHVACBaseboardConvectiveWater to the thermal zone. Returns true if the operation was | ||
| 66 | * successful. | ||
| 67 | **/ | ||
| 68 | bool addToThermalZone(ThermalZone& thermalZone); | ||
| 69 | |||
| 70 | /** Detaches this ZoneHVACBaseboardConvectiveWater from the associated ThermalZone. | ||
| 71 | * If there is no attached ThermalZone there is no effect. | ||
| 72 | **/ | ||
| 73 | void removeFromThermalZone(); | ||
| 74 | |||
| 75 | //@} | ||
| 76 | /** @name Other */ | ||
| 77 | //@{ | ||
| 78 | |||
| 79 | //@} | ||
| 80 | protected: | ||
| 81 | /// @cond | ||
| 82 | using ImplType = detail::ZoneHVACBaseboardConvectiveWater_Impl; | ||
| 83 | |||
| 84 | explicit ZoneHVACBaseboardConvectiveWater(std::shared_ptr<detail::ZoneHVACBaseboardConvectiveWater_Impl> impl); | ||
| 85 | |||
| 86 | friend class detail::ZoneHVACBaseboardConvectiveWater_Impl; | ||
| 87 | friend class Model; | ||
| 88 | friend class IdfObject; | ||
| 89 | friend class openstudio::detail::IdfObject_Impl; | ||
| 90 | /// @endcond | ||
| 91 | private: | ||
| 92 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACBaseboardConvectiveWater"); | |
| 93 | }; | ||
| 94 | |||
| 95 | /** \relates ZoneHVACBaseboardConvectiveWater*/ | ||
| 96 | using OptionalZoneHVACBaseboardConvectiveWater = boost::optional<ZoneHVACBaseboardConvectiveWater>; | ||
| 97 | |||
| 98 | /** \relates ZoneHVACBaseboardConvectiveWater*/ | ||
| 99 | using ZoneHVACBaseboardConvectiveWaterVector = std::vector<ZoneHVACBaseboardConvectiveWater>; | ||
| 100 | |||
| 101 | } // namespace model | ||
| 102 | } // namespace openstudio | ||
| 103 | |||
| 104 | #endif // MODEL_ZONEHVACBASEBOARDCONVECTIVEWATER_HPP | ||
| 105 |