Class: ExportScheduleCSV

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

Overview

start the measure

Instance Method Summary collapse

Instance Method Details

#arguments(model = nil) ⇒ Object

define the arguments that the user will input



15
16
17
18
19
20
21
22
23
24
 
# File 'lib/measures/ExportScheduleCSV/measure.rb', line 15

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

  interval_arg = OpenStudio::Measure::OSArgument.makeIntegerArgument('interval', false)
  interval_arg.setDisplayName('Time Interval (minutes)')
  interval_arg.setDefaultValue(60)
  args << interval_arg

  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



10
11
12
 
# File 'lib/measures/ExportScheduleCSV/measure.rb', line 10

def name
  return 'ExportScheduleCSV'
end

#run(runner, user_arguments) ⇒ Object

define what happens when the measure is run



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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/measures/ExportScheduleCSV/measure.rb', line 27

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

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

  interval_arg = user_arguments['interval']

  interval = interval_arg.defaultValueAsInteger
  if interval_arg.hasValue
    interval = interval_arg.valueAsInteger
  end

  # get the last model
  model = runner.lastOpenStudioModel
  if model.empty?
    runner.registerError('Cannot find last model.')
    return false
  end
  model = model.get

  header = []
  header << 'Time'
  schedules = []

  model.getScheduleDays.each do |schedule|
    header << schedule.name.get
    schedules << schedule
  end

  dt = OpenStudio::Time.new(0, 0, interval, 0)
  time = OpenStudio::Time.new(0, 0, 0, 0)
  stop = OpenStudio::Time.new(1, 0, 0, 0)
  values = []
  while time <= stop
    row = []
    row << time.to_s
    schedules.each do |schedule|
      row << schedule.getValue(time)
    end
    values << row

    time += dt
  end

  # if we want this report could write out a csv, html, or any other file here
  runner.registerInfo("Writing CSV report 'report.csv'")
  File.open('report.csv', 'w') do |file|
    file.puts header.join(',')
    values.each do |row|
      file.puts row.join(',')
    end
  end

  # reporting final condition
  runner.registerFinalCondition("Wrote CSV for #{schedules.size} day schedules.")

  return true
end