src/model/ConstructionAirBoundary.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_CONSTRUCTIONAIRBOUNDARY_HPP | ||
| 7 | #define MODEL_CONSTRUCTIONAIRBOUNDARY_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "ConstructionBase.hpp" | ||
| 11 | #include "../utilities/core/Deprecated.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | |||
| 15 | namespace model { | ||
| 16 | |||
| 17 | // TODO: Check the following class names against object getters and setters. | ||
| 18 | class Schedule; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class ConstructionAirBoundary_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** ConstructionAirBoundary is a ConstructionBase that wraps the OpenStudio IDD object 'OS:Construction:AirBoundary'. */ | ||
| 27 | class MODEL_API ConstructionAirBoundary : public ConstructionBase | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit ConstructionAirBoundary(const Model& model); | ||
| 34 | |||
| 35 | 2128 | virtual ~ConstructionAirBoundary() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | 40 | ConstructionAirBoundary(const ConstructionAirBoundary& other) = default; | |
| 38 | 890 | ConstructionAirBoundary(ConstructionAirBoundary&& other) = default; | |
| 39 | ✗ | ConstructionAirBoundary& operator=(const ConstructionAirBoundary&) = default; | |
| 40 | ✗ | ConstructionAirBoundary& operator=(ConstructionAirBoundary&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | OS_DEPRECATED(3, 2, 0) static std::vector<std::string> solarAndDaylightingMethodValues(); | ||
| 47 | |||
| 48 | OS_DEPRECATED(3, 2, 0) static std::vector<std::string> radiantExchangeMethodValues(); | ||
| 49 | |||
| 50 | static std::vector<std::string> airExchangeMethodValues(); | ||
| 51 | |||
| 52 | /** @name Getters */ | ||
| 53 | //@{ | ||
| 54 | |||
| 55 | // cppcheck-suppress functionStatic | ||
| 56 | OS_DEPRECATED(3, 2, 0) std::string solarAndDaylightingMethod() const; | ||
| 57 | |||
| 58 | // cppcheck-suppress functionStatic | ||
| 59 | OS_DEPRECATED(3, 2, 0) bool isSolarAndDaylightingMethodDefaulted() const; | ||
| 60 | |||
| 61 | // cppcheck-suppress functionStatic | ||
| 62 | OS_DEPRECATED(3, 2, 0) std::string radiantExchangeMethod() const; | ||
| 63 | |||
| 64 | // cppcheck-suppress functionStatic | ||
| 65 | OS_DEPRECATED(3, 2, 0) bool isRadiantExchangeMethodDefaulted() const; | ||
| 66 | |||
| 67 | std::string airExchangeMethod() const; | ||
| 68 | |||
| 69 | bool isAirExchangeMethodDefaulted() const; | ||
| 70 | |||
| 71 | double simpleMixingAirChangesPerHour() const; | ||
| 72 | |||
| 73 | bool isSimpleMixingAirChangesPerHourDefaulted() const; | ||
| 74 | |||
| 75 | boost::optional<Schedule> simpleMixingSchedule() const; | ||
| 76 | |||
| 77 | //@} | ||
| 78 | /** @name Setters */ | ||
| 79 | //@{ | ||
| 80 | |||
| 81 | // cppcheck-suppress functionStatic | ||
| 82 | OS_DEPRECATED(3, 2, 0) bool setSolarAndDaylightingMethod(const std::string& solarAndDaylightingMethod); | ||
| 83 | |||
| 84 | // cppcheck-suppress functionStatic | ||
| 85 | OS_DEPRECATED(3, 2, 0) void resetSolarAndDaylightingMethod(); | ||
| 86 | |||
| 87 | // cppcheck-suppress functionStatic | ||
| 88 | OS_DEPRECATED(3, 2, 0) bool setRadiantExchangeMethod(const std::string& radiantExchangeMethod); | ||
| 89 | |||
| 90 | // cppcheck-suppress functionStatic | ||
| 91 | OS_DEPRECATED(3, 2, 0) void resetRadiantExchangeMethod(); | ||
| 92 | |||
| 93 | bool setAirExchangeMethod(const std::string& airExchangeMethod); | ||
| 94 | |||
| 95 | void resetAirExchangeMethod(); | ||
| 96 | |||
| 97 | bool setSimpleMixingAirChangesPerHour(double simpleMixingAirChangesPerHour); | ||
| 98 | |||
| 99 | void resetSimpleMixingAirChangesPerHour(); | ||
| 100 | |||
| 101 | bool setSimpleMixingSchedule(Schedule& schedule); | ||
| 102 | |||
| 103 | void resetSimpleMixingSchedule(); | ||
| 104 | |||
| 105 | //@} | ||
| 106 | /** @name Other */ | ||
| 107 | //@{ | ||
| 108 | |||
| 109 | //@} | ||
| 110 | protected: | ||
| 111 | /// @cond | ||
| 112 | using ImplType = detail::ConstructionAirBoundary_Impl; | ||
| 113 | |||
| 114 | explicit ConstructionAirBoundary(std::shared_ptr<detail::ConstructionAirBoundary_Impl> impl); | ||
| 115 | |||
| 116 | friend class detail::ConstructionAirBoundary_Impl; | ||
| 117 | friend class Model; | ||
| 118 | friend class IdfObject; | ||
| 119 | friend class openstudio::detail::IdfObject_Impl; | ||
| 120 | /// @endcond | ||
| 121 | private: | ||
| 122 | − | REGISTER_LOGGER("openstudio.model.ConstructionAirBoundary"); | |
| 123 | }; | ||
| 124 | |||
| 125 | /** \relates ConstructionAirBoundary*/ | ||
| 126 | using OptionalConstructionAirBoundary = boost::optional<ConstructionAirBoundary>; | ||
| 127 | |||
| 128 | /** \relates ConstructionAirBoundary*/ | ||
| 129 | using ConstructionAirBoundaryVector = std::vector<ConstructionAirBoundary>; | ||
| 130 | |||
| 131 | } // namespace model | ||
| 132 | } // namespace openstudio | ||
| 133 | |||
| 134 | #endif // MODEL_CONSTRUCTIONAIRBOUNDARY_HPP | ||
| 135 |