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/InsideSurfaceConvectionAlgorithm.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_INSIDESURFACECONVECTIONALGORITHM_HPP
7 #define MODEL_INSIDESURFACECONVECTIONALGORITHM_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ModelObject.hpp"
11
12 namespace openstudio {
13 namespace model {
14
15 namespace detail {
16 class InsideSurfaceConvectionAlgorithm_Impl;
17 } // namespace detail
18
19 /** InsideSurfaceConvectionAlgorithm derives from ModelObject and is an interface to the OpenStudio IDD object named "SurfaceConvectionAlgorithm:Inside".
20 *
21 * InsideSurfaceConvectionAlgorithm is a unique object that specifies the global model used for surface convection at the inside face of all the
22 * heat transfer surfaces in the model. This global algorithm may be overridden for specific Surface, SurfaceList, or Zone objects.
23 * InsideSurfaceConvectionAlgorithm does not have a public constructor because it is a unique ModelObject.
24 * To get the InsideSurfaceConvectionAlgorithm object for a Model or create one if it does not yet exist use model.getUniqueObject<InsideSurfaceConvectionAlgorithm>().
25 * To get the InsideSurfaceConvectionAlgorithm object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<InsideSurfaceConvectionAlgorithm>().
26 */
27 class MODEL_API InsideSurfaceConvectionAlgorithm : public ModelObject
28 {
29 public:
30 345 virtual ~InsideSurfaceConvectionAlgorithm() override = default;
31 // Default the copy and move operators because the virtual dtor is explicit
32 ✗ InsideSurfaceConvectionAlgorithm(const InsideSurfaceConvectionAlgorithm& other) = default;
33 65 InsideSurfaceConvectionAlgorithm(InsideSurfaceConvectionAlgorithm&& other) = default;
34 ✗ InsideSurfaceConvectionAlgorithm& operator=(const InsideSurfaceConvectionAlgorithm&) = default;
35 ✗ InsideSurfaceConvectionAlgorithm& operator=(InsideSurfaceConvectionAlgorithm&&) = default;
36
37 /** @name Static Methods */
38 //@{
39
40 static IddObjectType iddObjectType();
41
42 static std::vector<std::string> validAlgorithmValues();
43
44 //@}
45 /** @name Getters */
46 //@{
47
48 std::string algorithm() const;
49
50 bool isAlgorithmDefaulted() const;
51
52 //@}
53 /** @name Setters */
54 //@{
55
56 bool setAlgorithm(const std::string& algorithm);
57
58 void resetAlgorithm();
59
60 //@}
61
62 protected:
63 /** @name Constructors and Destructors */
64 //@{
65
66 /// Constructs a new InsideSurfaceConvectionAlgorithm object in the model.
67 explicit InsideSurfaceConvectionAlgorithm(const Model& model);
68
69 //@}
70
71 /// @cond
72
73 using ImplType = detail::InsideSurfaceConvectionAlgorithm_Impl;
74
75 friend class Model;
76 friend class openstudio::IdfObject;
77
78 // constructor
79 explicit InsideSurfaceConvectionAlgorithm(std::shared_ptr<detail::InsideSurfaceConvectionAlgorithm_Impl> impl);
80
81 private:
82 REGISTER_LOGGER("openstudio.model.InsideSurfaceConvectionAlgorithm");
83
84 /// @endcond
85 };
86
87 /** \relates InsideSurfaceConvectionAlgorithm */
88 using OptionalInsideSurfaceConvectionAlgorithm = boost::optional<InsideSurfaceConvectionAlgorithm>;
89
90 } // namespace model
91 } // namespace openstudio
92
93 #endif // MODEL_INSIDESURFACECONVECTIONALGORITHM_HPP
94