GCC Code Coverage Report


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

src/model/HeatBalanceAlgorithm_Impl.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_HEATBALANCEALGORITHM_IMPL_HPP
7 #define MODEL_HEATBALANCEALGORITHM_IMPL_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ModelObject_Impl.hpp"
11
12 namespace openstudio {
13 namespace model {
14
15 namespace detail {
16
17 /** HeatBalanceAlgorithm_Impl is a ModelObject_Impl that is the implementation class for HeatBalanceAlgorithm.*/
18 class MODEL_API HeatBalanceAlgorithm_Impl : public ModelObject_Impl
19 {
20
21 public:
22 /** @name Constructors and Destructors */
23 //@{
24
25 // constructor
26 HeatBalanceAlgorithm_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle);
27
28 // construct from workspace
29 HeatBalanceAlgorithm_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle);
30
31 // clone copy constructor
32 HeatBalanceAlgorithm_Impl(const HeatBalanceAlgorithm_Impl& other, Model_Impl* model, bool keepHandle);
33
34 // virtual destructor
35 488 virtual ~HeatBalanceAlgorithm_Impl() override = default;
36
37 // return the parent object in the hierarchy
38 virtual boost::optional<ParentObject> parent() const override;
39
40 // set the parent, child may have to call methods on the parent
41 virtual bool setParent(ParentObject& newParent) override;
42
43 //@}
44
45 /** @name Virtual Methods */
46 //@{
47
48 // Get all output variable names that could be associated with this object.
49 virtual const std::vector<std::string>& outputVariableNames() const override;
50
51 virtual IddObjectType iddObjectType() const override;
52
53 //@}
54 /** @name Getters */
55 //@{
56
57 std::string algorithm() const;
58
59 bool isAlgorithmDefaulted() const;
60
61 double surfaceTemperatureUpperLimit() const;
62
63 bool isSurfaceTemperatureUpperLimitDefaulted() const;
64
65 double minimumSurfaceConvectionHeatTransferCoefficientValue() const;
66
67 bool isMinimumSurfaceConvectionHeatTransferCoefficientValueDefaulted() const;
68
69 double maximumSurfaceConvectionHeatTransferCoefficientValue() const;
70
71 bool isMaximumSurfaceConvectionHeatTransferCoefficientValueDefaulted() const;
72
73 //@}
74 /** @name Setters */
75 //@{
76
77 bool setAlgorithm(const std::string& algorithm);
78
79 void resetAlgorithm();
80
81 bool setSurfaceTemperatureUpperLimit(double surfaceTemperatureUpperLimit);
82
83 void resetSurfaceTemperatureUpperLimit();
84
85 bool setMinimumSurfaceConvectionHeatTransferCoefficientValue(double minimumSurfaceConvectionHeatTransferCoefficientValue);
86
87 void resetMinimumSurfaceConvectionHeatTransferCoefficientValue();
88
89 bool setMaximumSurfaceConvectionHeatTransferCoefficientValue(double maximumSurfaceConvectionHeatTransferCoefficientValue);
90
91 void resetMaximumSurfaceConvectionHeatTransferCoefficientValue();
92
93 //@}
94 /** @name Other */
95 //@{
96
97 //@}
98 protected:
99 private:
100 REGISTER_LOGGER("openstudio.model.HeatBalanceAlgorithm");
101
102 std::vector<std::string> algorithmValues() const;
103 };
104
105 } // namespace detail
106
107 } // namespace model
108 } // namespace openstudio
109
110 #endif // MODEL_HEATBALANCEALGORITHM_IMPL_HPP
111