GCC Code Coverage Report


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

src/model/ConstructionBase_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_CONSTRUCTIONBASE_IMPL_HPP
7 #define MODEL_CONSTRUCTIONBASE_IMPL_HPP
8
9 #include "ResourceObject_Impl.hpp"
10
11 namespace openstudio {
12 namespace model {
13
14 // forward declaration
15 class StandardsInformationConstruction;
16 class RenderingColor;
17
18 namespace detail {
19
20 class MODEL_API ConstructionBase_Impl : public ResourceObject_Impl
21 {
22
23 // may require simulation results.
24
25 // may require simulation results.
26
27 // may require simulation results.
28
29 public:
30 /** @name Constructors and Destructors */
31 //@{
32
33 // Construct completely new object.
34 ConstructionBase_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle);
35
36 // Construct from existing workspace object (typically when Model is being constructed
37 // from Workspace).
38 ConstructionBase_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle);
39
40 // Clone copy constructor.
41 ConstructionBase_Impl(const ConstructionBase_Impl& other, Model_Impl* model, bool keepHandle);
42
43 5988 virtual ~ConstructionBase_Impl() override = default;
44
45 //@}
46 /** @name Getters */
47 //@{
48
49 /** Returns this construction's standards information, constructing a new object if necessary. */
50 StandardsInformationConstruction standardsInformation() const;
51
52 virtual double getNetArea() const;
53
54 // return any children objects in the hierarchy
55 virtual std::vector<ModelObject> children() const override;
56
57 /// get a vector of allowable children types
58 virtual std::vector<IddObjectType> allowableChildTypes() const override;
59
60 //@}
61 /** @name Setters */
62 //@{
63
64 /** Set the u-factor of this surface in W/m^2*K, if possible. value should already include
65 * appropriate film coefficients. By default, assumes still air indoors and 15 mph outdoor air
66 * speed. */
67 virtual bool setUFactor(double value);
68
69 /** Set the u-factor of this surface in W/m^2*K, if possible. filmResistance (m^2*K/W) may be
70 * used to convert value to a conductance. */
71 virtual bool setUFactor(double value, double filmResistance);
72
73 /** Set the conductance of this surface in W/m^2*K, if possible. value should not include any film
74 * coefficients. */
75 virtual bool setConductance(double value);
76
77 /** Set the conductance of this surface in W/m^2*K, if possible. filmResistance (m^2*K/W) may be
78 * used to convert value to a u-factor. */
79 virtual bool setConductance(double value, double filmResistance);
80
81 //@}
82 /** @name Queries */
83 //@{
84
85 virtual bool isOpaque() const = 0;
86
87 virtual bool isFenestration() const = 0;
88
89 virtual bool isSolarDiffusing() const = 0;
90
91 virtual bool isModelPartition() const = 0;
92
93 /** Returns true if the construction has RoofVegetation as the outer layer. */
94 virtual bool isGreenRoof() const;
95
96 /** Get the u-factor of this construction. Includes film coefficients. */
97 virtual boost::optional<double> uFactor() const;
98
99 /** Get the u-factor of this construction. Includes filmResistance. */
100 virtual boost::optional<double> uFactor(double filmResistance) const;
101
102 /** Get the thermal conductance of this construction. Does not include film coefficients. */
103 virtual boost::optional<double> thermalConductance() const;
104
105 /** Get the thermal conductance of this construction. filmResistance is subtracted out of the
106 * thermalResistance if necessary. */
107 virtual boost::optional<double> thermalConductance(double filmResistance) const;
108
109 /** Get the heat capacity of this construction (J/m^2*K). Only works for
110 * \link LayeredConstruction LayeredConstructions \endlink of \link StandardOpaqueMaterial
111 * StandardOpaqueMaterials \endlink. */
112 virtual boost::optional<double> heatCapacity() const;
113
114 /// get interior visible absorptance (unitless)
115 virtual boost::optional<double> interiorVisibleAbsorptance() const;
116
117 /// get exterior visible absorptance (unitless)
118 virtual boost::optional<double> exteriorVisibleAbsorptance() const;
119
120 /// get visible transmittance (unitless)
121 virtual boost::optional<double> visibleTransmittance() const;
122
123 /// Returns the rendering color.
124 virtual boost::optional<RenderingColor> renderingColor() const;
125
126 /// Sets the rendering color.
127 virtual bool setRenderingColor(const RenderingColor& renderingColor);
128
129 /// Resets the rendering color.
130 virtual void resetRenderingColor();
131
132 /// Resets the rendering color.
133 virtual int renderingColorIndex() const = 0;
134
135 //@}
136
137 private:
138 − REGISTER_LOGGER("openstudio.model.ConstructionBase");
139 };
140
141 } // namespace detail
142
143 } // namespace model
144 } // namespace openstudio
145
146 #endif // MODEL_CONSTRUCTIONBASE_IMPL_HPP
147