GCC Code Coverage Report


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

src/model/ScheduleRuleset.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_SCHEDULERULESET_HPP
7 #define MODEL_SCHEDULERULESET_HPP
8
9 #include "ModelAPI.hpp"
10 #include "Schedule.hpp"
11
12 namespace openstudio {
13
14 class Date;
15
16 namespace model {
17
18 class ScheduleDay;
19 class ScheduleRule;
20
21 namespace detail {
22
23 class ScheduleRuleset_Impl;
24 class ScheduleRule_Impl;
25
26 } // namespace detail
27
28 /** ScheduleRuleset is a Schedule that wraps the OpenStudio IDD object 'OS_Schedule_Ruleset'.
29 * ScheduleRuleset is the parent of its default day schedule, any non-default summer or winter
30 * design day schedules, and its \link ScheduleRule ScheduleRules\endlink. */
31 class MODEL_API ScheduleRuleset : public Schedule
32 {
33 public:
34 /** @name Constructors and Destructors */
35 //@{
36
37 /** Constructs a new ScheduleRuleset, and also constructs a new ScheduleDay and assigns it to
38 * be the defaultDaySchedule(). */
39 explicit ScheduleRuleset(const Model& model);
40
41 /** Constructs a new ScheduleRuleset, constructs a new ScheduleDay with value at all times
42 * and assigns it to be the defaultDaySchedule(). */
43 ScheduleRuleset(const Model& model, double value);
44
45 22676 virtual ~ScheduleRuleset() override = default;
46 // Default the copy and move operators because the virtual dtor is explicit
47 66 ScheduleRuleset(const ScheduleRuleset& other) = default;
48 278 ScheduleRuleset(ScheduleRuleset&& other) = default;
49 ✗ ScheduleRuleset& operator=(const ScheduleRuleset&) = default;
50 ✗ ScheduleRuleset& operator=(ScheduleRuleset&&) = default;
51
52 //@}
53
54 static IddObjectType iddObjectType();
55
56 /** @name Getters */
57 //@{
58
59 /// Returns the default day schedule.
60 ScheduleDay defaultDaySchedule() const;
61
62 /// Returns the summer design day schedule, which may be the same ScheduleDay as
63 /// defaultDaySchedule().
64 ScheduleDay summerDesignDaySchedule() const;
65
66 /// Returns true if the summer design day is defaulted; false if it is explicitly set.
67 bool isSummerDesignDayScheduleDefaulted() const;
68
69 /// Returns the winter design day schedule, which may be the same ScheduleDay as
70 /// defaultDaySchedule().
71 ScheduleDay winterDesignDaySchedule() const;
72
73 /// Returns true if the winter design day is defaulted; false if it is explicitly set.
74 bool isWinterDesignDayScheduleDefaulted() const;
75
76 /// Returns the holiday schedule, which may be the same ScheduleDay as defaultDaySchedule().
77 ScheduleDay holidaySchedule() const;
78
79 /// Returns true if the holiday schedule is defaulted; false if it is explicitly set.
80 bool isHolidayScheduleDefaulted() const;
81
82 /// Returns the custom day 1 schedule, which may be the same ScheduleDay as defaultDaySchedule().
83 ScheduleDay customDay1Schedule() const;
84
85 /// Returns true if the custom day 1 schedule is defaulted; false if it is explicitly set.
86 bool isCustomDay1ScheduleDefaulted() const;
87
88 /// Returns the custom day 2 schedule, which may be the same ScheduleDay as defaultDaySchedule().
89 ScheduleDay customDay2Schedule() const;
90
91 /// Returns true if the custom day 2 schedule is defaulted; false if it is explicitly set.
92 bool isCustomDay2ScheduleDefaulted() const;
93
94 //@}
95 /** @name Setters */
96 //@{
97
98 /// Sets the summer design day schedule if ScheduleTypeLimits are compatible. Calls remove
99 /// on any existing non-default summer design day schedule. Clones schedule and parents the
100 /// clone, but does not call remove on the original schedule.
101 bool setSummerDesignDaySchedule(const ScheduleDay& schedule);
102
103 /// Resets the summer design day schedule. Calls remove on any existing non-default summer
104 /// design day schedule.
105 void resetSummerDesignDaySchedule();
106
107 /// Sets the winter design day schedule if ScheduleTypeLimits are compatible. Calls remove
108 /// on any existing non-default winter design day schedule. Clones schedule and parents the
109 /// clone, but does not call remove on the original schedule.
110 bool setWinterDesignDaySchedule(const ScheduleDay& schedule);
111
112 /// Resets the winter design day schedule. Calls remove on any existing non-default winter
113 /// design day schedule.
114 void resetWinterDesignDaySchedule();
115
116 /// Sets the holiday schedule if ScheduleTypeLimits are compatible. Calls remove
117 /// on any existing non-default holiday schedule. Clones schedule and parents the
118 /// clone, but does not call remove on the original schedule.
119 bool setHolidaySchedule(const ScheduleDay& schedule);
120
121 /// Resets the holiday schedule. Calls remove on any existing non-default holiday schedule.
122 void resetHolidaySchedule();
123
124 /// Sets the custom day 1 schedule if ScheduleTypeLimits are compatible. Calls remove
125 /// on any existing non-default custom day 1 schedule. Clones schedule and parents the
126 /// clone, but does not call remove on the original schedule.
127 bool setCustomDay1Schedule(const ScheduleDay& schedule);
128
129 /// Resets the custom day 1 schedule. Calls remove on any existing non-default custom day 1 schedule.
130 void resetCustomDay1Schedule();
131
132 /// Sets the custom day 2 schedule if ScheduleTypeLimits are compatible. Calls remove
133 /// on any existing non-default custom day 2 schedule. Clones schedule and parents the
134 /// clone, but does not call remove on the original schedule.
135 bool setCustomDay2Schedule(const ScheduleDay& schedule);
136
137 /// Resets the custom day 2 schedule. Calls remove on any existing non-default custom day 2 schedule.
138 void resetCustomDay2Schedule();
139
140 //@}
141 /** @name Other */
142 //@{
143
144 /// Returns a vector of the rules associated with this schedule, this may be empty.
145 /// The rules returned are in order from highest priority to lowest priority.
146 std::vector<ScheduleRule> scheduleRules() const;
147
148 /// Sets the index of the given rule; 0 is the highest priority.
149 /// Returns false if this rule is not a child of this rule set or if index > number of
150 /// rules - 1.
151 bool setScheduleRuleIndex(ScheduleRule& scheduleRule, unsigned index);
152
153 /// Returns a vector of indices into the result of scheduleRules() between start date
154 /// (inclusive) and end date (inclusive). If no rule is in place on a given day then -1 is
155 /// returned.
156 std::vector<int> getActiveRuleIndices(const openstudio::Date& startDate, const openstudio::Date& endDate) const;
157
158 /// Returns a vector of day schedules between start date (inclusive) and end date (inclusive).
159 std::vector<ScheduleDay> getDaySchedules(const openstudio::Date& startDate, const openstudio::Date& endDate) const;
160
161 //@}
162 protected:
163 friend class ScheduleRule;
164 friend class detail::ScheduleRule_Impl;
165
166 // Moves this rule to the last position. Called in ScheduleRule remove.
167 bool moveToEnd(ScheduleRule& scheduleRule);
168
169 /// @cond
170 using ImplType = detail::ScheduleRuleset_Impl;
171
172 friend class Model;
173 friend class openstudio::IdfObject;
174 friend class openstudio::detail::IdfObject_Impl;
175 friend class detail::ScheduleRuleset_Impl;
176
177 explicit ScheduleRuleset(std::shared_ptr<detail::ScheduleRuleset_Impl> impl);
178 /// @endcond
179 private:
180 REGISTER_LOGGER("openstudio.model.ScheduleRuleset");
181 };
182
183 /** \relates ScheduleRuleset*/
184 using OptionalScheduleRuleset = boost::optional<ScheduleRuleset>;
185
186 /** \relates ScheduleRuleset*/
187 using ScheduleRulesetVector = std::vector<ScheduleRuleset>;
188
189 } // namespace model
190 } // namespace openstudio
191
192 #endif // MODEL_SCHEDULERULESET_HPP
193