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/SurfacePropertyLocalEnvironment.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_SURFACEPROPERTYLOCALENVIRONMENT_HPP
7 #define MODEL_SURFACEPROPERTYLOCALENVIRONMENT_HPP
8
9 #include <model/ModelAPI.hpp>
10 #include "ModelObject.hpp"
11
12 namespace openstudio {
13 namespace model {
14
15 class Surface;
16 class SubSurface;
17 class PlanarSurface;
18 class Schedule;
19 class SurfacePropertySurroundingSurfaces;
20 class SurfacePropertyGroundSurfaces;
21 // class OutdoorAirNode;
22
23 namespace detail {
24
25 class SurfacePropertyLocalEnvironment_Impl;
26
27 } // namespace detail
28
29 /** SurfacePropertyLocalEnvironment is a ModelObject that wraps the OpenStudio IDD object 'OS:SurfaceProperty:LocalEnvironment'. */
30 class MODEL_API SurfacePropertyLocalEnvironment : public ModelObject
31 {
32 public:
33 /** @name Constructors and Destructors */
34 //@{
35
36 explicit SurfacePropertyLocalEnvironment(const Surface& surface);
37 explicit SurfacePropertyLocalEnvironment(const SubSurface& surface);
38
39 115 virtual ~SurfacePropertyLocalEnvironment() override = default;
40
41 //@}
42
43 static IddObjectType iddObjectType();
44
45 /** @name Getters */
46 //@{
47
48 PlanarSurface exteriorSurface() const;
49 boost::optional<Surface> exteriorSurfaceAsSurface() const;
50 boost::optional<SubSurface> exteriorSurfaceAsSubSurface() const;
51
52 boost::optional<Schedule> externalShadingFractionSchedule() const;
53
54 boost::optional<SurfacePropertySurroundingSurfaces> surfacePropertySurroundingSurfaces() const;
55
56 boost::optional<SurfacePropertyGroundSurfaces> surfacePropertyGroundSurfaces() const;
57
58 // boost::optional<OutdoorAirNode> outdoorAirNode() const;
59
60 //@}
61 /** @name Setters */
62 //@{
63
64 // Note that unicity is enforced: if the surface to point to already has a SurfacePropertyLocalEnvironment object attached, it will be removed
65 // first
66 bool setExteriorSurface(const PlanarSurface& surface);
67
68 bool setExternalShadingFractionSchedule(Schedule& schedule);
69 void resetExternalShadingFractionSchedule();
70
71 bool setSurfacePropertySurroundingSurfaces(const SurfacePropertySurroundingSurfaces& surfacePropertySurroundingSurfaces);
72 void resetSurfacePropertySurroundingSurfaces();
73
74 bool setSurfacePropertyGroundSurfaces(const SurfacePropertyGroundSurfaces& surfacePropertyGroundSurfaces);
75 void resetSurfacePropertyGroundSurfaces();
76
77 // bool setOutdoorAirNode(const OutdoorAirNode& outdoorAirNode);
78 // void resetOutdoorAirNode();
79
80 //@}
81 /** @name Other */
82 //@{
83
84 //@}
85 protected:
86 /// @cond
87 using ImplType = detail::SurfacePropertyLocalEnvironment_Impl;
88
89 explicit SurfacePropertyLocalEnvironment(std::shared_ptr<detail::SurfacePropertyLocalEnvironment_Impl> impl);
90
91 friend class detail::SurfacePropertyLocalEnvironment_Impl;
92 friend class Model;
93 friend class IdfObject;
94 friend class openstudio::detail::IdfObject_Impl;
95 /// @endcond
96 private:
97 − REGISTER_LOGGER("openstudio.model.SurfacePropertyLocalEnvironment");
98 };
99
100 /** \relates SurfacePropertyLocalEnvironment*/
101 using OptionalSurfacePropertyLocalEnvironment = boost::optional<SurfacePropertyLocalEnvironment>;
102
103 /** \relates SurfacePropertyLocalEnvironment*/
104 using SurfacePropertyLocalEnvironmentVector = std::vector<SurfacePropertyLocalEnvironment>;
105
106 } // namespace model
107 } // namespace openstudio
108
109 #endif // MODEL_SURFACEPROPERTYLOCALENVIRONMENT_HPP
110