src/model/SiteGroundTemperatureUndisturbedXing.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_SITEGROUNDTEMPERATUREUNDISTURBEDXING_HPP | ||
| 7 | #define MODEL_SITEGROUNDTEMPERATUREUNDISTURBEDXING_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 SiteGroundTemperatureUndisturbedXing_Impl; | ||
| 20 | |||
| 21 | } // namespace detail | ||
| 22 | |||
| 23 | /** SiteGroundTemperatureUndisturbedXing is a ModelObject that wraps the OpenStudio IDD object 'OS_Site_GroundTemperature_UndisturbedXing'. */ | ||
| 24 | class MODEL_API SiteGroundTemperatureUndisturbedXing : public ModelObject | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | explicit SiteGroundTemperatureUndisturbedXing(const Model& model); | ||
| 31 | |||
| 32 | 33 | virtual ~SiteGroundTemperatureUndisturbedXing() override = default; | |
| 33 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 34 | ✗ | SiteGroundTemperatureUndisturbedXing(const SiteGroundTemperatureUndisturbedXing& other) = default; | |
| 35 | 12 | SiteGroundTemperatureUndisturbedXing(SiteGroundTemperatureUndisturbedXing&& other) = default; | |
| 36 | ✗ | SiteGroundTemperatureUndisturbedXing& operator=(const SiteGroundTemperatureUndisturbedXing&) = default; | |
| 37 | ✗ | SiteGroundTemperatureUndisturbedXing& operator=(SiteGroundTemperatureUndisturbedXing&&) = default; | |
| 38 | |||
| 39 | //@} | ||
| 40 | /** @name Static Methods */ | ||
| 41 | //@{ | ||
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | //@} | ||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | double soilThermalConductivity() const; | ||
| 50 | |||
| 51 | double soilDensity() const; | ||
| 52 | |||
| 53 | double soilSpecificHeat() const; | ||
| 54 | |||
| 55 | double averageSoilSurfaceTemperature() const; | ||
| 56 | |||
| 57 | double soilSurfaceTemperatureAmplitude1() const; | ||
| 58 | |||
| 59 | double soilSurfaceTemperatureAmplitude2() const; | ||
| 60 | |||
| 61 | double phaseShiftofTemperatureAmplitude1() const; | ||
| 62 | |||
| 63 | double phaseShiftofTemperatureAmplitude2() const; | ||
| 64 | |||
| 65 | //@} | ||
| 66 | /** @name Setters */ | ||
| 67 | //@{ | ||
| 68 | |||
| 69 | bool setSoilThermalConductivity(double soilThermalConductivity); | ||
| 70 | |||
| 71 | bool setSoilDensity(double soilDensity); | ||
| 72 | |||
| 73 | bool setSoilSpecificHeat(double soilSpecificHeat); | ||
| 74 | |||
| 75 | bool setAverageSoilSurfaceTemperature(double averageSoilSurfaceTemperature); | ||
| 76 | |||
| 77 | bool setSoilSurfaceTemperatureAmplitude1(double soilSurfaceTemperatureAmplitude1); | ||
| 78 | |||
| 79 | bool setSoilSurfaceTemperatureAmplitude2(double soilSurfaceTemperatureAmplitude2); | ||
| 80 | |||
| 81 | bool setPhaseShiftofTemperatureAmplitude1(double phaseShiftofTemperatureAmplitude1); | ||
| 82 | |||
| 83 | bool setPhaseShiftofTemperatureAmplitude2(double phaseShiftofTemperatureAmplitude2); | ||
| 84 | |||
| 85 | //@} | ||
| 86 | protected: | ||
| 87 | /// @cond | ||
| 88 | using ImplType = detail::SiteGroundTemperatureUndisturbedXing_Impl; | ||
| 89 | |||
| 90 | friend class Model; | ||
| 91 | friend class openstudio::IdfObject; | ||
| 92 | friend class detail::SiteGroundTemperatureUndisturbedXing_Impl; | ||
| 93 | |||
| 94 | explicit SiteGroundTemperatureUndisturbedXing(std::shared_ptr<detail::SiteGroundTemperatureUndisturbedXing_Impl> impl); | ||
| 95 | |||
| 96 | /// @endcond | ||
| 97 | private: | ||
| 98 | REGISTER_LOGGER("openstudio.model.SiteGroundTemperatureUndisturbedXing"); | ||
| 99 | }; | ||
| 100 | |||
| 101 | /** \relates SiteGroundTemperatureUndisturbedXing*/ | ||
| 102 | using OptionalSiteGroundTemperatureUndisturbedXing = boost::optional<SiteGroundTemperatureUndisturbedXing>; | ||
| 103 | |||
| 104 | /** \relates SiteGroundTemperatureUndisturbedXing*/ | ||
| 105 | using SiteGroundTemperatureUndisturbedXingVector = std::vector<SiteGroundTemperatureUndisturbedXing>; | ||
| 106 | |||
| 107 | } // namespace model | ||
| 108 | } // namespace openstudio | ||
| 109 | |||
| 110 | #endif // MODEL_SITEGROUNDTEMPERATUREUNDISTURBEDXING_HPP | ||
| 111 |