src/model/CoilCoolingDX.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_COILCOOLINGDX_HPP | ||
| 7 | #define MODEL_COILCOOLINGDX_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Schedule; | ||
| 16 | class ThermalZone; | ||
| 17 | class CoilCoolingDXCurveFitPerformance; | ||
| 18 | class AirflowNetworkEquivalentDuct; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class CoilCoolingDX_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** CoilCoolingDX is a StraightComponent that wraps the OpenStudio IDD object 'OS:Coil:Cooling:DX'. */ | ||
| 27 | class MODEL_API CoilCoolingDX : public StraightComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit CoilCoolingDX(const Model& model, const CoilCoolingDXCurveFitPerformance& coilCoolingDXCurveFitPerformance); | ||
| 34 | |||
| 35 | 82 | virtual ~CoilCoolingDX() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | 1 | CoilCoolingDX(const CoilCoolingDX& other) = default; | |
| 38 | 21 | CoilCoolingDX(CoilCoolingDX&& other) = default; | |
| 39 | ✗ | CoilCoolingDX& operator=(const CoilCoolingDX&) = default; | |
| 40 | ✗ | CoilCoolingDX& operator=(CoilCoolingDX&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | Schedule availabilitySchedule() const; | ||
| 50 | |||
| 51 | boost::optional<ThermalZone> condenserZone() const; | ||
| 52 | |||
| 53 | CoilCoolingDXCurveFitPerformance performanceObject() const; | ||
| 54 | |||
| 55 | // boost::optional<HVACComponent> condensateCollectionWaterStorageTank() const; | ||
| 56 | // boost::optional<HVACComponent> evaporativeCondenserSupplyWaterStorageTank() const; | ||
| 57 | |||
| 58 | //@} | ||
| 59 | /** @name Setters */ | ||
| 60 | //@{ | ||
| 61 | |||
| 62 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 63 | |||
| 64 | // TODO: As of E+ 9.3.0, this field appears to have no effect. | ||
| 65 | bool setCondenserZone(const ThermalZone& thermalZone); | ||
| 66 | void resetCondenserZone(); | ||
| 67 | |||
| 68 | // TODO: Eventually provide an API to set these Nodes once E+ is done implementing support for it (as of 9.3.0 it's not the case) | ||
| 69 | // boost::optional<std::string> condenserInletNodeName() const; | ||
| 70 | // bool setCondenserInletNodeName(const std::string& condenserInletNodeName); | ||
| 71 | // void resetCondenserInletNodeName(); | ||
| 72 | |||
| 73 | // boost::optional<std::string> condenserOutletNodeName() const; | ||
| 74 | // bool setCondenserOutletNodeName(const std::string& condenserOutletNodeName); | ||
| 75 | // void resetCondenserOutletNodeName(); | ||
| 76 | |||
| 77 | bool setPerformanceObject(const CoilCoolingDXCurveFitPerformance& coilCoolingDXCurveFitPerformance); | ||
| 78 | |||
| 79 | // bool setCondensateCollectionWaterStorageTank(const HVACComponent& condensateCollectionWaterStorageTank); | ||
| 80 | // void resetCondensateCollectionWaterStorageTank(); | ||
| 81 | |||
| 82 | // bool setEvaporativeCondenserSupplyWaterStorageTank(const HVACComponent& evaporativeCondenserSupplyWaterStorageTank); | ||
| 83 | // void resetEvaporativeCondenserSupplyWaterStorageTank(); | ||
| 84 | |||
| 85 | //@} | ||
| 86 | /** @name Other */ | ||
| 87 | //@{ | ||
| 88 | |||
| 89 | /** Returns an equivalent duct object, creating a new one if an object is not already attached. */ | ||
| 90 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 91 | |||
| 92 | /** Returns the attached equivalent duct object if there is one. */ | ||
| 93 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 94 | |||
| 95 | //@} | ||
| 96 | protected: | ||
| 97 | /// @cond | ||
| 98 | using ImplType = detail::CoilCoolingDX_Impl; | ||
| 99 | |||
| 100 | explicit CoilCoolingDX(std::shared_ptr<detail::CoilCoolingDX_Impl> impl); | ||
| 101 | |||
| 102 | friend class detail::CoilCoolingDX_Impl; | ||
| 103 | friend class Model; | ||
| 104 | friend class IdfObject; | ||
| 105 | friend class openstudio::detail::IdfObject_Impl; | ||
| 106 | /// @endcond | ||
| 107 | private: | ||
| 108 | − | REGISTER_LOGGER("openstudio.model.CoilCoolingDX"); | |
| 109 | }; | ||
| 110 | |||
| 111 | /** \relates CoilCoolingDX*/ | ||
| 112 | using OptionalCoilCoolingDX = boost::optional<CoilCoolingDX>; | ||
| 113 | |||
| 114 | /** \relates CoilCoolingDX*/ | ||
| 115 | using CoilCoolingDXVector = std::vector<CoilCoolingDX>; | ||
| 116 | |||
| 117 | } // namespace model | ||
| 118 | } // namespace openstudio | ||
| 119 | |||
| 120 | #endif // MODEL_COILCOOLINGDX_HPP | ||
| 121 |