diff --git a/README.md b/README.md index 3e81579..cf1855b 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ The table below maps in detail the BuildingSync XML data to measure inputs. Note | | climate_zone | get_climate_zone | either `.../Site/ClimateZoneType/ASHRAE/ClimateZone` or `.../Site/ClimateZoneType/CaliforniaTitle24/ClimateZone` depending on standard | | [create_bar_from_building_type_ratios] | | | | | | bldg_type_a | get_building_type_and_bar_division_method | `.../Building/OccupancyClassification` + requirements for `get_total_floor_area` (+ requirements for `get_floor_above_grade` lest defaulted to 1 + requirements for `get_floor_below_grade` lest defaulted to 0) | -| | total_bldg_floor_area | get_total_floor_area | at least one entry of `/FloorArea` in either `.../Site/FloorAreas/` or `.../Building/FloorAreas/`, with `FloorAreaType` of "Gross", "Conditioned", "Common", "Heated and Cooled", "Heated Only", "Cooled Only", "Conditioned above grade", or "Conditioned below grade" | +| | total_bldg_floor_area | get_total_floor_area | at least one entry of `/FloorArea` in either `.../Building/FloorAreas/` or `.../Site/FloorAreas/` (Building is used when both have one), with `FloorAreaType` of "Gross", "Conditioned", "Common", "Heated and Cooled", "Heated Only", "Cooled Only", "Conditioned above grade", or "Conditioned below grade" | | | floor_height | get_floor_to_floor_height | at least on entry of `.../Building/Sections/Section` with entry `/FloorToFloorHeight` | | | num_stories_above_grade | get_floor_above_grade | either `.../Building/FloorsAboveGrade` or `.../Building/ConditionedFloorsAboveGrade` and `.../Building/UnconditionedFloorsAboveGrade` | | | num_stories_below_grade | get_floor_below_grade | either `.../Building/FloorsBelowGrade` or `.../Building/ConditionedFloorsBelowGrade` and `.../Building/UnconditionedFloorsBelowGrade` | diff --git a/lib/BOSS/buildingsync_reader/buildingsync_reader.rb b/lib/BOSS/buildingsync_reader/buildingsync_reader.rb index 299ef12..085fdf5 100644 --- a/lib/BOSS/buildingsync_reader/buildingsync_reader.rb +++ b/lib/BOSS/buildingsync_reader/buildingsync_reader.rb @@ -6,6 +6,8 @@ require 'json' require 'openstudio-standards' +require 'BOSS/boss_logger' +require 'BOSS/constants' require_relative 'systems_map' require_relative 'bcl_weather_file_downloader' include Math @@ -176,7 +178,15 @@ def get_building_type_and_bar_division_method # tries to get total floor area from: # 1. /FloorAreas of building # 2. /FloorAreas of site + # The building is more specific than the site, so its value wins when both are present. def get_total_floor_area(num_indent=2) + # check building floor area + BOSS.BOSS_logger.info("#{"|\t"*num_indent}- checking building for total floor area...") + building_floor_areas_xml = @building_xml.nil? ? nil : @building_xml.elements["#{@ns}FloorAreas"] + building_area = !building_floor_areas_xml.nil? ? _get_total_floor_area_from_floor_areas_xml(building_floor_areas_xml, num_indent+1) : 0 + BOSS.BOSS_logger.info("#{"|\t"*num_indent} building floor area is #{building_area}") + return building_area if building_area > 0 + # check site floor area BOSS.BOSS_logger.info("#{"|\t"*num_indent}- checking site for total floor area...") site_floor_areas_xml = @site_xml.elements["#{@ns}FloorAreas"] @@ -184,13 +194,6 @@ def get_total_floor_area(num_indent=2) BOSS.BOSS_logger.info("#{"|\t"*num_indent} site floor area is #{site_area}") return site_area if site_area > 0 - # check building floor area - BOSS.BOSS_logger.info("#{"|\t"*num_indent}- checking building for total floor area...") - building_floor_areas_xml = @building_xml.elements["#{@ns}FloorAreas"] - building_area = !building_floor_areas_xml.nil? ? _get_total_floor_area_from_floor_areas_xml(building_floor_areas_xml, num_indent+1) : 0 - BOSS.BOSS_logger.info("#{"|\t"*num_indent} building floor area is #{building_area}") - return building_area if building_area > 0 - # TODO: read sections end diff --git a/spec/tests/unit/buildingsync_reader_spec.rb b/spec/tests/unit/buildingsync_reader_spec.rb index 91d9d2a..9b61fee 100644 --- a/spec/tests/unit/buildingsync_reader_spec.rb +++ b/spec/tests/unit/buildingsync_reader_spec.rb @@ -234,6 +234,55 @@ def wrap_in_systems(xml) end describe 'get_total_floor_area should' do + def floor_areas(gross) + <<~XML + + + Gross + #{gross} + + + XML + end + + def site_with_building(site_xml, building_xml) + wrap_in_site(<<~XML) + #{site_xml} + + + #{building_xml} + + + XML + end + + it "prefer building over site when both have floor area" do + doc = REXML::Document.new site_with_building(floor_areas(20000), floor_areas(15000)) + buidingsync_reader = BOSS::BuildingSyncReader.new(doc, nil, ASHRAE90_1) + + expect(buidingsync_reader.get_total_floor_area).to eq 15000 + end + + it "get from building" do + doc = REXML::Document.new site_with_building('', floor_areas(15000)) + buidingsync_reader = BOSS::BuildingSyncReader.new(doc, nil, ASHRAE90_1) + + expect(buidingsync_reader.get_total_floor_area).to eq 15000 + end + + it "fall back to site when building has no floor area" do + doc = REXML::Document.new site_with_building(floor_areas(20000), '') + buidingsync_reader = BOSS::BuildingSyncReader.new(doc, nil, ASHRAE90_1) + + expect(buidingsync_reader.get_total_floor_area).to eq 20000 + end + + it "get from site when building is missing" do + doc = REXML::Document.new wrap_in_site(floor_areas(20000)) + buidingsync_reader = BOSS::BuildingSyncReader.new(doc, nil, ASHRAE90_1) + + expect(buidingsync_reader.get_total_floor_area).to eq 20000 + end end describe 'get_floor_above_grade should' do