3.1
peak_period_schedules_shift
4954275f-9caf-422c-9e1f-061244ade152
afa2ee97-3397-4fc6-91ee-f2a9ea97397d
2024-11-16T23:41:36Z
A8988589
PeakPeriodSchedulesShift
PeakPeriodSchedulesShift
Shifts select weekday (or weekday/weekend) schedules out of a peak period.
Enter a peak period window, a delay value, and any applicable ScheduleRuleset or ScheduleFile schedules. Shift all schedule values falling within the peak period to after the end (offset by delay) of the peak period. Optionally prevent stacking of schedule values by only allowing shifts to all-zero periods. Optionally apply schedule shifts to weekend days.
schedules_peak_period
Schedules: Peak Period
Specifies the peak period. Enter a time like "15 - 18" (start hour can be 0 through 23 and end hour can be 1 through 24).
String
true
false
15 - 18
schedules_peak_period_delay
Schedules: Peak Period Delay
The number of hours after peak period end.
Integer
hr
true
false
0
schedules_peak_period_allow_stacking
Schedules: Peak Period Allow Stacking
Whether schedules can be shifted to periods that already have non-zero schedule values. Defaults to true. Note that the schedule type limits upper value is increased to 2.0 when allowing stacked schedule values.
Boolean
false
false
true
true
false
false
schedules_peak_period_weekdays_only
Schedules: Peak Period Weekdays Only
Whether schedules can be shifted for weekdays only, or weekends as well. Defaults to true.
Boolean
false
false
true
true
false
false
schedules_peak_period_schedule_rulesets_names
Schedules: Peak Period Schedule Rulesets Names
Comma-separated list of Schedule:Ruleset object names corresponding to schedules to shift during the specified peak period.
String
false
false
schedules_peak_period_schedule_files_column_names
Schedules: Peak Period Schedule Files Column Names
Comma-separated list of column names, referenced by Schedule:File objects, corresponding to schedules to shift during the specified peak period.
String
false
false
Whole Building.Whole Building Schedules
Measure Type
ModelMeasure
string
Measure Language
Ruby
string
LICENSE.md
md
license
8696A072
README.md
md
readme
B5738296
README.md.erb
erb
readmeerb
456E1929
measures-overview.PNG
PNG
doc
0536DAD0
measures-overview.png
png
doc
0536DAD0
other-examples1.PNG
PNG
doc
39590575
other-examples1.png
png
doc
39590575
other-examples2.PNG
PNG
doc
5AA85040
other-examples2.png
png
doc
5AA85040
other-examples3.PNG
PNG
doc
D6815644
other-examples3.png
png
doc
D6815644
OpenStudio
3.5.1
3.5.1
measure.rb
rb
script
22D1A6CA
PeakPeriodSchedulesShift_Test.rb
rb
test
3061BC32
base-schedules-detailed-occupancy-stochastic.osm
osm
test
CFA80A78
base.osm
osm
test
8193AAB9
files/schedules20230418-20180-18nykxu.csv
csv
test
D6FBB6B6
files/unmodified_schedules.csv
csv
test
D6FBB6B6
test_smooth_schedules.osm
osm
test
C85A2F6A
test_stochastic_schedules.osm
osm
test
77977945
test_stochastic_schedules_no_stacking.osm
osm
test
36631473