Module: BTAP::Resources::Schedules

Defined in:
lib/openstudio-standards/btap/schedules.rb

Overview

This module contains methods that relate to Materials, Constructions and Construction Sets

Defined Under Namespace

Modules: StandardScheduleTypeLimits, StandardSchedules Classes: SchedulesTests

Class Method Summary collapse

Class Method Details

.apply_schedule_maximum(max_value, schedule) ⇒ Object

Sets all values in a schedule greater than max_value to max_value.



502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 502

def self.apply_schedule_maximum(max_value,schedule)
  schedule_ruleset = schedule.to_ScheduleRuleset.get unless schedule.to_ScheduleRuleset.empty?
  schedule_ruleset.scheduleRules.each do |week_rule|
    day_rule = week_rule.daySchedule()
    times = day_rule.times()
    times.each do |time|
      old_value = day_rule.getValue(time).to_f
      day_rule.removeValue(time)
      new_value = old_value
      new_value = max_value if old_value > max_value
      day_rule.addValue(time, new_value)
    end
  end
end

.apply_schedule_minimum(min_value, schedule) ⇒ Object

Sets all values in a schedule less than min_value to min_value.



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 485

def self.apply_schedule_minimum(min_value,schedule)
  schedule_ruleset = schedule.to_ScheduleRuleset.get unless schedule.to_ScheduleRuleset.empty?
  schedule_ruleset.scheduleRules.each do |week_rule|
    day_rule = week_rule.daySchedule()
    times = day_rule.times()
    times.each do |time|
      old_value = day_rule.getValue(time).to_f
      day_rule.removeValue(time)
      new_value = old_value
      new_value = min_value if old_value < min_value
      day_rule.addValue(time, new_value)
    end
  end

end

.create_annual_constant_ruleset_schedule(model, name, type, value) ⇒ Object

This method creates a new constant schedule. name - name of schedule. type - type of schedule (FRACTION, ON_OFF, TEMPERATURE) value - value to be used over 24 hours.



896
897
898
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 896

def self.create_annual_constant_ruleset_schedule(model, name,type,value)
  return create_annual_ruleset_schedule(model, name,type, [Array.new(24){value}, Array.new(24){value},Array.new(24){value}])
end

.create_annual_fraction_ruleset_schedule(model, name, hourArrayValues) ⇒ Object

end



861
862
863
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 861

def self.create_annual_fraction_ruleset_schedule(model,name,hourArrayValues)
  self.create_annual_ruleset_schedule(model,name,"FRACTION",hourArrayValues)
end

.create_annual_on_off_ruleset_schedule(model, name, hourArrayValues) ⇒ Object 



753
754
755
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 753

def self.create_annual_on_off_ruleset_schedule(model,name,hourArrayValues)
  self.create_annual_ruleset_schedule(model,name,"ON_OFF",hourArrayValues)
end

.create_annual_ruleset_schedule(model, name, type, hourArrayValues, start_date = "Jan-1", end_date = "Dec-31") ⇒ Object

Creates a new ruleset schedule object. This is the basic schedule component used in openstudio. name = string: name of schedule type = TEMPERATURE, ON_OFF, FRACTION hourArrayValues = a 3 x 24 array representing week, sat and sun hours. examples: hourArrayValues =

[
  [18,18,18,18,21,21,21,21,23,23,23,23,23,23,21,21,21,18,18,18,18,18,18,18],#Weekday
  [18,18,18,18,21,21,21,21,23,23,23,23,23,23,21,21,21,18,18,18,18,18,18,18],#Saturday
  [18,18,18,18,21,21,21,21,23,23,23,23,23,23,21,21,21,18,18,18,18,18,18,18] #Sun
]

or if you need a constant temperature you can use this shorthand method.

heat_setpoint_array =
  [
  Array.new(24){21}, #Weekday
  Array.new(24){21}, #Sat
  Array.new(24){21}, #Sun
]



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 536

def self.create_annual_ruleset_schedule(model,name,type,hourArrayValues,start_date = "Jan-1",end_date = "Dec-31" )
  raise("array size not 3x24. Please verify your hourly array") if hourArrayValues.size != 3 or hourArrayValues[0].size != 24 or hourArrayValues[1].size != 24 or hourArrayValues[2].size != 24
  start_date = BTAP::Common::get_date_from_string(start_date)
  end_date   = BTAP::Common::get_date_from_string(end_date)


  #create new ruleset
  ruleset = OpenStudio::Model::ScheduleRuleset.new(model)
  ruleset.setName(name)



  #set types limits
  case type.downcase
  when "FRACTION".downcase
    scheduletype = BTAP::Resources::Schedules::StandardScheduleTypeLimits::get_fraction(model)
  when "ON_OFF".downcase
    scheduletype = BTAP::Resources::Schedules::StandardScheduleTypeLimits::get_on_off(model)
  when "TEMPERATURE".downcase
    scheduletype = BTAP::Resources::Schedules::StandardScheduleTypeLimits::get_temperature(model)

  when "ACTIVITY".downcase
    scheduletype = BTAP::Resources::Schedules::StandardScheduleTypeLimits::get_activity(model)
  else
    #if schedule type could not be found raise an exception.
    raise "could  not find schedule limits type :" + type
  end



  #Add days
  weekday = OpenStudio::Model::ScheduleDay.new(model)
  saturday = OpenStudio::Model::ScheduleDay.new(model)
  sunday = OpenStudio::Model::ScheduleDay.new(model)

  weekday.setName(  "wkd" + name )
  saturday.setName( "sat" + name )
  sunday.setName(   "sun" + name )
  if not weekday.setScheduleTypeLimits(scheduletype) or
      not saturday.setScheduleTypeLimits(scheduletype) or
      not sunday.setScheduleTypeLimits(scheduletype)
    raise "unable to set ScheduleDay type limits"
  end

  (0..23).each do|hour|
    weekday.addValue(OpenStudio::Time.new(0,hour+1), hourArrayValues[0][hour] )
    saturday.addValue(OpenStudio::Time.new(0,hour+1), hourArrayValues[1][hour] )
    sunday.addValue(OpenStudio::Time.new(0,hour+1), hourArrayValues[2][hour] )
  end

  #create weekday rule
  weekday_rule = OpenStudio::Model::ScheduleRule.new(ruleset,weekday)
  weekday_rule.setName("wkd" + name + " rule")
  weekday_rule.setApplySunday(false)
  weekday_rule.setApplyMonday(true)
  weekday_rule.setApplyTuesday(true)
  weekday_rule.setApplyWednesday(true)
  weekday_rule.setApplyThursday(true)
  weekday_rule.setApplyFriday(true)
  weekday_rule.setApplySaturday(false)
  weekday_rule.setStartDate(start_date)
  weekday_rule.setEndDate(end_date)

  saturday_rule = OpenStudio::Model::ScheduleRule.new(ruleset,saturday)
  saturday_rule.setName("sat" + name + "rule" )
  saturday_rule.setApplySunday(false)
  saturday_rule.setApplyMonday(false)
  saturday_rule.setApplyTuesday(false)
  saturday_rule.setApplyWednesday(false)
  saturday_rule.setApplyThursday(false)
  saturday_rule.setApplyFriday(false)
  saturday_rule.setApplySaturday(true)
  saturday_rule.setStartDate(start_date)
  saturday_rule.setEndDate(end_date)

  sunday_rule = OpenStudio::Model::ScheduleRule.new(ruleset,sunday)
  sunday_rule.setName("sun" + name + "rule")
  sunday_rule.setApplySunday(true)
  sunday_rule.setApplyMonday(false)
  sunday_rule.setApplyTuesday(false)
  sunday_rule.setApplyWednesday(false)
  sunday_rule.setApplyThursday(false)
  sunday_rule.setApplyFriday(false)
  sunday_rule.setApplySaturday(false)
  sunday_rule.setStartDate(start_date)
  sunday_rule.setEndDate(end_date)

  #set default schedule to be the same as the week schedule.
  default_day =  ruleset.defaultDaySchedule
  default_day.clearValues()
  weekday.times.each_index {|counter| default_day.addValue(weekday.times[counter],weekday.values[counter])}


  return ruleset
end

.create_annual_ruleset_schedule_detailed(model, name, type, schedule_struct) ⇒ Object 



675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 675

def self.create_annual_ruleset_schedule_detailed(model,name,type,schedule_struct  )
  #create new ruleset
  ruleset = OpenStudio::Model::ScheduleRuleset.new(model)
  ruleset.setName(name)
  default_day =  ruleset.defaultDaySchedule


  #set types limits
  scheduletype = ""
  case type.downcase
  when "FRACTION".downcase
    scheduletype = BTAP::Resources::Schedules::StandardScheduleTypeLimits::get_fraction(model)
  when "ON_OFF".downcase
    scheduletype = BTAP::Resources::Schedules::StandardScheduleTypeLimits::get_on_off(model)
  when "TEMPERATURE".downcase
    scheduletype = BTAP::Resources::Schedules::StandardScheduleTypeLimits::get_temperature(model)
    # this will set the default day for temperatures to 23.5C
    default_day.clearValues()
    raise "unable to set ScheduleDay type limits" unless default_day.setScheduleTypeLimits(scheduletype)
    default_day.addValue(BTAP::Common::get_time_from_string( "24:00"), 23.5 )
  when "ACTIVITY".downcase
    scheduletype = BTAP::Resources::Schedules::StandardScheduleTypeLimits::get_activity(model)
    # this will set the default day for temperatures to 23.5C
    default_day.clearValues()
    raise "unable to set ScheduleDay type limits" unless default_day.setScheduleTypeLimits(scheduletype)
    default_day.addValue(BTAP::Common::get_time_from_string( "24:00"), 120.0 )
  else
    #if schedule type could not be found raise an exception.
    raise "could  not find schedule limits type :" + type
  end



  #loop through each schedule ruleset.
  schedule_struct.each do |run_period_profile|

    start_end_dates = run_period_profile[0]
    days_of_the_week = run_period_profile[1]
    hourly_schedule =  run_period_profile[2]

    day_rule = OpenStudio::Model::ScheduleDay.new(model)
    day_rule.setName(  name )
    if not day_rule.setScheduleTypeLimits(scheduletype)
      raise "unable to set ScheduleDay type limits"
    end

    hourly_schedule.each do |hour|
      day_rule.addValue(BTAP::Common::get_time_from_string( hour[0]), hour[1] )
    end

    #create weekday rule
    week_rule = OpenStudio::Model::ScheduleRule.new(ruleset,day_rule)
    #Set Default to false
    week_rule.setApplySunday(false)
    week_rule.setApplyMonday(false)
    week_rule.setApplyTuesday(false)
    week_rule.setApplyWednesday(false)
    week_rule.setApplyThursday(false)
    week_rule.setApplyFriday(false)
    week_rule.setApplySaturday(false)
    # Now set actual days it is applied.
    week_rule.setApplySunday(true) if days_of_the_week.include?("Su") or days_of_the_week.include?("Wke") or days_of_the_week.include?("All")
    week_rule.setApplyMonday(true) if days_of_the_week.include?("M") or days_of_the_week.include?("Wkd") or days_of_the_week.include?("All")
    week_rule.setApplyTuesday(true) if days_of_the_week.include?("T") or days_of_the_week.include?("Wkd") or days_of_the_week.include?("All")
    week_rule.setApplyWednesday(true) if days_of_the_week.include?("W") or days_of_the_week.include?("Wkd") or days_of_the_week.include?("All")
    week_rule.setApplyThursday(true) if days_of_the_week.include?("Th") or days_of_the_week.include?("Wkd") or days_of_the_week.include?("All")
    week_rule.setApplyFriday(true) if days_of_the_week.include?("F") or days_of_the_week.include?("Wkd") or days_of_the_week.include?("All")
    week_rule.setApplySaturday(true) if days_of_the_week.include?("S") or days_of_the_week.include?("Wke") or days_of_the_week.include?("All")

    #Set Period Rule
    week_rule.setStartDate( BTAP::Common::get_date_from_string(start_end_dates[0] ) )
    week_rule.setEndDate( BTAP::Common::get_date_from_string(start_end_dates[1] ) )
  end
  return ruleset
end

.create_annual_temperature_ruleset_schedule(model, name, hourArrayValues) ⇒ Object 



756
757
758
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 756

def self.create_annual_temperature_ruleset_schedule(model,name,hourArrayValues)
  self.create_annual_ruleset_schedule(model,name,"TEMPERATURE",hourArrayValues)
end

.create_annual_thermostat_setpoint_dual_setpoint(model, name, heating_schedule, cooling_schedule) ⇒ Object

This method creates a new dual setpoint schedule using pre-created heating and cooling schedules. name - name of schedule. type - type of schedule (FRACTION, ON_OFF, TEMPERATURE) heating_schedule - an heating schedule ruleset object. cooling_schedule - a cooling schedule ruleset object



880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 880

def self.create_annual_thermostat_setpoint_dual_setpoint(model,name,heating_schedule,cooling_schedule)

  heating_schedule = BTAP::Common::validate_array(model,heating_schedule,"ScheduleRuleset").first
  cooling_schedule = BTAP::Common::validate_array(model,cooling_schedule,"ScheduleRuleset").first
  dual_setpoint = OpenStudio::Model::ThermostatSetpointDualSetpoint.new(model)
  dual_setpoint.setName(name)
  unless dual_setpoint.setCoolingSchedule(cooling_schedule) and dual_setpoint.setHeatingSchedule(heating_schedule)
    raise "dual setpoint could not be created"
  end
  return dual_setpoint
end

.create_availability_schedule_based_on_another_schedule(model, occupancy_schedule, threshold = 0.05) ⇒ Object 



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 378

def self.create_availability_schedule_based_on_another_schedule(model, occupancy_schedule, threshold = 0.05)
  #create new On-Off schedule ruleset.
  availability_ruleset = OpenStudio::Model::ScheduleRuleset.new(model)
  availability_ruleset.setName("availabilty_based_on_occupancy")
  #iterate though all rules.
  occupancy_schedule.scheduleRules.each do |occ_rule|
    #Create new hourly rule to populate availability schedule hourly data.
    hourly_data = OpenStudio::Model::ScheduleDay.new(model)
    #set schedule type to availabilty.
    hourly_data.setScheduleTypeLimits(BTAP::Resources::Schedules::StandardScheduleTypeLimits::get_on_off(model))
    #iterate though hour / value pairs for 24 hour period.
    occ_rule.daySchedule().times().each do |time|
      #check if time value is greater or equal to the threshold. If true set hour value to 1, else 0.
      occ_rule.daySchedule().getValue(time) >= threshold ? hourly_data.addValue(time, 1.0) : hourly_data.addValue(time, 0.0)
    end
    #create new rule with hourly data and add to availablity ruleset.
    avail_rule = OpenStudio::Model::ScheduleRule.new(availability_ruleset,hourly_data)
    #Set same start and end date.
    avail_rule.setStartDate(occ_rule.getStartDate)
    avail_rule.setEndDate(occ_rule.getEndDate)
  end #loop occ_rule
  #Make sure to set the default schedule to be the same as well.
  avail_default_day = availability_ruleset.defaultDaySchedule()
  avail_default_day.clearValues()
  #iterate though hour / value pairs for 24 hour period.
  occupancy_schedule.defaultDaySchedule().times().each do |time|
    #check if time value is greater or equal to the threshold. If true set hour value to 1, else 0.
    occupancy_schedule.defaultDaySchedule().getValue(time) >= threshold ? avail_default_day.addValue(time, 1.0) : avail_default_day.addValue(time, 0.0)
  end
  return availability_ruleset
end

.create_schedule_variable_interval_from_time_series(model, time_series) ⇒ OpenStudio::Model::ScheduleInterval

Creates ScheduleVariableInterval from TimeSeries

Parameters:

  • model (OpenStudio::model::Model) —

    A model object

  • time_series (OpenStudio::TimeSeries) —

    A TimeSeries object

Returns:

  • (OpenStudio::Model::ScheduleInterval) —

    An interval schedule

Author:



929
930
931
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 929

def self.create_schedule_variable_interval_from_time_series(model, time_series)
  result = OpenStudio::Model::ScheduleInterval.fromTimeSeries(time_series, model).get
end

.create_setback_schedule_based_on_another_schedule(model, occupancy_schedule, threshold = 0.05, heat_setpoint = 22.0, heat_setback = 17.0, cool_setpoint = 24.0, cool_setback = 99.0) ⇒ Object 



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 411

def self.create_setback_schedule_based_on_another_schedule(
    model,
    occupancy_schedule,
    threshold = 0.05,
    heat_setpoint = 22.0,
    heat_setback = 17.0,
    cool_setpoint = 24.0,
    cool_setback =99.0)
  #create new On-Off schedule ruleset.
  heating_ruleset = OpenStudio::Model::ScheduleRuleset.new(model)
  heating_ruleset.setName("heat_thermostat_based_on_occupancy")
  cooling_ruleset = OpenStudio::Model::ScheduleRuleset.new(model)
  cooling_ruleset.setName("cool_thermostat_based_on_occupancy")
  #iterate though all rules.
  occupancy_schedule.to_ScheduleRuleset.get.scheduleRules.each do |occ_rule|
    #Create new hourly rule to populate heat/cold schedule hourly data.
    heating_hourly_data = OpenStudio::Model::ScheduleDay.new(model)
    cooling_hourly_data = OpenStudio::Model::ScheduleDay.new(model)
    #set schedule type to availabilty.
    heating_hourly_data.setScheduleTypeLimits(BTAP::Resources::Schedules::StandardScheduleTypeLimits::get_temperature(model))
    cooling_hourly_data.setScheduleTypeLimits(BTAP::Resources::Schedules::StandardScheduleTypeLimits::get_temperature(model))
    #iterate though hour / value pairs for 24 hour period.
    occ_rule.daySchedule().times().each do |time|
      #check if time value is greater or equal to the threshold. If true set hour value to 1, else 0.
      occ_rule.daySchedule().getValue(time) >= threshold ? heating_hourly_data.addValue(time, heat_setpoint) : heating_hourly_data.addValue(time,heat_setback)
      occ_rule.daySchedule().getValue(time) >= threshold ? cooling_hourly_data.addValue(time, cool_setpoint) : cooling_hourly_data.addValue(time,cool_setback)
    end
    #create new rule with hourly data and add to availablity ruleset.
    heating_avail_rule = OpenStudio::Model::ScheduleRule.new(heating_ruleset,heating_hourly_data)
    cooling_avail_rule = OpenStudio::Model::ScheduleRule.new(cooling_ruleset,cooling_hourly_data)
    #Set same start and end date.
    heating_avail_rule.setStartDate(occ_rule.startDate.get)
    heating_avail_rule.setEndDate(occ_rule.endDate.get)
    cooling_avail_rule.setStartDate(occ_rule.startDate.get)
    cooling_avail_rule.setEndDate(occ_rule.endDate.get)
    #set days enforced.
    heating_avail_rule.setApplySunday(occ_rule.applySunday)
    heating_avail_rule.setApplyMonday(occ_rule.applyMonday)
    heating_avail_rule.setApplyTuesday(occ_rule.applyTuesday)
    heating_avail_rule.setApplyWednesday(occ_rule.applyWednesday)
    heating_avail_rule.setApplyThursday(occ_rule.applyThursday)
    heating_avail_rule.setApplyFriday(occ_rule.applyFriday)
    heating_avail_rule.setApplySaturday(occ_rule.applySaturday)

    cooling_avail_rule.setApplySunday(occ_rule.applySunday)
    cooling_avail_rule.setApplyMonday(occ_rule.applyMonday)
    cooling_avail_rule.setApplyTuesday(occ_rule.applyTuesday)
    cooling_avail_rule.setApplyWednesday(occ_rule.applyWednesday)
    cooling_avail_rule.setApplyThursday(occ_rule.applyThursday)
    cooling_avail_rule.setApplyFriday(occ_rule.applyFriday)
    cooling_avail_rule.setApplySaturday(occ_rule.applySaturday)


  end #loop occ_rule
  #Make sure to set the default schedule to be the same as well.
  heating_default_day = heating_ruleset.defaultDaySchedule()
  heating_default_day.clearValues()
  cooling_default_day = cooling_ruleset.defaultDaySchedule()
  cooling_default_day.clearValues()

  #iterate though hour / value pairs for 24 hour period.
  occupancy_schedule.to_ScheduleRuleset.get.defaultDaySchedule().times().each do |time|
    #check if time value is greater or equal to the threshold. If true set hour value to 1, else 0.
    occupancy_schedule.to_ScheduleRuleset.get.defaultDaySchedule().getValue(time) >= threshold ? heating_default_day.addValue(time, heat_setpoint) : heating_default_day.addValue(time, heat_setback)
    occupancy_schedule.to_ScheduleRuleset.get.defaultDaySchedule().getValue(time) >= threshold ? cooling_default_day.addValue(time, cool_setpoint) : cooling_default_day.addValue(time, cool_setback)
  end
  return heating_ruleset,cooling_ruleset
end

.create_timeseries_from_schedule_ruleset(model, schedule_ruleset) ⇒ OpenStudio::TimeSeries

Creates TimeSeries from ScheduleRuleset

Parameters:

  • model (OpenStudio::Model::Model) —

    A model object

  • schedule_ruleset (OpenStudio::Model::ScheduleRuleset) —

    A schedule ruleset

Returns:

  • (OpenStudio::TimeSeries) —

    A TimeSeries object

Author:



905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 905

def self.create_timeseries_from_schedule_ruleset(model, schedule_ruleset)
  yd = model.getYearDescription
  start_date = yd.makeDate(1, 1)
  end_date = yd.makeDate(12, 31)

  values = OpenStudio::DoubleVector.new
  day = OpenStudio::Time.new(1.0)
  interval = OpenStudio::Time.new(1.0 / 48.0)
  day_schedules = schedule_ruleset.to_ScheduleRuleset.get.getDaySchedules(start_date, end_date)
  day_schedules.each do |day_schedule|
    time = interval
    while time < day
      values << day_schedule.getValue(time)
      time += interval
    end
  end
  time_series = OpenStudio::TimeSeries.new(start_date, interval, OpenStudio.createVector(values), "")
end

.create_zonal_occupancy_schedule_on_off(model, thermal_zone) ⇒ Object 



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 308

def self.create_zonal_occupancy_schedule_on_off(model, thermal_zone)

  model.getFanZoneExhausts.sort.each {|zfe| puts "Fan Ex:#{zfe}"}

  #Create new timeseries object to keep track of on/off states. Default to 30min intervals.
  timeseries  = OpenStudio::TimeSeries.new
  thermal_zone.spaces.sort.each do |space|
    #Iterate through the people object in the space.
    space.spaceType.get.people.each do |people|
      if people.numberofPeopleSchedule.is_initialized() and people.numberofPeopleSchedule.get.to_ScheduleRuleset.is_initialized
        #Get the occupancy schedule.
        occ_schedule = people.numberofPeopleSchedule.get
        #Convert schedule to timeseries and sum up timeseries objects for this space / zone.
        occ_time_series = create_timeseries_from_schedule_ruleset(model,occ_schedule)
        timeseries = timeseries + occ_time_series
      end
    end
  end
  #return the timeseries converted to
  return create_schedule_variable_interval_from_time_series(model,timeseries)
end

.modify_schedule(model, schedule_ruleset, a_coef = 0.0, b_coef = 0.0, c_coef = 0.0, time_shift = nil, time_sign = nil) ⇒ Object 



350
351
352
353
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 350

def self.modify_schedule( model, schedule_ruleset, a_coef = 0.0 ,b_coef = 0.0 ,c_coef= 0.0 ,time_shift = nil,time_sign = nil)
  new_schedule = schedule_ruleset.clone( model ).to_ScheduleRuleset.get
  self.modify_schedule!(model, new_schedule, a_coef,b_coef,c_coef ,time_shift,time_sign)
end

.modify_schedule!(model, schedule_ruleset, a_coef = 0.0, b_coef = 0.0, c_coef = 0.0, time_shift = nil, time_sign = nil) ⇒ Object 



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 356

def self.modify_schedule!(model, schedule_ruleset, a_coef = 0.0 ,b_coef = 0.0 ,c_coef= 0.0 ,time_shift = nil,time_sign = nil)
  schedule_ruleset.scheduleRules.each do |week_rule|
    day_rule = week_rule.daySchedule()
    times = day_rule.times()
    times.each do |time|
      old_value = day_rule.getValue(time)
      day_rule.removeValue(time)
      new_value = "error"
      new_time = "error"
      #set the new value according to Ax2+Bx+C.
      new_value = a_coef * old_value ** 2.0 + b_coef * old_value + c_coef
      unless time_shift.nil? or time_sign.nil?
        command = "new_time = time #{time_sign} #{BTAP::Common::get_time_from_string(time_shift)}"
        eval(command)
        #make sure time is not past 24 hours.
        new_time = new_time - BTAP::Common::get_time_from_string("24:00") if new_time > BTAP::Common::get_time_from_string("24:00")
      end
      day_rule.addValue(time, new_value)
    end
  end
end

.remove_all_schedules(model) ⇒ Object 



303
304
305
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 303

def self.remove_all_schedules(model)
  model.getScheduleBases.sort.each { |item| item.remove }
end

.set_exhaust_fans_availability_to_building_default_occ_schedule(model) ⇒ Object

This method will only work with a single occupancy definition.



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/openstudio-standards/btap/schedules.rb', line 332

def self.set_exhaust_fans_availability_to_building_default_occ_schedule(model)
  # get occupancy schedule if possible.
  if  model.building.get.defaultScheduleSet.is_initialized and
      model.building.get.defaultScheduleSet.get.numberofPeopleSchedule.is_initialized and
      model.building.get.defaultScheduleSet.get.numberofPeopleSchedule.get.to_ScheduleRuleset.is_initialized
    occ_schedule = model.building.get.defaultScheduleSet.get.numberofPeopleSchedule.get
    #get building default occupancy schedule.
    model.getFanZoneExhausts.sort.each do |zfe|
      zfe.setAvailabilitySchedule(occ_schedule)
      zfe.setBalancedExhaustFractionSchedule(occ_schedule)
    end
  else
    raise ("Default occupancy schedule has not been set in model! Unsure what to set exhaust fans to. Exiting.")
  end
  return model.getFanZoneExhausts
end