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