Class: ShiftScheduleProfileTime

Inherits:
OpenStudio::Measure::ModelMeasure
  • Object
show all
Defined in:
lib/measures/ShiftScheduleProfileTime/measure.rb

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(model) ⇒ Object

define the arguments that the user will input



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/measures/ShiftScheduleProfileTime/measure.rb', line 21

def arguments(model)
  args = OpenStudio::Measure::OSArgumentVector.new

  # populate choice argument for schedules that are applied to surfaces in the model
  schedule_handles = OpenStudio::StringVector.new
  schedule_display_names = OpenStudio::StringVector.new

  # putting space types and names into hash
  schedule_args = model.getScheduleRulesets
  schedule_args_hash = {}
  schedule_args.each do |schedule_arg|
    schedule_args_hash[schedule_arg.name.to_s] = schedule_arg
  end

  # looping through sorted hash of schedules
  schedule_args_hash.sort.map do |key, value|
    # only include if schedule use count > 0
    if value.directUseCount > 0
      schedule_handles << value.handle.to_s
      schedule_display_names << key
    end
  end

  # add building to string vector with air loops
  building = model.getBuilding
  schedule_handles << building.handle.to_s
  schedule_display_names << '*All Ruleset Schedules*'

  # make an argument for schedule
  schedule = OpenStudio::Measure::OSArgument.makeChoiceArgument('schedule', schedule_handles, schedule_display_names, true)
  schedule.setDisplayName('Choose a Schedule to Shift the Time For.')
  schedule.setDefaultValue('*All Ruleset Schedules*') # if no schedule is chosen this will run on all air loops
  args << schedule

  # make an argument to add new space true/false
  shift_value = OpenStudio::Measure::OSArgument.makeDoubleArgument('shift_value', true)
  shift_value.setDisplayName('Shift Schedule Profiles Forward (24hr, use decimal for sub hour).')
  shift_value.setDefaultValue(1)
  args << shift_value

  return args
end

#name ⇒ Object

define the name that a user will see, this method may be deprecated as the display name in PAT comes from the name field in measure.xml



16
17
18
 
# File 'lib/measures/ShiftScheduleProfileTime/measure.rb', line 16

def name
  return 'ShiftScheduleProfileTime'
end

#run(model, runner, user_arguments) ⇒ Object

define what happens when the measure is run



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/measures/ShiftScheduleProfileTime/measure.rb', line 65

def run(model, runner, user_arguments)
  super(model, runner, user_arguments)

  # use the built-in error checking
  if !runner.validateUserArguments(arguments(model), user_arguments)
    return false
  end

  # assign the user inputs to variables
  schedule = runner.getOptionalWorkspaceObjectChoiceValue('schedule', user_arguments, model)
  shift_value = runner.getDoubleArgumentValue('shift_value', user_arguments)

  # check the schedule for reasonableness
  apply_to_all_schedules = false
  if schedule.empty?
    handle = runner.getStringArgumentValue('schedule', user_arguments)
    if handle.empty?
      runner.registerError('No schedule was chosen.')
    else
      runner.registerError("The selected schedule with handle '#{handle}' was not found in the model. It may have been removed by another measure.")
    end
    return false
  else
    if !schedule.get.to_ScheduleRuleset.empty?
      schedule = schedule.get.to_ScheduleRuleset.get
    elsif !schedule.get.to_Building.empty?
      apply_to_all_schedules = true
    else
      runner.registerError('Script Error - argument not showing up as schedule.')
      return false
    end
  end

  # check shift value for reasonableness
  if (shift_value / 24) == (shift_value / 24).to_i
    runner.registerAsNotApplicable('No schedule shift was requested, the model was not changed.')
  end

  # get schedules for measure
  schedules = []
  if apply_to_all_schedules
    raw_schedules = model.getScheduleRulesets
    raw_schedules.each do |raw_schedule|
      if raw_schedule.directUseCount > 0
        schedules << raw_schedule
      end
    end

  else
    schedules << schedule # only run on a single schedule
  end

  schedules.each do |schedule|
    # array of all profiles to change
    profiles = []

    # push default profiles to array
    default_rule = schedule.defaultDaySchedule
    profiles << default_rule

    # push profiles to array
    rules = schedule.scheduleRules
    rules.each do |rule|
      day_sch = rule.daySchedule
      profiles << day_sch
    end

    # add design days to array
    summer_design = schedule.summerDesignDaySchedule
    winter_design = schedule.winterDesignDaySchedule
    profiles << summer_design
    profiles << winter_design

    # reporting initial condition of model
    if apply_to_all_schedules
      runner.registerInitialCondition("#{schedules.size} schedules are used in this model.")
    else
      runner.registerInitialCondition("Schedule #{schedule.name} has #{profiles.size} profiles including design days.")
    end

    # rename schedule
    schedule.setName("#{schedule.name} - (shifted #{shift_value} hours)")

    shift_hours = shift_value.to_i
    shift_minutes = ((shift_value - shift_value.to_i) * 60).to_i

    # give info messages as I change specific profiles
    runner.registerInfo("Adjusting #{schedule.name}")

    # edit profiles
    profiles.each do |day_sch|
      times = day_sch.times
      values = day_sch.values

      # time objects to use in meausre
      time_0 = OpenStudio::Time.new(0, 0, 0, 0)
      time_24 =  OpenStudio::Time.new(0, 24, 0, 0)
      shift_time = OpenStudio::Time.new(0, shift_hours, shift_minutes, 0)

      # arrays for values to avoid overlap conflict of times
      new_times = []
      new_values = []

      # create a a pair of times and values for what will be 0 time after adjustment
      new_times << time_24
      if shift_time > time_0
        new_values << day_sch.getValue(time_24 - shift_time)
      else
        new_values << day_sch.getValue(time_0 - shift_time)
      end

      # push times to array
      times.each do |time|
        new_time = time + shift_time

        # adjust wrap around times
        if new_time < time_0
          new_times << new_time + time_24
        elsif new_time > time_24
          new_times << new_time - time_24
        else
          new_times << new_time
        end
      end

      # push values to array
      values.each do |value|
        new_values << value
      end

      # clear values
      day_sch.clearValues

      # make new values
      for i in 0..(new_values.length - 1)
        day_sch.addValue(new_times[i], new_values[i])
      end
    end
  end

  # reporting final condition of model
  if apply_to_all_schedules
    runner.registerFinalCondition('Shifted time for all profiles for all schedules.')
  else
    runner.registerFinalCondition("Shifted time for all profiles used by #{schedule.name}.")
  end

  return true
end