src/model/SurfacePropertyConvectionCoefficientsMultipleSurface.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_SURFACEPROPERTYCONVECTIONCOEFFICIENTSMULTIPLESURFACE_HPP | ||
| 7 | #define MODEL_SURFACEPROPERTYCONVECTIONCOEFFICIENTSMULTIPLESURFACE_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | class SurfacePropertyConvectionCoefficientsMultipleSurface_Impl; | ||
| 21 | |||
| 22 | } // namespace detail | ||
| 23 | |||
| 24 | /** SurfacePropertyConvectionCoefficientsMultipleSurface is a ModelObject that wraps the OpenStudio IDD object 'OS:SurfaceProperty:ConvectionCoefficients:MultipleSurface'. */ | ||
| 25 | class MODEL_API SurfacePropertyConvectionCoefficientsMultipleSurface : public ModelObject | ||
| 26 | { | ||
| 27 | public: | ||
| 28 | /** @name Constructors and Destructors */ | ||
| 29 | //@{ | ||
| 30 | |||
| 31 | explicit SurfacePropertyConvectionCoefficientsMultipleSurface(const Model& model); | ||
| 32 | |||
| 33 | 1 | virtual ~SurfacePropertyConvectionCoefficientsMultipleSurface() override = default; | |
| 34 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 35 | ✗ | SurfacePropertyConvectionCoefficientsMultipleSurface(const SurfacePropertyConvectionCoefficientsMultipleSurface& other) = default; | |
| 36 | ✗ | SurfacePropertyConvectionCoefficientsMultipleSurface(SurfacePropertyConvectionCoefficientsMultipleSurface&& other) = default; | |
| 37 | ✗ | SurfacePropertyConvectionCoefficientsMultipleSurface& operator=(const SurfacePropertyConvectionCoefficientsMultipleSurface&) = default; | |
| 38 | ✗ | SurfacePropertyConvectionCoefficientsMultipleSurface& operator=(SurfacePropertyConvectionCoefficientsMultipleSurface&&) = default; | |
| 39 | |||
| 40 | //@} | ||
| 41 | |||
| 42 | static IddObjectType iddObjectType(); | ||
| 43 | |||
| 44 | static std::vector<std::string> surfaceTypeValues(); | ||
| 45 | |||
| 46 | static std::vector<std::string> convectionCoefficient1LocationValues(); | ||
| 47 | |||
| 48 | static std::vector<std::string> convectionCoefficient1TypeValues(); | ||
| 49 | |||
| 50 | static std::vector<std::string> convectionCoefficient2LocationValues(); | ||
| 51 | |||
| 52 | static std::vector<std::string> convectionCoefficient2TypeValues(); | ||
| 53 | |||
| 54 | /** @name Getters */ | ||
| 55 | //@{ | ||
| 56 | |||
| 57 | boost::optional<std::string> surfaceType() const; | ||
| 58 | |||
| 59 | boost::optional<std::string> convectionCoefficient1Location() const; | ||
| 60 | |||
| 61 | boost::optional<std::string> convectionCoefficient1Type() const; | ||
| 62 | |||
| 63 | boost::optional<double> convectionCoefficient1() const; | ||
| 64 | |||
| 65 | boost::optional<Schedule> convectionCoefficient1Schedule() const; | ||
| 66 | |||
| 67 | // DLM: not supporting user curves yet | ||
| 68 | //boost::optional<UserConvectionModels> convectionCoefficient1UserCurve() const; | ||
| 69 | |||
| 70 | boost::optional<std::string> convectionCoefficient2Location() const; | ||
| 71 | |||
| 72 | boost::optional<std::string> convectionCoefficient2Type() const; | ||
| 73 | |||
| 74 | boost::optional<double> convectionCoefficient2() const; | ||
| 75 | |||
| 76 | boost::optional<Schedule> convectionCoefficient2Schedule() const; | ||
| 77 | |||
| 78 | // DLM: not supporting user curves yet | ||
| 79 | //boost::optional<UserConvectionModels> convectionCoefficient2UserCurve() const; | ||
| 80 | |||
| 81 | //@} | ||
| 82 | /** @name Setters */ | ||
| 83 | //@{ | ||
| 84 | |||
| 85 | bool setSurfaceType(const std::string& surfaceType); | ||
| 86 | |||
| 87 | void resetSurfaceType(); | ||
| 88 | |||
| 89 | bool setConvectionCoefficient1Location(const std::string& convectionCoefficient1Location); | ||
| 90 | |||
| 91 | void resetConvectionCoefficient1Location(); | ||
| 92 | |||
| 93 | bool setConvectionCoefficient1Type(const std::string& convectionCoefficient1Type); | ||
| 94 | |||
| 95 | void resetConvectionCoefficient1Type(); | ||
| 96 | |||
| 97 | bool setConvectionCoefficient1(double convectionCoefficient1); | ||
| 98 | |||
| 99 | void resetConvectionCoefficient1(); | ||
| 100 | |||
| 101 | bool setConvectionCoefficient1Schedule(Schedule& schedule); | ||
| 102 | |||
| 103 | void resetConvectionCoefficient1Schedule(); | ||
| 104 | |||
| 105 | // DLM: not supporting user curves yet | ||
| 106 | //bool setConvectionCoefficient1UserCurve(const UserConvectionModels& userConvectionModels); | ||
| 107 | |||
| 108 | //void resetConvectionCoefficient1UserCurve(); | ||
| 109 | |||
| 110 | bool setConvectionCoefficient2Location(const std::string& convectionCoefficient2Location); | ||
| 111 | |||
| 112 | void resetConvectionCoefficient2Location(); | ||
| 113 | |||
| 114 | bool setConvectionCoefficient2Type(const std::string& convectionCoefficient2Type); | ||
| 115 | |||
| 116 | void resetConvectionCoefficient2Type(); | ||
| 117 | |||
| 118 | bool setConvectionCoefficient2(double convectionCoefficient2); | ||
| 119 | |||
| 120 | void resetConvectionCoefficient2(); | ||
| 121 | |||
| 122 | bool setConvectionCoefficient2Schedule(Schedule& schedule); | ||
| 123 | |||
| 124 | void resetConvectionCoefficient2Schedule(); | ||
| 125 | |||
| 126 | // DLM: not supporting user curves yet | ||
| 127 | //bool setConvectionCoefficient2UserCurve(const UserConvectionModels& userConvectionModels); | ||
| 128 | |||
| 129 | //void resetConvectionCoefficient2UserCurve(); | ||
| 130 | |||
| 131 | //@} | ||
| 132 | /** @name Other */ | ||
| 133 | //@{ | ||
| 134 | |||
| 135 | //@} | ||
| 136 | protected: | ||
| 137 | /// @cond | ||
| 138 | using ImplType = detail::SurfacePropertyConvectionCoefficientsMultipleSurface_Impl; | ||
| 139 | |||
| 140 | explicit SurfacePropertyConvectionCoefficientsMultipleSurface( | ||
| 141 | std::shared_ptr<detail::SurfacePropertyConvectionCoefficientsMultipleSurface_Impl> impl); | ||
| 142 | |||
| 143 | friend class detail::SurfacePropertyConvectionCoefficientsMultipleSurface_Impl; | ||
| 144 | friend class Model; | ||
| 145 | friend class IdfObject; | ||
| 146 | friend class openstudio::detail::IdfObject_Impl; | ||
| 147 | /// @endcond | ||
| 148 | private: | ||
| 149 | REGISTER_LOGGER("openstudio.model.SurfacePropertyConvectionCoefficientsMultipleSurface"); | ||
| 150 | }; | ||
| 151 | |||
| 152 | /** \relates SurfacePropertyConvectionCoefficientsMultipleSurface*/ | ||
| 153 | using OptionalSurfacePropertyConvectionCoefficientsMultipleSurface = boost::optional<SurfacePropertyConvectionCoefficientsMultipleSurface>; | ||
| 154 | |||
| 155 | /** \relates SurfacePropertyConvectionCoefficientsMultipleSurface*/ | ||
| 156 | using SurfacePropertyConvectionCoefficientsMultipleSurfaceVector = std::vector<SurfacePropertyConvectionCoefficientsMultipleSurface>; | ||
| 157 | |||
| 158 | } // namespace model | ||
| 159 | } // namespace openstudio | ||
| 160 | |||
| 161 | #endif // MODEL_SURFACEPROPERTYCONVECTIONCOEFFICIENTSMULTIPLESURFACE_HPP | ||
| 162 |