Class: ExampleReport

Inherits:
OpenStudio::Measure::ReportingMeasure
  • Object
show all
Defined in:
lib/measures/example_report/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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/measures/example_report/measure.rb', line 47

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

  # populate arguments
  possible_sections.each do |method_name|
    # get display name
    arg = OpenStudio::Measure::OSArgument.makeBoolArgument(method_name, true)
    display_name = eval("OsLib_Reporting_example.#{method_name}(nil,nil,nil,true)[:title]")
    arg.setDisplayName(display_name)
    arg.setDefaultValue(true)
    args << arg
  end

  args
end

#description ⇒ Object

human readable description



20
21
22
 
# File 'lib/measures/example_report/measure.rb', line 20

def description
  'Simple example of modular code to create tables and charts in OpenStudio reporting measures. This is not meant to use as is, it is an example to help with reporting measure development.'
end

#energyPlusOutputRequests(runner, user_arguments) ⇒ Object

add any outout variable requests here



64
65
66
67
68
69
70
 
# File 'lib/measures/example_report/measure.rb', line 64

def energyPlusOutputRequests(runner, user_arguments)
  super(runner, user_arguments)

  result = OpenStudio::IdfObjectVector.new

  result
end

#modeler_description ⇒ Object

human readable description of modeling approach



25
26
27
 
# File 'lib/measures/example_report/measure.rb', line 25

def modeler_description
  'This measure uses the same framework and technologies (bootstrap and dimple) that the standard OpenStudio results report uses to create an html report with tables and charts. Download this measure and copy it to your Measures directory using PAT or the OpenStudio application. Then alter the data in os_lib_reporting_custom.rb to suit your needs. Make new sections and tables as needed.'
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



15
16
17
 
# File 'lib/measures/example_report/measure.rb', line 15

def name
  'Example Report'
end

#possible_sections ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/measures/example_report/measure.rb', line 29

def possible_sections
  # methods for sections in order that they will appear in report
  result = []

  # instead of hand populating, any methods with 'section' in the name will be added in the order they appear
  all_sections = OsLib_Reporting_example.methods(false)
  method_hash = {}
  all_sections.each do |section|
    next if !section.to_s.include? 'section'
    method_hash[section.to_s] = OsLib_Reporting_example.method(section).source_location.last
  end
  # sort methods by location in file (this was not necessary when using Ruby 2.2.4)
  result = method_hash.sort_by { |_key, value| value }.to_h.keys

  result
end

#run(runner, user_arguments) ⇒ Object

define what happens when the measure is run



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
 
# File 'lib/measures/example_report/measure.rb', line 73

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

  # get sql, model, and web assets
  setup = OsLib_Reporting_example.setup(runner)
  unless setup
    return false
  end
  model = setup[:model]
  # workspace = setup[:workspace]
  sql_file = setup[:sqlFile]
  web_asset_path = setup[:web_asset_path]

  # assign the user inputs to variables
  args = runner.getArgumentValues(arguments, user_arguments)
  args = Hash[args.collect{ |k, v| [k.to_s, v] }]
  unless args
    return false
  end

  # reporting final condition
  runner.registerInitialCondition('Gathering data from EnergyPlus SQL file and OSM model.')

  # pass measure display name to erb
  @name = name

  # create a array of sections to loop through in erb file
  @sections = []

  # generate data for requested sections
  sections_made = 0
  possible_sections.each do |method_name|
    next unless args[method_name]
    section = false
    eval("section = OsLib_Reporting_example.#{method_name}(model,sql_file,runner,false)")
    display_name = eval("OsLib_Reporting_example.#{method_name}(nil,nil,nil,true)[:title]")
    if section
      @sections << section
      sections_made += 1
      # look for emtpy tables and warn if skipped because returned empty
      section[:tables].each do |table|
        if !table
          runner.registerWarning("A table in #{display_name} section returned false and was skipped.")
          section[:messages] = ["One or more tables in #{display_name} section returned false and was skipped."]
        end
      end
    else
      runner.registerWarning("#{display_name} section returned false and was skipped.")
      section = {}
      section[:title] = display_name.to_s
      section[:tables] = []
      section[:messages] = []
      section[:messages] << "#{display_name} section returned false and was skipped."
      @sections << section
    end
  rescue StandardError => e
    display_name = eval("OsLib_Reporting_example.#{method_name}(nil,nil,nil,true)[:title]")
    if display_name.nil? then display_name == method_name end
    runner.registerWarning("#{display_name} section failed and was skipped because: #{e}. Detail on error follows.")
    runner.registerWarning(e.backtrace.join("\n").to_s)

    # add in section heading with message if section fails
    section = eval("OsLib_Reporting_example.#{method_name}(nil,nil,nil,true)")
    section[:title] = display_name.to_s
    section[:tables] = []
    section[:messages] = []
    section[:messages] << "#{display_name} section failed and was skipped because: #{e}. Detail on error follows."
    section[:messages] << [e.backtrace.join("\n").to_s]
    @sections << section
  end

  # read in template
  html_in_path = "#{File.dirname(__FILE__)}/resources/report.html.erb"
  if File.exist?(html_in_path)
    html_in_path = html_in_path
  else
    html_in_path = "#{File.dirname(__FILE__)}/report.html.erb"
  end
  html_in = ''
  File.open(html_in_path, 'r') do |file|
    html_in = file.read
  end

  # configure template with variable values
  renderer = ERB.new(html_in)
  html_out = renderer.result(binding)

  # write html file
  html_out_path = './report.html'
  File.open(html_out_path, 'w') do |file|
    file << html_out
    # make sure data is written to the disk one way or the other
    begin
      file.fsync
    rescue StandardError
      file.flush
    end
  end

  # closing the sql file
  sql_file.close

  # reporting final condition
  runner.registerFinalCondition("Generated report with #{sections_made} sections to #{html_out_path}.")

  true
end