GCC Code Coverage Report


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

src/model/AirflowNetworkDuctViewFactors.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_AIRFLOWNETWORKDUCTVIEWFACTORS_HPP
7 #define MODEL_AIRFLOWNETWORKDUCTVIEWFACTORS_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ModelObject.hpp"
11 #include <vector>
12 #include <unordered_map>
13 #include "PlanarSurface.hpp"
14
15 namespace openstudio {
16
17 namespace model {
18
19 class AirflowNetworkLinkage;
20
21 namespace detail {
22
23 class AirflowNetworkDuctViewFactors_Impl;
24
25 } // namespace detail
26
27 /** This class implements a single point of a viewFactors, meant to replace std::pair<PlanarSurface, double> */
28 class MODEL_API ViewFactorData
29 {
30 public:
31 ViewFactorData(const PlanarSurface& s, double y);
32
33 PlanarSurface planarSurface() const;
34 double viewFactor() const;
35
36 private:
37 openstudio::model::PlanarSurface m_planarSurface;
38 double m_viewFactor;
39 };
40
41 // Overload operator<<
42 MODEL_API std::ostream& operator<<(std::ostream& out, const openstudio::model::ViewFactorData& vf);
43
44 /** AirflowNetworkDuctViewFactors is a ModelObject that wraps the OpenStudio IDD object 'OS:AirflowNetworkDuctViewFactors'. */
45 class MODEL_API AirflowNetworkDuctViewFactors : public ModelObject
46 {
47 public:
48 /** @name Constructors and Destructors */
49 //@{
50
51 explicit AirflowNetworkDuctViewFactors(const Model& model);
52
53 1 virtual ~AirflowNetworkDuctViewFactors() override = default;
54 // Default the copy and move operators because the virtual dtor is explicit
55 ✗ AirflowNetworkDuctViewFactors(const AirflowNetworkDuctViewFactors& other) = default;
56 ✗ AirflowNetworkDuctViewFactors(AirflowNetworkDuctViewFactors&& other) = default;
57 ✗ AirflowNetworkDuctViewFactors& operator=(const AirflowNetworkDuctViewFactors&) = default;
58 ✗ AirflowNetworkDuctViewFactors& operator=(AirflowNetworkDuctViewFactors&&) = default;
59
60 //@}
61
62 static IddObjectType iddObjectType();
63
64 /** @name Getters */
65 //@{
66
67 AirflowNetworkLinkage linkage() const;
68
69 double ductSurfaceExposureFraction() const;
70
71 bool isDuctSurfaceExposureFractionDefaulted() const;
72
73 double ductSurfaceEmittance() const;
74
75 bool isDuctSurfaceEmittanceDefaulted() const;
76
77 boost::optional<double> getViewFactor(const PlanarSurface& surf) const;
78
79 std::vector<ViewFactorData> viewFactors() const;
80
81 //std::unordered_map<PlanarSurface, double> viewFactorMap() const;
82
83 //@}
84 /** @name Setters */
85 //@{
86
87 bool setLinkage(const AirflowNetworkLinkage& linkage);
88
89 bool setDuctSurfaceExposureFraction(double ductSurfaceExposureFraction);
90
91 void resetDuctSurfaceExposureFraction();
92
93 bool setDuctSurfaceEmittance(double ductSurfaceEmittance);
94
95 void resetDuctSurfaceEmittance();
96
97 bool setViewFactor(const PlanarSurface& surf, double F);
98 bool removeViewFactor(const PlanarSurface& surf);
99 void resetViewFactors();
100
101 //@}
102 /** @name Other */
103 //@{
104
105 //@}
106 protected:
107 /// @cond
108 using ImplType = detail::AirflowNetworkDuctViewFactors_Impl;
109
110 explicit AirflowNetworkDuctViewFactors(std::shared_ptr<detail::AirflowNetworkDuctViewFactors_Impl> impl);
111
112 friend class detail::AirflowNetworkDuctViewFactors_Impl;
113 friend class Model;
114 friend class IdfObject;
115 friend class openstudio::detail::IdfObject_Impl;
116 /// @endcond
117 private:
118 REGISTER_LOGGER("openstudio.model.AirflowNetworkDuctViewFactors");
119 };
120
121 /** \relates AirflowNetworkDuctViewFactors*/
122 using OptionalAirflowNetworkDuctViewFactors = boost::optional<AirflowNetworkDuctViewFactors>;
123
124 /** \relates AirflowNetworkDuctViewFactors*/
125 using AirflowNetworkDuctViewFactorsVector = std::vector<AirflowNetworkDuctViewFactors>;
126
127 } // namespace model
128 } // namespace openstudio
129
130 #endif // MODEL_AIRFLOWNETWORKDUCTVIEWFACTORS_HPP
131