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