src/model/AirToAirComponent.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_AIRTOAIRCOMPONENT_HPP | ||
| 7 | #define MODEL_AIRTOAIRCOMPONENT_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "HVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | namespace detail { | ||
| 16 | class AirToAirComponent_Impl; | ||
| 17 | } | ||
| 18 | |||
| 19 | class AirLoopHVAC; | ||
| 20 | |||
| 21 | /** AirToAirComponent is the base class for model objects which interact with | ||
| 22 | * two air streams. | ||
| 23 | * | ||
| 24 | * These objects are typically heat recovery devices such as the EnergyPlus IDD object | ||
| 25 | * named HeatExchanger:AirToAir:SensibleAndLatent. | ||
| 26 | */ | ||
| 27 | class MODEL_API AirToAirComponent : public HVACComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | AirToAirComponent(IddObjectType type, const Model& model); | ||
| 31 | |||
| 32 | 2848 | virtual ~AirToAirComponent() override = default; | |
| 33 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 34 | 53 | AirToAirComponent(const AirToAirComponent& other) = default; | |
| 35 | 1363 | AirToAirComponent(AirToAirComponent&& other) = default; | |
| 36 | ✗ | AirToAirComponent& operator=(const AirToAirComponent&) = default; | |
| 37 | ✗ | AirToAirComponent& operator=(AirToAirComponent&&) = default; | |
| 38 | |||
| 39 | /** Returns the primary air stream inlet port. | ||
| 40 | * | ||
| 41 | * In the conext of air to air heat recovery devices in EnergyPlus, | ||
| 42 | * the primary air stream is often thought of as the supply side air stream | ||
| 43 | * which is the supply of outdoor air into the system. | ||
| 44 | */ | ||
| 45 | unsigned primaryAirInletPort() const; | ||
| 46 | |||
| 47 | /** Returns the primary air stream outlet port. **/ | ||
| 48 | unsigned primaryAirOutletPort() const; | ||
| 49 | |||
| 50 | /** Returns the optional ModelObject connected to the primary air stream inlet port. **/ | ||
| 51 | boost::optional<ModelObject> primaryAirInletModelObject() const; | ||
| 52 | |||
| 53 | /** Returns the optional ModelObject connected to the primary air stream outlet port. **/ | ||
| 54 | boost::optional<ModelObject> primaryAirOutletModelObject() const; | ||
| 55 | |||
| 56 | /** Returns the secondary air stream inlet port. | ||
| 57 | * | ||
| 58 | * In the context of air to air heat recovery devices in EnergyPlus, | ||
| 59 | * the secondary air stream is often the exhaust air stream leaving the system. | ||
| 60 | */ | ||
| 61 | unsigned secondaryAirInletPort() const; | ||
| 62 | |||
| 63 | /** Returns the secondary air stream outlet port. **/ | ||
| 64 | unsigned secondaryAirOutletPort() const; | ||
| 65 | |||
| 66 | /** Returns the optional ModelObject connected to the secondary air stream inlet port. **/ | ||
| 67 | boost::optional<ModelObject> secondaryAirInletModelObject() const; | ||
| 68 | |||
| 69 | /** Returns the optional ModelObject connected to the secondary air stream outlet port. **/ | ||
| 70 | boost::optional<ModelObject> secondaryAirOutletModelObject() const; | ||
| 71 | |||
| 72 | bool addToNode(Node& node); | ||
| 73 | |||
| 74 | std::vector<openstudio::IdfObject> remove(); | ||
| 75 | |||
| 76 | ModelObject clone(Model model) const; | ||
| 77 | |||
| 78 | protected: | ||
| 79 | friend class Model; | ||
| 80 | |||
| 81 | friend class openstudio::IdfObject; | ||
| 82 | |||
| 83 | /// @cond | ||
| 84 | |||
| 85 | using ImplType = detail::AirToAirComponent_Impl; | ||
| 86 | |||
| 87 | explicit AirToAirComponent(std::shared_ptr<detail::AirToAirComponent_Impl> impl); | ||
| 88 | |||
| 89 | private: | ||
| 90 | REGISTER_LOGGER("openstudio.model.AirToAirComponent"); | ||
| 91 | |||
| 92 | /// @endcond | ||
| 93 | }; | ||
| 94 | |||
| 95 | using OptionalAirToAirComponent = boost::optional<AirToAirComponent>; | ||
| 96 | |||
| 97 | } // namespace model | ||
| 98 | } // namespace openstudio | ||
| 99 | |||
| 100 | #endif // MODEL_AIRTOAIRCOMPONENT_HPP | ||
| 101 |