GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 60.0% 3 / 0 / 5
Functions: 60.0% 3 / 0 / 5
Branches: -% 0 / 0 / 0

src/model/SiteWaterMainsTemperature.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_SITEWATERMAINSTEMPERATURE_HPP
7 #define MODEL_SITEWATERMAINSTEMPERATURE_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ModelObject.hpp"
11
12 namespace openstudio {
13 namespace model {
14
15 class Schedule;
16
17 namespace detail {
18
19 class SiteWaterMainsTemperature_Impl;
20
21 } // namespace detail
22
23 /** SiteWaterMainsTemperature is a ModelObject that wraps the OpenStudio IDD object
24 * 'OS:Site:WaterMainsTemperature'. */
25 class MODEL_API SiteWaterMainsTemperature : public ModelObject
26 {
27 public:
28 /** @name Constructors and Destructors */
29 //@{
30
31 336 virtual ~SiteWaterMainsTemperature() override = default;
32 // Default the copy and move operators because the virtual dtor is explicit
33 18 SiteWaterMainsTemperature(const SiteWaterMainsTemperature& other) = default;
34 48 SiteWaterMainsTemperature(SiteWaterMainsTemperature&& other) = default;
35 ✗ SiteWaterMainsTemperature& operator=(const SiteWaterMainsTemperature&) = default;
36 ✗ SiteWaterMainsTemperature& operator=(SiteWaterMainsTemperature&&) = default;
37
38 //@}
39
40 static IddObjectType iddObjectType();
41
42 static std::vector<std::string> calculationMethodValues();
43
44 /** \deprecated */
45 static std::vector<std::string> validCalculationMethodValues();
46
47 /** @name Getters */
48 //@{
49
50 std::string calculationMethod() const;
51
52 boost::optional<Schedule> temperatureSchedule() const;
53
54 boost::optional<double> annualAverageOutdoorAirTemperature() const;
55
56 boost::optional<double> maximumDifferenceInMonthlyAverageOutdoorAirTemperatures() const;
57
58 double temperatureMultiplier() const;
59
60 double temperatureOffset() const;
61
62 //@}
63 /** @name Setters */
64 //@{
65
66 bool setCalculationMethod(const std::string& calculationMethod);
67
68 /** Also sets calculation method to 'Schedule'. */
69 bool setTemperatureSchedule(Schedule& schedule);
70
71 void resetTemperatureSchedule();
72
73 /** Also sets calculation method to 'Correlation'. */
74 bool setAnnualAverageOutdoorAirTemperature(double annualAverageOutdoorAirTemperature);
75
76 /** Also sets calculation method to 'Correlation'. */
77 void resetAnnualAverageOutdoorAirTemperature();
78
79 /** Also sets calculation method to 'Correlation'. */
80 bool setMaximumDifferenceInMonthlyAverageOutdoorAirTemperatures(double maximumDifferenceInMonthlyAverageOutdoorAirTemperatures);
81
82 /** Also sets calculation method to 'Correlation'. */
83 void resetMaximumDifferenceInMonthlyAverageOutdoorAirTemperatures();
84
85 bool setTemperatureMultiplier(double temperatureMultiplier);
86
87 bool setTemperatureOffset(double temperatureOffset);
88
89 //@}
90 protected:
91 /// @cond
92 using ImplType = detail::SiteWaterMainsTemperature_Impl;
93
94 friend class Model;
95 friend class openstudio::IdfObject;
96 friend class detail::SiteWaterMainsTemperature_Impl;
97
98 explicit SiteWaterMainsTemperature(std::shared_ptr<detail::SiteWaterMainsTemperature_Impl> impl);
99
100 explicit SiteWaterMainsTemperature(const Model& model);
101
102 /// @endcond
103 private:
104 REGISTER_LOGGER("openstudio.model.SiteWaterMainsTemperature");
105 };
106
107 /** \relates SiteWaterMainsTemperature*/
108 using OptionalSiteWaterMainsTemperature = boost::optional<SiteWaterMainsTemperature>;
109
110 /** \relates SiteWaterMainsTemperature*/
111 using SiteWaterMainsTemperatureVector = std::vector<SiteWaterMainsTemperature>;
112
113 } // namespace model
114 } // namespace openstudio
115
116 #endif // MODEL_SITEWATERMAINSTEMPERATURE_HPP
117