Module: OsLib_Reporting

Defined in:
lib/openstudio/extension/core/os_lib_reporting_qaqc.rb

Class Method Summary collapse

Class Method Details

.gen_html(html_in_path, web_asset_path, sections, name) ⇒ Object

cleanup - prep html



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
 
# File 'lib/openstudio/extension/core/os_lib_reporting_qaqc.rb', line 78

def self.gen_html(html_in_path, web_asset_path, sections, name)
  # instance variables for erb
  @sections = sections
  @name = name

  # read in template
  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

  return html_out_path
end

.sections_from_check_attributes(check_elems, runner) ⇒ Object

developer notes method below is custom version of standard OpenStudio results methods. It passes an array of sections vs. a single section. It doesn't use the model or SQL file. It just gets data form OpenStudio attributes passed in It doesn't have a name_only section since it doesn't populate user arguments



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
 
# File 'lib/openstudio/extension/core/os_lib_reporting_qaqc.rb', line 118

def self.sections_from_check_attributes(check_elems, runner)
  # inspecting check attributes
  # make single table with checks.
  # make second table with flag description (with column for where it came from)

  # array to hold sections
  sections = []

  # gather data for section
  qaqc_check_summary = {}
  qaqc_check_summary[:title] = 'List of Checks in Measure'
  qaqc_check_summary[:header] = ['Name', 'Category', 'Flags', 'Description']
  qaqc_check_summary[:data] = []
  qaqc_check_summary[:data_color] = []
  @qaqc_check_section = {}
  @qaqc_check_section[:title] = 'QAQC Check Summary'
  @qaqc_check_section[:tables] = [qaqc_check_summary]

  # add sections to array
  sections << @qaqc_check_section

  # counter for flags thrown
  num_flags = 0

  check_elems.each do |check|
    # gather data for section
    qaqc_flag_details = {}
    qaqc_flag_details[:title] = "List of Flags Triggered for #{check.valueAsAttributeVector.first.valueAsString}."
    qaqc_flag_details[:header] = ['Flag Detail']
    qaqc_flag_details[:data] = []
    @qaqc_flag_section = {}
    @qaqc_flag_section[:title] = check.valueAsAttributeVector.first.valueAsString.to_s
    @qaqc_flag_section[:tables] = [qaqc_flag_details]

    check_name = nil
    check_cat = nil
    check_desc = nil
    flags = []
    # loop through attributes (name,category,description,then optionally one or more flag attributes)
    check.valueAsAttributeVector.each_with_index do |value, index|
      if index == 0
        check_name = value.valueAsString
      elsif index == 1
        check_cat = value.valueAsString
      elsif index == 2
        check_desc = value.valueAsString
      else # should be flag
        flags << value.valueAsString
        qaqc_flag_details[:data] << [value.valueAsString]
        runner.registerWarning("#{check_name} - #{value.valueAsString}")
        num_flags += 1
      end
    end

    # add row to table for this check
    qaqc_check_summary[:data] << [check_name, check_cat, flags.size, check_desc]

    # add info message for check if no flags found (this way user still knows what ran)
    if check.valueAsAttributeVector.size < 4
      runner.registerInfo("#{check_name} - no flags.")
    end

    # color cells based and add runner register values based on flag status
    if !flags.empty?
      qaqc_check_summary[:data_color] << ['', '', 'indianred', '']
      runner.registerValue(check_name.downcase.tr(' ', '_'), flags.size, 'flags')
    else
      qaqc_check_summary[:data_color] << ['', '', 'lightgreen', '']
      runner.registerValue(check_name.downcase.tr(' ', '_'), flags.size, 'flags')
    end

    # add table for this check if there are flags
    if !qaqc_flag_details[:data].empty?
      sections << @qaqc_flag_section
    end
  end

  # add total flags registerValue
  runner.registerValue('total_qaqc_flags', num_flags, 'flags')

  return sections
end

.setup(runner) ⇒ Object

setup - get model, sql, and setup web assets path



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
 
# File 'lib/openstudio/extension/core/os_lib_reporting_qaqc.rb', line 40

def self.setup(runner)
  results = {}

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

  # get the last idf
  workspace = runner.lastEnergyPlusWorkspace
  if workspace.empty?
    runner.registerError('Cannot find last idf file.')
    return false
  end
  workspace = workspace.get

  # get the last sql file
  sqlFile = runner.lastEnergyPlusSqlFile
  if sqlFile.empty?
    runner.registerError('Cannot find last sql file.')
    return false
  end
  sqlFile = sqlFile.get
  model.setSqlFile(sqlFile)

  # populate hash to pass to measure
  results[:model] = model
  # results[:workspace] = workspace
  results[:sqlFile] = sqlFile
  results[:web_asset_path] = OpenStudio.getSharedResourcesPath / OpenStudio::Path.new('web_assets')

  return results
end