src/model/ZoneAirContaminantBalance.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_ZONEAIRCONTAMINANTBALANCE_HPP | ||
| 7 | #define MODEL_ZONEAIRCONTAMINANTBALANCE_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Schedule; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | class ZoneAirContaminantBalance_Impl; | ||
| 20 | |||
| 21 | } // namespace detail | ||
| 22 | |||
| 23 | /** ZoneAirContaminantBalance is a ModelObject that wraps the OpenStudio IDD object 'OS:ZoneAirContaminantBalance'. */ | ||
| 24 | class MODEL_API ZoneAirContaminantBalance : public ModelObject | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | 59 | virtual ~ZoneAirContaminantBalance() override = default; | |
| 31 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 32 | ✗ | ZoneAirContaminantBalance(const ZoneAirContaminantBalance& other) = default; | |
| 33 | 22 | ZoneAirContaminantBalance(ZoneAirContaminantBalance&& other) = default; | |
| 34 | ✗ | ZoneAirContaminantBalance& operator=(const ZoneAirContaminantBalance&) = default; | |
| 35 | ✗ | ZoneAirContaminantBalance& operator=(ZoneAirContaminantBalance&&) = default; | |
| 36 | |||
| 37 | //@} | ||
| 38 | |||
| 39 | static IddObjectType iddObjectType(); | ||
| 40 | |||
| 41 | /** @name Getters */ | ||
| 42 | //@{ | ||
| 43 | |||
| 44 | bool carbonDioxideConcentration() const; | ||
| 45 | |||
| 46 | bool isCarbonDioxideConcentrationDefaulted() const; | ||
| 47 | |||
| 48 | boost::optional<Schedule> outdoorCarbonDioxideSchedule() const; | ||
| 49 | |||
| 50 | //@} | ||
| 51 | /** @name Setters */ | ||
| 52 | //@{ | ||
| 53 | |||
| 54 | bool setCarbonDioxideConcentration(bool carbonDioxideConcentration); | ||
| 55 | |||
| 56 | void setCarbonDioxideConcentrationNoFail(bool carbonDioxideConcentration); | ||
| 57 | |||
| 58 | void resetCarbonDioxideConcentration(); | ||
| 59 | |||
| 60 | bool setOutdoorCarbonDioxideSchedule(Schedule& schedule); | ||
| 61 | |||
| 62 | void resetOutdoorCarbonDioxideSchedule(); | ||
| 63 | |||
| 64 | //@} | ||
| 65 | /** @name Other */ | ||
| 66 | //@{ | ||
| 67 | |||
| 68 | //@} | ||
| 69 | protected: | ||
| 70 | /// @cond | ||
| 71 | using ImplType = detail::ZoneAirContaminantBalance_Impl; | ||
| 72 | |||
| 73 | explicit ZoneAirContaminantBalance(std::shared_ptr<detail::ZoneAirContaminantBalance_Impl> impl); | ||
| 74 | |||
| 75 | friend class detail::ZoneAirContaminantBalance_Impl; | ||
| 76 | friend class Model; | ||
| 77 | friend class IdfObject; | ||
| 78 | friend class openstudio::detail::IdfObject_Impl; | ||
| 79 | explicit ZoneAirContaminantBalance(Model& model); | ||
| 80 | |||
| 81 | /// @endcond | ||
| 82 | private: | ||
| 83 | REGISTER_LOGGER("openstudio.model.ZoneAirContaminantBalance"); | ||
| 84 | }; | ||
| 85 | |||
| 86 | /** \relates ZoneAirContaminantBalance*/ | ||
| 87 | using OptionalZoneAirContaminantBalance = boost::optional<ZoneAirContaminantBalance>; | ||
| 88 | |||
| 89 | /** \relates ZoneAirContaminantBalance*/ | ||
| 90 | using ZoneAirContaminantBalanceVector = std::vector<ZoneAirContaminantBalance>; | ||
| 91 | |||
| 92 | } // namespace model | ||
| 93 | } // namespace openstudio | ||
| 94 | |||
| 95 | #endif // MODEL_ZONEAIRCONTAMINANTBALANCE_HPP | ||
| 96 |