GCC Code Coverage Report


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

src/model/ZoneControlContaminantController.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_ZONECONTROLCONTAMINANTCONTROLLER_HPP
7 #define MODEL_ZONECONTROLCONTAMINANTCONTROLLER_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ModelObject.hpp"
11
12 namespace openstudio {
13 namespace model {
14
15 class ThermalZone;
16 class Schedule;
17
18 namespace detail {
19
20 class ZoneControlContaminantController_Impl;
21
22 } // namespace detail
23
24 /** ZoneControlContaminantController is a ModelObject that wraps the OpenStudio IDD object 'OS:ZoneControl:ContaminantController'. */
25 class MODEL_API ZoneControlContaminantController : public ModelObject
26 {
27 public:
28 /** @name Constructors and Destructors */
29 //@{
30
31 explicit ZoneControlContaminantController(const Model& model);
32
33 73 virtual ~ZoneControlContaminantController() override = default;
34 // Default the copy and move operators because the virtual dtor is explicit
35 10 ZoneControlContaminantController(const ZoneControlContaminantController& other) = default;
36 29 ZoneControlContaminantController(ZoneControlContaminantController&& other) = default;
37 ✗ ZoneControlContaminantController& operator=(const ZoneControlContaminantController&) = default;
38 1 ZoneControlContaminantController& operator=(ZoneControlContaminantController&&) = default;
39
40 //@}
41
42 static IddObjectType iddObjectType();
43
44 /** @name Getters */
45 //@{
46
47 boost::optional<ThermalZone> controlledZone() const;
48
49 boost::optional<Schedule> carbonDioxideControlAvailabilitySchedule() const;
50
51 boost::optional<Schedule> carbonDioxideSetpointSchedule() const;
52
53 boost::optional<Schedule> minimumCarbonDioxideConcentrationSchedule() const;
54
55 boost::optional<Schedule> genericContaminantControlAvailabilitySchedule() const;
56
57 boost::optional<Schedule> genericContaminantSetpointSchedule() const;
58
59 //@}
60 /** @name Setters */
61 //@{
62
63 bool setCarbonDioxideControlAvailabilitySchedule(Schedule& schedule);
64
65 void resetCarbonDioxideControlAvailabilitySchedule();
66
67 bool setCarbonDioxideSetpointSchedule(Schedule& schedule);
68
69 void resetCarbonDioxideSetpointSchedule();
70
71 bool setMinimumCarbonDioxideConcentrationSchedule(Schedule& schedule);
72
73 void resetMinimumCarbonDioxideConcentrationSchedule();
74
75 bool setGenericContaminantControlAvailabilitySchedule(Schedule& schedule);
76
77 void resetGenericContaminantControlAvailabilitySchedule();
78
79 bool setGenericContaminantSetpointSchedule(Schedule& schedule);
80
81 void resetGenericContaminantSetpointSchedule();
82
83 //@}
84 /** @name Other */
85 //@{
86
87 //@}
88 protected:
89 /// @cond
90 using ImplType = detail::ZoneControlContaminantController_Impl;
91
92 explicit ZoneControlContaminantController(std::shared_ptr<detail::ZoneControlContaminantController_Impl> impl);
93
94 friend class detail::ZoneControlContaminantController_Impl;
95 friend class Model;
96 friend class IdfObject;
97 friend class openstudio::detail::IdfObject_Impl;
98 /// @endcond
99 private:
100 REGISTER_LOGGER("openstudio.model.ZoneControlContaminantController");
101 };
102
103 /** \relates ZoneControlContaminantController*/
104 using OptionalZoneControlContaminantController = boost::optional<ZoneControlContaminantController>;
105
106 /** \relates ZoneControlContaminantController*/
107 using ZoneControlContaminantControllerVector = std::vector<ZoneControlContaminantController>;
108
109 } // namespace model
110 } // namespace openstudio
111
112 #endif // MODEL_ZONECONTROLCONTAMINANTCONTROLLER_HPP
113