Merge branch 'master' of https://github.com/NREL/OpenStudio-HPXML into stochastic_occupancy_paper

# Conflicts:
#	BuildResidentialScheduleFile/measure.xml

Author: shorowit

BuildResidentialHPXML/measure.rb

@@ -3440,7 +3440,7 @@ def arguments(model) # rubocop:disable Lint/UnusedMethodArgument
   # @param model [OpenStudio::Model::Model] OpenStudio Model object
   # @param runner [OpenStudio::Measure::OSRunner] OpenStudio Runner object
   # @param user_arguments [OpenStudio::Measure::OSArgumentMap] OpenStudio measure arguments
-  # @return [Boolean] TODO
+  # @return [Boolean] true if successful
   def run(model, runner, user_arguments)
     super(model, runner, user_arguments)
 
@@ -3982,7 +3982,7 @@ def self.unavailable_period_exists(hpxml, column_name, begin_month, begin_day, b
   # @param runner [OpenStudio::Measure::OSRunner] OpenStudio Runner object
   # @param hpxml [HPXML] HPXML object
   # @param args [Hash] Map of :argument_name => value
-  # @return [Boolean] TODO
+  # @return [Boolean] true if no errors, otherwise false
   def self.set_header(runner, hpxml, args)
     errors = []
 
@@ -4647,7 +4647,7 @@ def self.set_air_infiltration_measurements(hpxml_bldg, args)
   #
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param args [Hash] Map of :argument_name => value
-  # @param sorted_surfaces [TODO] TODO
+  # @param sorted_surfaces [Array<OpenStudio::Model::Surface>] surfaces sorted by deterministically assigned Index
   def self.set_roofs(hpxml_bldg, args, sorted_surfaces)
     args[:geometry_roof_pitch] *= 12.0
     if (args[:geometry_attic_type] == HPXML::AtticTypeFlatRoof) || (args[:geometry_attic_type] == HPXML::AtticTypeBelowApartment)
@@ -4695,7 +4695,7 @@ def self.set_roofs(hpxml_bldg, args, sorted_surfaces)
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param model [OpenStudio::Model::Model] OpenStudio Model object
   # @param args [Hash] Map of :argument_name => value
-  # @param sorted_surfaces [TODO] TODO
+  # @param sorted_surfaces [Array<OpenStudio::Model::Surface>] surfaces sorted by deterministically assigned Index
   def self.set_rim_joists(hpxml_bldg, model, args, sorted_surfaces)
     sorted_surfaces.each do |surface|
       next if surface.surfaceType != 'Wall'
@@ -4757,7 +4757,7 @@ def self.set_rim_joists(hpxml_bldg, model, args, sorted_surfaces)
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param model [OpenStudio::Model::Model] OpenStudio Model object
   # @param args [Hash] Map of :argument_name => value
-  # @param sorted_surfaces [TODO] TODO
+  # @param sorted_surfaces [Array<OpenStudio::Model::Surface>] surfaces sorted by deterministically assigned Index
   def self.set_walls(hpxml_bldg, model, args, sorted_surfaces)
     sorted_surfaces.each do |surface|
       next if surface.surfaceType != 'Wall'
@@ -4850,7 +4850,7 @@ def self.set_walls(hpxml_bldg, model, args, sorted_surfaces)
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param model [OpenStudio::Model::Model] OpenStudio Model object
   # @param args [Hash] Map of :argument_name => value
-  # @param sorted_surfaces [TODO] TODO
+  # @param sorted_surfaces [Array<OpenStudio::Model::Surface>] surfaces sorted by deterministically assigned Index
   def self.set_foundation_walls(hpxml_bldg, model, args, sorted_surfaces)
     sorted_surfaces.each do |surface|
       next if surface.surfaceType != 'Wall'
@@ -4936,7 +4936,7 @@ def self.set_foundation_walls(hpxml_bldg, model, args, sorted_surfaces)
   #
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param args [Hash] Map of :argument_name => value
-  # @param sorted_surfaces [TODO] TODO
+  # @param sorted_surfaces [Array<OpenStudio::Model::Surface>] surfaces sorted by deterministically assigned Index
   def self.set_floors(hpxml_bldg, args, sorted_surfaces)
     if [HPXML::FoundationTypeBasementConditioned,
         HPXML::FoundationTypeCrawlspaceConditioned].include?(args[:geometry_foundation_type]) && (args[:floor_over_foundation_assembly_r] > 2.1)
@@ -5018,7 +5018,7 @@ def self.set_floors(hpxml_bldg, args, sorted_surfaces)
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param model [OpenStudio::Model::Model] OpenStudio Model object
   # @param args [Hash] Map of :argument_name => value
-  # @param sorted_surfaces [TODO] TODO
+  # @param sorted_surfaces [Array<OpenStudio::Model::Surface>] surfaces sorted by deterministically assigned Index
   def self.set_slabs(hpxml_bldg, model, args, sorted_surfaces)
     sorted_surfaces.each do |surface|
       next unless ['Foundation'].include? surface.outsideBoundaryCondition
@@ -5088,7 +5088,7 @@ def self.set_slabs(hpxml_bldg, model, args, sorted_surfaces)
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param model [OpenStudio::Model::Model] OpenStudio Model object
   # @param args [Hash] Map of :argument_name => value
-  # @param sorted_surfaces [TODO] TODO
+  # @param sorted_subsurfaces [Array<OpenStudio::Model::SubSurface>] subsurfaces sorted by deterministically assigned Index
   def self.set_windows(hpxml_bldg, model, args, sorted_subsurfaces)
     sorted_subsurfaces.each do |sub_surface|
       next if sub_surface.subSurfaceType != 'FixedWindow'
@@ -5164,7 +5164,7 @@ def self.set_windows(hpxml_bldg, model, args, sorted_subsurfaces)
   #
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param args [Hash] Map of :argument_name => value
-  # @param sorted_subsurfaces [TODO] TODO
+  # @param sorted_subsurfaces [Array<OpenStudio::Model::SubSurface>] subsurfaces sorted by deterministically assigned Index
   def self.set_skylights(hpxml_bldg, args, sorted_subsurfaces)
     sorted_subsurfaces.each do |sub_surface|
       next if sub_surface.subSurfaceType != 'Skylight'
@@ -5204,7 +5204,7 @@ def self.set_skylights(hpxml_bldg, args, sorted_subsurfaces)
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param model [OpenStudio::Model::Model] OpenStudio Model object
   # @param args [Hash] Map of :argument_name => value
-  # @param sorted_subsurfaces [TODO] TODO
+  # @param sorted_subsurfaces [Array<OpenStudio::Model::SubSurface>] subsurfaces sorted by deterministically assigned Index
   def self.set_doors(hpxml_bldg, model, args, sorted_subsurfaces)
     sorted_subsurfaces.each do |sub_surface|
       next if sub_surface.subSurfaceType != 'Door'
@@ -5912,11 +5912,11 @@ def self.set_duct_leakages(args, hvac_distribution)
                                                     duct_leakage_total_or_to_outside: HPXML::DuctLeakageToOutside)
   end
 
-  # Get the specific HPXML location based on general location and foundation/attic type
+  # Get the specific HPXML foundation or attic location based on general HPXML location and specific HPXML foundation or attic type.
   #
-  # @param location [TODO] TODO
-  # @param foundation_type [TODO] TODO
-  # @param attic_type [TODO] TODO
+  # @param location [String] the general HPXML location (crawlspace or attic)
+  # @param foundation_type [String] the specific HPXML foundation type (unvented crawlspace, vented crawlspace, conditioned crawlspace)
+  # @param attic_type [String] the specific HPXML attic type (unvented attic, vented attic, conditioned attic)
   def self.get_location(location, foundation_type, attic_type)
     return if location.nil?
 
@@ -5952,7 +5952,7 @@ def self.get_location(location, foundation_type, attic_type)
   #
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param args [Hash] Map of :argument_name => value
-  # @param hvac_distribution [TODO] TODO
+  # @param hvac_distribution [HPXML::HVACDistribution] HPXML HVAC Distribution object
   def self.set_ducts(hpxml_bldg, args, hvac_distribution)
     ducts_supply_location = get_location(args[:ducts_supply_location], hpxml_bldg.foundations[-1].foundation_type, hpxml_bldg.attics[-1].attic_type)
     ducts_return_location = get_location(args[:ducts_return_location], hpxml_bldg.foundations[-1].foundation_type, hpxml_bldg.attics[-1].attic_type)
@@ -6069,7 +6069,7 @@ def self.set_ducts(hpxml_bldg, args, hvac_distribution)
   # @param hpxml [HPXML] HPXML object
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param args [Hash] Map of :argument_name => value
-  # @param epw_file [OpenStudio::EpwFile] TODO
+  # @param epw_file [OpenStudio::EpwFile] OpenStudio EpwFile object
   # @param weather [WeatherProcess] Weather object
   def self.set_hvac_control(hpxml, hpxml_bldg, args, epw_file, weather)
     return if (args[:heating_system_type] == 'none') && (args[:cooling_system_type] == 'none') && (args[:heat_pump_type] == 'none')
@@ -6488,7 +6488,7 @@ def self.set_water_fixtures(hpxml_bldg, args)
   #
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param args [Hash] Map of :argument_name => value
-  # @param epw_file [OpenStudio::EpwFile] TODO
+  # @param epw_file [OpenStudio::EpwFile] OpenStudio EpwFile object
   def self.set_solar_thermal(hpxml_bldg, args, epw_file)
     return if args[:solar_thermal_system_type] == 'none'
 
@@ -6537,7 +6537,7 @@ def self.set_solar_thermal(hpxml_bldg, args, epw_file)
   #
   # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
   # @param args [Hash] Map of :argument_name => value
-  # @param epw_file [OpenStudio::EpwFile] TODO
+  # @param epw_file [OpenStudio::EpwFile] OpenStudio EpwFile object
   def self.set_pv_systems(hpxml_bldg, args, epw_file)
     return unless args[:pv_system_present]
 

BuildResidentialHPXML/measure.xml

@@ -3,8 +3,8 @@
   <schema_version>3.1</schema_version>
   <name>build_residential_hpxml</name>
   <uid>a13a8983-2b01-4930-8af2-42030b6e4233</uid>
-  <version_id>e32945f6-3cb8-4f34-95fe-cf1733b6f48e</version_id>
-  <version_modified>2024-06-05T21:34:41Z</version_modified>
+  <version_id>5bba0282-12b2-4602-b7cf-7242adce2cab</version_id>
+  <version_modified>2024-06-20T23:43:28Z</version_modified>
   <xml_checksum>2C38F48B</xml_checksum>
   <class_name>BuildResidentialHPXML</class_name>
   <display_name>HPXML Builder</display_name>
@@ -7360,13 +7360,13 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>D0586A5E</checksum>
+      <checksum>D8FCCD88</checksum>
     </file>
     <file>
       <filename>geometry.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>A5BBD88A</checksum>
+      <checksum>F6952477</checksum>
     </file>
     <file>
       <filename>test_build_residential_hpxml.rb</filename>