src/model/SiteGroundReflectance.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_SITEGROUNDREFLECTANCE_HPP | ||
| 7 | #define MODEL_SITEGROUNDREFLECTANCE_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | namespace detail { | ||
| 16 | |||
| 17 | class SiteGroundReflectance_Impl; | ||
| 18 | |||
| 19 | } // namespace detail | ||
| 20 | |||
| 21 | /** SiteGroundReflectance is a ModelObject that wraps the OpenStudio IDD object 'OS:Site:GroundReflectance'. */ | ||
| 22 | |||
| 23 | class MODEL_API SiteGroundReflectance : public ModelObject | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | 13 | virtual ~SiteGroundReflectance() override = default; | |
| 30 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 31 | ✗ | SiteGroundReflectance(const SiteGroundReflectance& other) = default; | |
| 32 | 3 | SiteGroundReflectance(SiteGroundReflectance&& other) = default; | |
| 33 | ✗ | SiteGroundReflectance& operator=(const SiteGroundReflectance&) = default; | |
| 34 | ✗ | SiteGroundReflectance& operator=(SiteGroundReflectance&&) = default; | |
| 35 | |||
| 36 | //@} | ||
| 37 | /** @name Static Methods */ | ||
| 38 | //@{ | ||
| 39 | |||
| 40 | static IddObjectType iddObjectType(); | ||
| 41 | |||
| 42 | //@} | ||
| 43 | /** @name Getters */ | ||
| 44 | //@{ | ||
| 45 | |||
| 46 | double januaryGroundReflectance() const; | ||
| 47 | |||
| 48 | bool isJanuaryGroundReflectanceDefaulted() const; | ||
| 49 | |||
| 50 | double februaryGroundReflectance() const; | ||
| 51 | |||
| 52 | bool isFebruaryGroundReflectanceDefaulted() const; | ||
| 53 | |||
| 54 | double marchGroundReflectance() const; | ||
| 55 | |||
| 56 | bool isMarchGroundReflectanceDefaulted() const; | ||
| 57 | |||
| 58 | double aprilGroundReflectance() const; | ||
| 59 | |||
| 60 | bool isAprilGroundReflectanceDefaulted() const; | ||
| 61 | |||
| 62 | double mayGroundReflectance() const; | ||
| 63 | |||
| 64 | bool isMayGroundReflectanceDefaulted() const; | ||
| 65 | |||
| 66 | double juneGroundReflectance() const; | ||
| 67 | |||
| 68 | bool isJuneGroundReflectanceDefaulted() const; | ||
| 69 | |||
| 70 | double julyGroundReflectance() const; | ||
| 71 | |||
| 72 | bool isJulyGroundReflectanceDefaulted() const; | ||
| 73 | |||
| 74 | double augustGroundReflectance() const; | ||
| 75 | |||
| 76 | bool isAugustGroundReflectanceDefaulted() const; | ||
| 77 | |||
| 78 | double septemberGroundReflectance() const; | ||
| 79 | |||
| 80 | bool isSeptemberGroundReflectanceDefaulted() const; | ||
| 81 | |||
| 82 | double octoberGroundReflectance() const; | ||
| 83 | |||
| 84 | bool isOctoberGroundReflectanceDefaulted() const; | ||
| 85 | |||
| 86 | double novemberGroundReflectance() const; | ||
| 87 | |||
| 88 | bool isNovemberGroundReflectanceDefaulted() const; | ||
| 89 | |||
| 90 | double decemberGroundReflectance() const; | ||
| 91 | |||
| 92 | bool isDecemberGroundReflectanceDefaulted() const; | ||
| 93 | |||
| 94 | //@} | ||
| 95 | /** @name Setters */ | ||
| 96 | //@{ | ||
| 97 | |||
| 98 | bool setJanuaryGroundReflectance(double januaryGroundReflectance); | ||
| 99 | |||
| 100 | void resetJanuaryGroundReflectance(); | ||
| 101 | |||
| 102 | bool setFebruaryGroundReflectance(double februaryGroundReflectance); | ||
| 103 | |||
| 104 | void resetFebruaryGroundReflectance(); | ||
| 105 | |||
| 106 | bool setMarchGroundReflectance(double marchGroundReflectance); | ||
| 107 | |||
| 108 | void resetMarchGroundReflectance(); | ||
| 109 | |||
| 110 | bool setAprilGroundReflectance(double aprilGroundReflectance); | ||
| 111 | |||
| 112 | void resetAprilGroundReflectance(); | ||
| 113 | |||
| 114 | bool setMayGroundReflectance(double mayGroundReflectance); | ||
| 115 | |||
| 116 | void resetMayGroundReflectance(); | ||
| 117 | |||
| 118 | bool setJuneGroundReflectance(double juneGroundReflectance); | ||
| 119 | |||
| 120 | void resetJuneGroundReflectance(); | ||
| 121 | |||
| 122 | bool setJulyGroundReflectance(double julyGroundReflectance); | ||
| 123 | |||
| 124 | void resetJulyGroundReflectance(); | ||
| 125 | |||
| 126 | bool setAugustGroundReflectance(double augustGroundReflectance); | ||
| 127 | |||
| 128 | void resetAugustGroundReflectance(); | ||
| 129 | |||
| 130 | bool setSeptemberGroundReflectance(double septemberGroundReflectance); | ||
| 131 | |||
| 132 | void resetSeptemberGroundReflectance(); | ||
| 133 | |||
| 134 | bool setOctoberGroundReflectance(double octoberGroundReflectance); | ||
| 135 | |||
| 136 | void resetOctoberGroundReflectance(); | ||
| 137 | |||
| 138 | bool setNovemberGroundReflectance(double novemberGroundReflectance); | ||
| 139 | |||
| 140 | void resetNovemberGroundReflectance(); | ||
| 141 | |||
| 142 | bool setDecemberGroundReflectance(double decemberGroundReflectance); | ||
| 143 | |||
| 144 | void resetDecemberGroundReflectance(); | ||
| 145 | |||
| 146 | //@} | ||
| 147 | protected: | ||
| 148 | /// @cond | ||
| 149 | using ImplType = detail::SiteGroundReflectance_Impl; | ||
| 150 | |||
| 151 | friend class Model; | ||
| 152 | friend class openstudio::IdfObject; | ||
| 153 | friend class detail::SiteGroundReflectance_Impl; | ||
| 154 | |||
| 155 | explicit SiteGroundReflectance(std::shared_ptr<detail::SiteGroundReflectance_Impl> impl); | ||
| 156 | |||
| 157 | explicit SiteGroundReflectance(Model& model); | ||
| 158 | |||
| 159 | /// @endcond | ||
| 160 | private: | ||
| 161 | REGISTER_LOGGER("openstudio.model.SiteGroundReflectance"); | ||
| 162 | }; | ||
| 163 | |||
| 164 | /** \relates SiteGroundReflectance*/ | ||
| 165 | using OptionalSiteGroundReflectance = boost::optional<SiteGroundReflectance>; | ||
| 166 | |||
| 167 | /** \relates SiteGroundReflectance*/ | ||
| 168 | using SiteGroundReflectanceVector = std::vector<SiteGroundReflectance>; | ||
| 169 | |||
| 170 | } // namespace model | ||
| 171 | } // namespace openstudio | ||
| 172 | |||
| 173 | #endif // MODEL_SITEGROUNDREFLECTANCE_HPP | ||
| 174 |