src/model/SurfacePropertyConvectionCoefficients_Impl.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_SURFACEPROPERTYCONVECTIONCOEFFICIENTS_IMPL_HPP | ||
| 7 | #define MODEL_SURFACEPROPERTYCONVECTIONCOEFFICIENTS_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Schedule; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | /** SurfacePropertyConvectionCoefficients_Impl is a ModelObject_Impl that is the implementation class for SurfacePropertyConvectionCoefficients.*/ | ||
| 20 | class MODEL_API SurfacePropertyConvectionCoefficients_Impl : public ModelObject_Impl | ||
| 21 | { | ||
| 22 | public: | ||
| 23 | /** @name Constructors and Destructors */ | ||
| 24 | //@{ | ||
| 25 | |||
| 26 | SurfacePropertyConvectionCoefficients_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 27 | |||
| 28 | SurfacePropertyConvectionCoefficients_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | SurfacePropertyConvectionCoefficients_Impl(const SurfacePropertyConvectionCoefficients_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | 17 | virtual ~SurfacePropertyConvectionCoefficients_Impl() override = default; | |
| 33 | |||
| 34 | //@} | ||
| 35 | /** @name Virtual Methods */ | ||
| 36 | //@{ | ||
| 37 | |||
| 38 | virtual ModelObject clone(Model model) const override; | ||
| 39 | |||
| 40 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 41 | |||
| 42 | virtual IddObjectType iddObjectType() const override; | ||
| 43 | |||
| 44 | //@} | ||
| 45 | /** @name Getters */ | ||
| 46 | //@{ | ||
| 47 | |||
| 48 | ModelObject surfaceAsModelObject() const; | ||
| 49 | |||
| 50 | boost::optional<Surface> surfaceAsSurface() const; | ||
| 51 | |||
| 52 | boost::optional<SubSurface> surfaceAsSubSurface() const; | ||
| 53 | |||
| 54 | boost::optional<InternalMass> surfaceAsInternalMass() const; | ||
| 55 | |||
| 56 | boost::optional<std::string> convectionCoefficient1Location() const; | ||
| 57 | |||
| 58 | boost::optional<std::string> convectionCoefficient1Type() const; | ||
| 59 | |||
| 60 | boost::optional<double> convectionCoefficient1() const; | ||
| 61 | |||
| 62 | boost::optional<Schedule> convectionCoefficient1Schedule() const; | ||
| 63 | |||
| 64 | boost::optional<std::string> convectionCoefficient2Location() const; | ||
| 65 | |||
| 66 | boost::optional<std::string> convectionCoefficient2Type() const; | ||
| 67 | |||
| 68 | boost::optional<double> convectionCoefficient2() const; | ||
| 69 | |||
| 70 | boost::optional<Schedule> convectionCoefficient2Schedule() const; | ||
| 71 | |||
| 72 | //@} | ||
| 73 | /** @name Setters */ | ||
| 74 | //@{ | ||
| 75 | |||
| 76 | bool setSurface(const ModelObject& surface); | ||
| 77 | |||
| 78 | bool setConvectionCoefficient1Location(const std::string& convectionCoefficient1Location); | ||
| 79 | |||
| 80 | void resetConvectionCoefficient1Location(); | ||
| 81 | |||
| 82 | bool setConvectionCoefficient1Type(const std::string& convectionCoefficient1Type); | ||
| 83 | |||
| 84 | void resetConvectionCoefficient1Type(); | ||
| 85 | |||
| 86 | bool setConvectionCoefficient1(double convectionCoefficient1); | ||
| 87 | |||
| 88 | void resetConvectionCoefficient1(); | ||
| 89 | |||
| 90 | bool setConvectionCoefficient1Schedule(Schedule& schedule); | ||
| 91 | |||
| 92 | void resetConvectionCoefficient1Schedule(); | ||
| 93 | |||
| 94 | bool setConvectionCoefficient2Location(const std::string& convectionCoefficient2Location); | ||
| 95 | |||
| 96 | void resetConvectionCoefficient2Location(); | ||
| 97 | |||
| 98 | bool setConvectionCoefficient2Type(const std::string& convectionCoefficient2Type); | ||
| 99 | |||
| 100 | void resetConvectionCoefficient2Type(); | ||
| 101 | |||
| 102 | bool setConvectionCoefficient2(double convectionCoefficient2); | ||
| 103 | |||
| 104 | void resetConvectionCoefficient2(); | ||
| 105 | |||
| 106 | bool setConvectionCoefficient2Schedule(Schedule& schedule); | ||
| 107 | |||
| 108 | void resetConvectionCoefficient2Schedule(); | ||
| 109 | |||
| 110 | //@} | ||
| 111 | /** @name Other */ | ||
| 112 | //@{ | ||
| 113 | |||
| 114 | //@} | ||
| 115 | protected: | ||
| 116 | private: | ||
| 117 | REGISTER_LOGGER("openstudio.model.SurfacePropertyConvectionCoefficients"); | ||
| 118 | }; | ||
| 119 | |||
| 120 | } // namespace detail | ||
| 121 | |||
| 122 | } // namespace model | ||
| 123 | } // namespace openstudio | ||
| 124 | |||
| 125 | #endif // MODEL_SURFACEPROPERTYCONVECTIONCOEFFICIENTS_IMPL_HPP | ||
| 126 |