src/model/SiteGroundTemperatureFCfactorMethod.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_SITEGROUNDTEMPERATUREFCFACTORMETHOD_HPP | ||
| 7 | #define MODEL_SITEGROUNDTEMPERATUREFCFACTORMETHOD_HPP | ||
| 8 | |||
| 9 | #include <vector> | ||
| 10 | #include "ModelAPI.hpp" | ||
| 11 | #include "ModelObject.hpp" | ||
| 12 | #include "../utilities/time/Date.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | namespace model { | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | class SiteGroundTemperatureFCfactorMethod_Impl; | ||
| 20 | |||
| 21 | } // namespace detail | ||
| 22 | |||
| 23 | /** SiteGroundTemperatureFCfactorMethod is a ModelObject that wraps the OpenStudio IDD object 'OS_Site_GroundTemperature_FCfactorMethod'. */ | ||
| 24 | class MODEL_API SiteGroundTemperatureFCfactorMethod : public ModelObject | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | 17 | virtual ~SiteGroundTemperatureFCfactorMethod() override = default; | |
| 31 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 32 | ✗ | SiteGroundTemperatureFCfactorMethod(const SiteGroundTemperatureFCfactorMethod& other) = default; | |
| 33 | 3 | SiteGroundTemperatureFCfactorMethod(SiteGroundTemperatureFCfactorMethod&& other) = default; | |
| 34 | ✗ | SiteGroundTemperatureFCfactorMethod& operator=(const SiteGroundTemperatureFCfactorMethod&) = default; | |
| 35 | ✗ | SiteGroundTemperatureFCfactorMethod& operator=(SiteGroundTemperatureFCfactorMethod&&) = default; | |
| 36 | |||
| 37 | //@} | ||
| 38 | /** @name Static Methods */ | ||
| 39 | //@{ | ||
| 40 | |||
| 41 | static IddObjectType iddObjectType(); | ||
| 42 | |||
| 43 | //@} | ||
| 44 | /** @name Getters */ | ||
| 45 | //@{ | ||
| 46 | |||
| 47 | double januaryGroundTemperature() const; | ||
| 48 | |||
| 49 | bool isJanuaryGroundTemperatureDefaulted() const; | ||
| 50 | |||
| 51 | double februaryGroundTemperature() const; | ||
| 52 | |||
| 53 | bool isFebruaryGroundTemperatureDefaulted() const; | ||
| 54 | |||
| 55 | double marchGroundTemperature() const; | ||
| 56 | |||
| 57 | bool isMarchGroundTemperatureDefaulted() const; | ||
| 58 | |||
| 59 | double aprilGroundTemperature() const; | ||
| 60 | |||
| 61 | bool isAprilGroundTemperatureDefaulted() const; | ||
| 62 | |||
| 63 | double mayGroundTemperature() const; | ||
| 64 | |||
| 65 | bool isMayGroundTemperatureDefaulted() const; | ||
| 66 | |||
| 67 | double juneGroundTemperature() const; | ||
| 68 | |||
| 69 | bool isJuneGroundTemperatureDefaulted() const; | ||
| 70 | |||
| 71 | double julyGroundTemperature() const; | ||
| 72 | |||
| 73 | bool isJulyGroundTemperatureDefaulted() const; | ||
| 74 | |||
| 75 | double augustGroundTemperature() const; | ||
| 76 | |||
| 77 | bool isAugustGroundTemperatureDefaulted() const; | ||
| 78 | |||
| 79 | double septemberGroundTemperature() const; | ||
| 80 | |||
| 81 | bool isSeptemberGroundTemperatureDefaulted() const; | ||
| 82 | |||
| 83 | double octoberGroundTemperature() const; | ||
| 84 | |||
| 85 | bool isOctoberGroundTemperatureDefaulted() const; | ||
| 86 | |||
| 87 | double novemberGroundTemperature() const; | ||
| 88 | |||
| 89 | bool isNovemberGroundTemperatureDefaulted() const; | ||
| 90 | |||
| 91 | double decemberGroundTemperature() const; | ||
| 92 | |||
| 93 | bool isDecemberGroundTemperatureDefaulted() const; | ||
| 94 | |||
| 95 | double getTemperatureByMonth(int month) const; | ||
| 96 | |||
| 97 | double getTemperatureByMonth(const openstudio::MonthOfYear& month) const; | ||
| 98 | |||
| 99 | bool isMonthDefaulted(int month) const; | ||
| 100 | |||
| 101 | bool isMonthDefaulted(const openstudio::MonthOfYear& month) const; | ||
| 102 | |||
| 103 | std::vector<double> getAllMonthlyTemperatures() const; | ||
| 104 | |||
| 105 | //@} | ||
| 106 | /** @name Setters */ | ||
| 107 | //@{ | ||
| 108 | |||
| 109 | bool setJanuaryGroundTemperature(double januaryGroundTemperature); | ||
| 110 | |||
| 111 | void resetJanuaryGroundTemperature(); | ||
| 112 | |||
| 113 | bool setFebruaryGroundTemperature(double februaryGroundTemperature); | ||
| 114 | |||
| 115 | void resetFebruaryGroundTemperature(); | ||
| 116 | |||
| 117 | bool setMarchGroundTemperature(double marchGroundTemperature); | ||
| 118 | |||
| 119 | void resetMarchGroundTemperature(); | ||
| 120 | |||
| 121 | bool setAprilGroundTemperature(double aprilGroundTemperature); | ||
| 122 | |||
| 123 | void resetAprilGroundTemperature(); | ||
| 124 | |||
| 125 | bool setMayGroundTemperature(double mayGroundTemperature); | ||
| 126 | |||
| 127 | void resetMayGroundTemperature(); | ||
| 128 | |||
| 129 | bool setJuneGroundTemperature(double juneGroundTemperature); | ||
| 130 | |||
| 131 | void resetJuneGroundTemperature(); | ||
| 132 | |||
| 133 | bool setJulyGroundTemperature(double julyGroundTemperature); | ||
| 134 | |||
| 135 | void resetJulyGroundTemperature(); | ||
| 136 | |||
| 137 | bool setAugustGroundTemperature(double augustGroundTemperature); | ||
| 138 | |||
| 139 | void resetAugustGroundTemperature(); | ||
| 140 | |||
| 141 | bool setSeptemberGroundTemperature(double septemberGroundTemperature); | ||
| 142 | |||
| 143 | void resetSeptemberGroundTemperature(); | ||
| 144 | |||
| 145 | bool setOctoberGroundTemperature(double octoberGroundTemperature); | ||
| 146 | |||
| 147 | void resetOctoberGroundTemperature(); | ||
| 148 | |||
| 149 | bool setNovemberGroundTemperature(double novemberGroundTemperature); | ||
| 150 | |||
| 151 | void resetNovemberGroundTemperature(); | ||
| 152 | |||
| 153 | bool setDecemberGroundTemperature(double decemberGroundTemperature); | ||
| 154 | |||
| 155 | void resetDecemberGroundTemperature(); | ||
| 156 | |||
| 157 | bool setTemperatureByMonth(int month, double temperature); | ||
| 158 | |||
| 159 | bool setTemperatureByMonth(const openstudio::MonthOfYear& month, double temperature); | ||
| 160 | |||
| 161 | void resetTemperatureByMonth(int month); | ||
| 162 | |||
| 163 | void resetTemperatureByMonth(const openstudio::MonthOfYear& month); | ||
| 164 | |||
| 165 | void resetAllMonths(); | ||
| 166 | |||
| 167 | bool setAllMonthlyTemperatures(const std::vector<double>& monthly_temperatures); | ||
| 168 | |||
| 169 | //@} | ||
| 170 | protected: | ||
| 171 | /// @cond | ||
| 172 | using ImplType = detail::SiteGroundTemperatureFCfactorMethod_Impl; | ||
| 173 | |||
| 174 | friend class Model; | ||
| 175 | friend class openstudio::IdfObject; | ||
| 176 | friend class detail::SiteGroundTemperatureFCfactorMethod_Impl; | ||
| 177 | |||
| 178 | explicit SiteGroundTemperatureFCfactorMethod(std::shared_ptr<detail::SiteGroundTemperatureFCfactorMethod_Impl> impl); | ||
| 179 | |||
| 180 | explicit SiteGroundTemperatureFCfactorMethod(Model& model); | ||
| 181 | |||
| 182 | /// @endcond | ||
| 183 | private: | ||
| 184 | REGISTER_LOGGER("openstudio.model.SiteGroundTemperatureFCfactorMethod"); | ||
| 185 | }; | ||
| 186 | |||
| 187 | /** \relates SiteGroundTemperatureFCfactorMethod*/ | ||
| 188 | using OptionalSiteGroundTemperatureFCfactorMethod = boost::optional<SiteGroundTemperatureFCfactorMethod>; | ||
| 189 | |||
| 190 | /** \relates SiteGroundTemperatureFCfactorMethod*/ | ||
| 191 | using SiteGroundTemperatureFCfactorMethodVector = std::vector<SiteGroundTemperatureFCfactorMethod>; | ||
| 192 | |||
| 193 | } // namespace model | ||
| 194 | } // namespace openstudio | ||
| 195 | |||
| 196 | #endif // MODEL_SITEGROUNDTEMPERATUREFCFACTORMETHOD_HPP | ||
| 197 |