GCC Code Coverage Report


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

src/model/SizingParameters.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_SIZINGPARAMETERS_HPP
7 #define MODEL_SIZINGPARAMETERS_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ModelObject.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 namespace detail {
17
18 class SizingParameters_Impl;
19
20 } // namespace detail
21
22 /** SizingParameters is a ModelObject that wraps the OpenStudio IDD object 'OS:Sizing:Parameters'. */
23 class MODEL_API SizingParameters : public ModelObject
24 {
25 public:
26 /** @name Constructors and Destructors */
27 //@{
28
29 2756 virtual ~SizingParameters() override = default;
30 // Default the copy and move operators because the virtual dtor is explicit
31 ✗ SizingParameters(const SizingParameters& other) = default;
32 885 SizingParameters(SizingParameters&& other) = default;
33 ✗ SizingParameters& operator=(const SizingParameters&) = default;
34 ✗ SizingParameters& operator=(SizingParameters&&) = default;
35
36 //@}
37 /** @name Static Methods */
38 //@{
39
40 static IddObjectType iddObjectType();
41
42 //@}
43 /** @name Getters */
44 //@{
45
46 double heatingSizingFactor() const;
47
48 bool isHeatingSizingFactorDefaulted() const;
49
50 double coolingSizingFactor() const;
51
52 bool isCoolingSizingFactorDefaulted() const;
53
54 boost::optional<int> timestepsinAveragingWindow() const;
55
56 //@}
57 /** @name Setters */
58 //@{
59
60 bool setHeatingSizingFactor(double heatingSizingFactor);
61
62 void resetHeatingSizingFactor();
63
64 bool setCoolingSizingFactor(double coolingSizingFactor);
65
66 void resetCoolingSizingFactor();
67
68 bool setTimestepsinAveragingWindow(int timestepsinAveragingWindow);
69
70 void resetTimestepsinAveragingWindow();
71
72 //@}
73 /** @name Other */
74 //@{
75
76 //@}
77 protected:
78 /// @cond
79 using ImplType = detail::SizingParameters_Impl;
80
81 explicit SizingParameters(std::shared_ptr<detail::SizingParameters_Impl> impl);
82
83 friend class detail::SizingParameters_Impl;
84 friend class Model;
85 friend class IdfObject;
86 friend class openstudio::detail::IdfObject_Impl;
87 explicit SizingParameters(Model& model);
88
89 /// @endcond
90 private:
91 REGISTER_LOGGER("openstudio.model.SizingParameters");
92 };
93
94 /** \relates SizingParameters*/
95 using OptionalSizingParameters = boost::optional<SizingParameters>;
96
97 /** \relates SizingParameters*/
98 using SizingParametersVector = std::vector<SizingParameters>;
99
100 } // namespace model
101 } // namespace openstudio
102
103 #endif // MODEL_SIZINGPARAMETERS_HPP
104