Sha256: c26fc42e9222ed104f1d7ba1f9c49d530a1a421166bfe045e73b0d256fa4a6b2
Contents?: true
Size: 1.85 KB
Versions: 7
Compression:
Stored size: 1.85 KB
Contents
# *******************************************************************************
# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
# See also https://openstudio.net/license
# *******************************************************************************
module OsLib_QAQC
# include any general notes about QAQC method here
# checks the number of unmet hours in the model
def check_placeholder(category, name_only = false)
# summary of the check
check_elems = OpenStudio::AttributeVector.new
check_elems << OpenStudio::Attribute.new('name', 'Place Holder Check')
check_elems << OpenStudio::Attribute.new('category', category)
check_elems << OpenStudio::Attribute.new('description', 'This does nothing, it will just throw a flag until I add real check code to the method.')
# stop here if only name is requested this is used to populate display name for arguments
if name_only == true
results = []
check_elems.each do |elem|
results << elem.valueAsString
end
return results
end
begin
# TODO: - implement QAQC check code here
# remove this once code is written to do real checks
check_elems << OpenStudio::Attribute.new('flag', 'Code has not been implemented yet for this QAQC check')
rescue StandardError => e
# brief description of ruby error
check_elems << OpenStudio::Attribute.new('flag', "Error prevented QAQC check from running (#{e}).")
# backtrace of ruby error for diagnostic use
if @error_backtrace then check_elems << OpenStudio::Attribute.new('flag', e.backtrace.join("\n").to_s) end
end
# add check_elms to new attribute
check_elem = OpenStudio::Attribute.new('check', check_elems)
return check_elem
# note: registerWarning and registerValue will be added for checks downstream using os_lib_reporting_qaqc.rb
end
end
Version data entries
7 entries across 7 versions & 2 rubygems