openstudio-standards 0.4.0 → 0.5.0

data/lib/openstudio-standards/btap/btap.model.rb

@@ -472,7 +472,7 @@
 #
 #   #This method will set the infiltration magnitude.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param self [OpenStudio::model::Model] A model object
+#   #@param self [OpenStudio::Model::Model] A model object
 #   #@param setDesignFlowRate [Float]
 #   #@param setFlowperSpaceFloorArea [Float]
 #   #@param setFlowperExteriorSurfaceArea [Float]
@@ -509,7 +509,7 @@
 #
 #   #This method will scale people loads schedule.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param a_coef [Float]
 #   #@param b_coef [Float]
 #   #@param c_coef [Float]
@@ -528,7 +528,7 @@
 #
 #   #This method will scale lighting loads.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param factor [Float]
 #   def scale_lighting_loads(factor)
 #     self.getLightss.sort.each do |item|
@@ -538,7 +538,7 @@
 #
 #   #This method will scale lighting loads schedule.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param a_coef [Float]
 #   #@param b_coef [Float]
 #   #@param c_coef [Float]
@@ -557,7 +557,7 @@
 #
 #   #This method will scale electrical loads.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param factor [Float]
 #   def scale_electrical_loads(model, factor)
 #     self.getElectricEquipments.sort.each do |item|
@@ -567,7 +567,7 @@
 #
 #   #This method will scale electrical loads schedule.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param a_coef [Float]
 #   #@param b_coef [Float]
 #   #@param c_coef [Float]
@@ -585,7 +585,7 @@
 #
 #   #This method will scale Outdoor Air loads.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param factor [Float]
 #   def scale_oa_loads(factor)
 #     self.getDesignSpecificationOutdoorAirs.sort.each do |oa_def|
@@ -598,7 +598,7 @@
 #
 #   #This method will scale infiltration loads.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   #@param factor [Float]
 #   def scale_inflitration_loads(factor)
 #     self.getSpaceInfiltrationDesignFlowRates.sort.each do |infiltration_load|
@@ -612,7 +612,7 @@
 #   # Elimination Methods
 #   #This method removes people loads from the model.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   def eliminate_all_people_loads()
 #     self.getPeoples.sort.each {|people| people.remove}
 #     self.getPeopleDefinitions.sort.each {|people| people.remove}
@@ -621,7 +621,7 @@
 #
 #   #This method removes light loads from model.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   def eliminate_all_lighting_loads()
 #     self.getLightss.sort.each {|item| item.remove}
 #     self.getLightsDefinitions.sort.each {|item| item.remove}
@@ -630,7 +630,7 @@
 #
 #   #This method removes elec loads from model.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   def eliminate_all_electric_loads()
 #     self.getElectricEquipments.sort.each {|item| item.remove}
 #     self.getElectricEquipmentDefinitions.sort.each {|item| item.remove}
@@ -639,7 +639,7 @@
 #
 #   #This method removes all design specification OA from model.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   def eliminate_all_design_specification_outdoor_air()
 #     self.getDesignSpecificationOutdoorAirs.sort.each {|item| item.remove}
 #     return self
@@ -647,7 +647,7 @@
 #
 #   #This method removes infiltration from model..
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   def eliminate_all_space_infiltration_design_flow_rates()
 #     self.getSpaceInfiltrationDesignFlowRates.sort.each {|item| item.remove}
 #     return self
@@ -655,7 +655,7 @@
 #
 #   #This method removes all space loads from model.
 #   #@author phylroy.lopez@nrcan.gc.ca
-#   #@param model [OpenStudio::model::Model] A model object
+#   #@param model [OpenStudio::Model::Model] A model object
 #   def eliminate_all_loads()
 #     conductance = 0.200
 #

data/lib/openstudio-standards/btap/btap.rb

@@ -186,7 +186,7 @@ module BTAP
   module SimulationSettings
     #This sets the simulation period for the model. All arguments are integers.
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
+    #@param model [OpenStudio::Model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
     #@param start_month [Integer] a list of output variables that you wish to report from the simulation.
     #@param start_day [Integer] a list of output variables that you wish to report from the simulation.
     #@param end_month [Integer] a list of output variables that you wish to report from the simulation.
@@ -208,7 +208,7 @@ module BTAP
     #This method clears all the output variables to make simulations run faster or to
     #start fresh.
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
+    #@param model [OpenStudio::Model::Model] A model object {http://openstudio.nrel.gov/latest-c-sdk-documentation/model}
     #@return [OpenStudio::Model::Model] the OpenStudio model object (self reference).
     def self.clear_output_variables(model)
       #remove existing outputs
@@ -220,7 +220,7 @@ module BTAP
 
     #This turns all output on. Warning: Long runtimes will result.
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object
+    #@param model [OpenStudio::Model::Model] A model object
     #@param frequency [Fixnum]
     #@return [OpenStudio::Model::Model] a copy of the OpenStudio model object (self reference).
     def self.all_output_variables(model,frequency)
@@ -231,7 +231,7 @@ module BTAP
     #This method returns a vector of the results that are available in the current
     #model.
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object
+    #@param model [OpenStudio::Model::Model] A model object
     #@return [Array<String>] a list of all the possible output variables.
     def self.get_possible_output_variables( model )
       #Run simulation
@@ -256,7 +256,7 @@ module BTAP
 
     #This method sets up some predetermined output variables. May take a while to run with these settings.
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object
+    #@param model [OpenStudio::Model::Model] A model object
     #@param frequency [Fixnum]
     #@param output_variable_array [Array<String>] a list of output variables that you wish to report from the simulation.
     #@return [OpenStudio::Model::Model] the OpenStudio model object (self reference).
@@ -276,7 +276,7 @@ module BTAP
     #This method sets the weather file for the model.
     #It takes a simple string, remember to escape the slashes..(i.e. // not / )
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object
+    #@param model [OpenStudio::Model::Model] A model object
     #@param  epw_path [String] a simple string of the epw file path, remember to escape the slashes..(i.e. // not / )
     def self.set_weather_file(model, epw_path)
       BTAP::Environment::WeatherFile.new(epw_path).set_weather_file(model)
@@ -289,7 +289,7 @@ module BTAP
     #This model checks to see if the obj_array passed is
     #the object we require, or if a string is given to search for a object of that strings name.
     #@author Phylroy A. Lopez
-    #@param model [OpenStudio::model::Model] A model object
+    #@param model [OpenStudio::Model::Model] A model object
     #@param obj_array <Object>
     #@param object_type [Object]
     def self.validate_array(model,obj_array,object_type)

data/lib/openstudio-standards/btap/btap_result.rb

@@ -1039,7 +1039,7 @@ def necb_2011_qaqc(qaqc, model)
     end
   end
 
-  #*TODO*
+  # @todo ?
   necb_section_name = "NECB2011-5.2.10.1"
   qaqc[:air_loops].each do |air_loop_info|
     unless air_loop_info[:supply_fan][:max_air_flow_rate_m3_per_s] == -1.0

data/lib/openstudio-standards/btap/economics.rb

@@ -27,7 +27,7 @@
 #
 #       #This method removes all costs from model
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@param runner [String]
 #       def self.remove_all_costs(model,runner = nil)
 #         #Remove all cost items.
@@ -39,11 +39,11 @@
 #
 #       #This method will add the costs.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@param name [String]
 #       #@param cost [Float]
 #       #@param unittype [String]
-#       #return cost_object [OpenStudio::model::Model] A model object
+#       #return cost_object [OpenStudio::Model::Model] A model object
 #       def self.object_cost(model,name,cost,unittype)
 #         unless cost.nil? or cost == 0.0
 #           #add total construction cost if used in place of each construction.
@@ -57,7 +57,7 @@
 #
 #       #This method will add the cost per building.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@param name [String]
 #       #@param cost [Float]
 #       #@param runner [Float]
@@ -73,7 +73,7 @@
 #
 #       #This method will add the cost per total area.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@param name [String]
 #       #@param cost [Float]
 #       #@param runner [Float]
@@ -89,7 +89,7 @@
 #
 #       #This method will set the ecm envelope.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@param library_file_path [String]
 #       #@param default_construction_set_name [String]
 #       #@param ext_wall_rsi [Float]
@@ -259,7 +259,7 @@
 #
 #       #This method will set the ecm infiltration.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@param infiltration_design_flow_rate [Float]
 #       #@param infiltration_flow_per_space [Float]
 #       #@param infiltration_flow_per_exterior_area [Float]
@@ -321,7 +321,7 @@
 #
 #       #This method will set the ecm fans.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_fans( model )
 #         measure_values =
@@ -413,7 +413,7 @@
 #
 #       #This method will set the ecm pumps.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_pumps( model )
 #         measure_values =
@@ -508,7 +508,7 @@
 #
 #       #This method will set the ecm cooling COP.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       def ecm_cooling_cop( model )
 #         log = ""
 #         measure_values =[
@@ -551,7 +551,7 @@
 #
 #       #This method will set the ecm economizers.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_economizers( model )
 #
@@ -582,7 +582,7 @@
 #       end
 #       #This method will set the ecm sizing.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] table
 #       def ecm_sizing( model)
 #         measure_values =[
@@ -616,7 +616,7 @@
 #
 #       #This method will set the ecm domestic hot water.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_dhw( model )
 #         log = "shw_setpoint_sched,shw_heater_fuel_type,shw_thermal_eff\n"
@@ -646,7 +646,7 @@
 #
 #       #This method will set the ecm chotwater boilers.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] table
 #       def ecm_hotwater_boilers( model )
 #         measure_values = [
@@ -762,7 +762,7 @@
 #
 #       #This method will set the ecm dcv.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_dcv( model )
 #         log = ""
@@ -779,7 +779,7 @@
 #
 #       #This method will set the ecm heating and cooling setpoints.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_heating_cooling_setpoints(model)
 #
@@ -833,7 +833,7 @@
 #
 #       #This method will set the ecm erv.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_erv( model )
 #         log = ""
@@ -907,7 +907,7 @@
 #
 #       #This method will set the ecm cexhaust fans.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_exhaust_fans( model )
 #         log = ""
@@ -928,7 +928,7 @@
 #
 #       #This method will set the ecm lighting.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_lighting( model )
 #         log = ""
@@ -955,7 +955,7 @@
 #
 #       #This method will set the ecm temperature setback.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_plugs( model )
 #         log = ""
@@ -986,7 +986,7 @@
 #
 #       #This method will set the ecm cold deck reset control.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_cold_deck_reset_control( model )
 #         log = ""
@@ -1042,7 +1042,7 @@
 #
 #       #This method will reset the sat ecm.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_sat_reset( model )
 #         log = ""
@@ -1082,7 +1082,7 @@
 #
 #       #This method will set the ecm temperature setback.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@return [String] log
 #       def ecm_temp_setback( model )
 #         log = ""

data/lib/openstudio-standards/btap/envelope.rb

@@ -27,7 +27,7 @@ module BTAP
 
       #This method removes all materials from model.
       #@author phylroy.lopez@nrcan.gc.ca
-      #@param model [OpenStudio::model::Model] A model object
+      #@param model [OpenStudio::Model::Model] A model object
       def self.remove_all_materials(model)
         model.getMaterials().each do |item|
           item.remove
@@ -36,28 +36,28 @@ module BTAP
 
       #This method removes all constructions from model.
       #@author phylroy.lopez@nrcan.gc.ca
-      #@param model [OpenStudio::model::Model] A model object
+      #@param model [OpenStudio::Model::Model] A model object
       def self.remove_all_constructions(model)
         model.getConstructions().each { |item| item.remove }
       end
 
       #This method removes all default surface constructions from model.
       #@author phylroy.lopez@nrcan.gc.ca
-      #@param model [OpenStudio::model::Model] A model object
+      #@param model [OpenStudio::Model::Model] A model object
       def self.remove_all_default_surface_constructions(model)
         model.getDefaultSurfaceConstructionss().each { |item| item.remove }
       end
 
       #This method removes all default subsurface constructions from model.
       #@author phylroy.lopez@nrcan.gc.ca
-      #@param model [OpenStudio::model::Model] A model object
+      #@param model [OpenStudio::Model::Model] A model object
       def self.remove_all_default_subsurface_constructions(model)
         model.getDefaultSubSurfaceConstructionss().each { |item| item.remove }
       end
 
       #This method removes all default construction sets from model.
       #@author phylroy.lopez@nrcan.gc.ca
-      #@param model [OpenStudio::model::Model] A model object
+      #@param model [OpenStudio::Model::Model] A model object
       def self.remove_all_default_construction_sets(model)
         model.getDefaultConstructionSets().each { |item| item.remove }
         model.building.get.resetDefaultConstructionSet()
@@ -66,7 +66,7 @@ module BTAP
 
       #This method assignes interior surface construction to adiabatic surfaces from model.
       #@author phylroy.lopez@nrcan.gc.ca
-      #@param model [OpenStudio::model::Model] A model object
+      #@param model [OpenStudio::Model::Model] A model object
       def self.assign_interior_surface_construction_to_adiabatic_surfaces(model, runner = nil)
         BTAP::runner_register("Info", "assign_interior_surface_construction_to_adiabatic_surfaces", runner)
         unless model.building.get.defaultConstructionSet.empty? or model.building.get.defaultConstructionSet.get.defaultInteriorSurfaceConstructions.empty? or model.building.get.defaultConstructionSet.get.defaultInteriorSurfaceConstructions.get.wallConstruction.empty?
@@ -90,7 +90,7 @@ module BTAP
 
       #This method removes all thermal mass definitions from model.
       #@author phylroy.lopez@nrcan.gc.ca
-      #@param model [OpenStudio::model::Model] A model object
+      #@param model [OpenStudio::Model::Model] A model object
       def self.remove_all_thermal_mass_definitions(model)
         model.getInternalMassDefinitions.sort.each { |item| item.remove }
         model.getInternalMasss.sort.each { |item| item.remove }
@@ -98,7 +98,7 @@ module BTAP
 
       #This method removes all envelope information from model.
       #@author phylroy.lopez@nrcan.gc.ca
-      #@param model [OpenStudio::model::Model] A model object
+      #@param model [OpenStudio::Model::Model] A model object
       def self.remove_all_envelope_information(model)
         BTAP::Resources::Envelope::remove_all_materials(model)
         BTAP::Resources::Envelope::remove_all_default_construction_sets(model)

data/lib/openstudio-standards/btap/equest.rb

@@ -2335,7 +2335,7 @@
 #           translation = transformation.translation
 #           euler_angles = transformation.eulerAngles
 #           new_translation = OpenStudio::Vector3d.new(translation.x * x_scale, translation.y * y_scale, translation.z * z_scale)
-#           #TODO these might be in the wrong order
+#           # @todo these might be in the wrong order
 #           new_transformation = OpenStudio::createRotation(euler_angles) * OpenStudio::createTranslation(new_translation)
 #           surface_group.setTransformation(new_transformation)
 #         end

data/lib/openstudio-standards/btap/geometry.rb

@@ -2121,7 +2121,7 @@ module BTAP
     end
 
     # This method will scale the model
-    # @param model [OpenStudio::Model::Model] the model object.
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
     # @param x [Float] x scalar multiplier.
     # @param y [Float] y scalar multiplier.
     # @param z [Float] z scalar multiplier.
@@ -2165,7 +2165,7 @@ module BTAP
 
 
     # This method will rotate the model
-    # @param model [OpenStudio::Model::Model] the model object.
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
     # @param degrees [Float] rotation value
     # @return [OpenStudio::Model::Model] the model object.
     def self.rotate_model(model, degrees)

data/lib/openstudio-standards/btap/mpc.rb

@@ -29,7 +29,7 @@
 #
 #       #This method initializes.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model_file [OpenStudio::model::Model] A model object
+#       #@param model_file [OpenStudio::Model::Model] A model object
 #       #@param weather_file [String] path to a weather file
 #       #@param analysis_folder [String] path to analysis folder
 #       def initialize (
@@ -55,7 +55,7 @@
 #
 #       #This method creates the schedules.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       def create_schedules(model)
 #
 #         #Create cooling temperature schedule
@@ -126,7 +126,7 @@
 #
 #       #This method sets the output variables.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       def set_output_variables(model)
 #         output_variable_array =
 #           [
@@ -237,7 +237,7 @@
 #
 #       #This method miso building generation and returns a model array.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@param standard_weather_file [String] path to a weather file
 #       #@return [model_array<String>]
 #       def miso_building_generation(model,standard_weather_file)
@@ -385,7 +385,7 @@
 #
 #       #This method miso building analysis.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model_file [OpenStudio::model::Model] A model object
+#       #@param model_file [OpenStudio::Model::Model] A model object
 #       #@param folder_name [String] path to a folder
 #       #@param standard_weather_file [String] path to a weather file
 #       def miso_building_analysis(folder_name,model_file,standard_weather_file)
@@ -409,7 +409,7 @@
 #
 #       #This method miso zonal analysis.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model_file [OpenStudio::model::Model] A model object
+#       #@param model_file [OpenStudio::Model::Model] A model object
 #       #@param folder_name [String] path to a folder
 #       #@param standard_weather_file [String] path to a weather file
 #       def miso_zonal_analysis(folder_name,model_file,standard_weather_file)
@@ -433,7 +433,7 @@
 #
 #       #This method miso zonal generation and returns a model array.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model[OpenStudio::model::Model] A model object
+#       #@param model[OpenStudio::Model::Model] A model object
 #       #@param standard_weather_file [String] path to a weather file
 #       #@return [model_array<String>]
 #       def miso_zonal_generation(model,standard_weather_file)

data/lib/openstudio-standards/btap/schedules.rb

@@ -914,7 +914,7 @@ module BTAP
 
       # Creates ScheduleVariableInterval from TimeSeries
       # @author david.goldwasser@nrel.gov
-      # @param model [OpenStudio::model::Model] A model object
+      # @param model [OpenStudio::Model::Model] A model object
       # @param time_series [OpenStudio::TimeSeries] A TimeSeries object
       # @return [OpenStudio::Model::ScheduleInterval] An interval schedule
       def self.create_schedule_variable_interval_from_time_series(model, time_series)

data/lib/openstudio-standards/btap/simmanager.rb

@@ -70,7 +70,7 @@
 #     #This method will run the simulation. You must provide a folder where you wish
 #     #to run the simulation, and if not previously defined, the weather file. This will delete and recreate the folder provided to ensure that it is clean.
 #     #@author Phylroy A. Lopez
-#     #@param model [OpenStudio::model::Model] A model object
+#     #@param model [OpenStudio::Model::Model] A model object
 #     #@param folder_name [String] a simple string of the simulation folder path, remember to escape the slashes..(i.e. // not / )
 #     #@param epw_path [String] a simple string of the epw file path, remember to escape the slashes..(i.e. // not / )
 #     #@return [OpenStudio::Model::Model] the OpenStudio model object (self reference).
@@ -219,7 +219,7 @@
 #
 #       #This method adds the model to the folder.
 #       #@author phylroy.lopez@nrcan.gc.ca
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@param folder [String]
 #       #@return [String] self
 #       def addModel(model, folder = @analysisFolder  )
@@ -670,7 +670,7 @@
 #       #This method copies report files to a single folder for convenience.
 #       #@author phylroy.lopez@nrcan.gc.ca
 #       #@param run_name [String]
-#       #@return [OpenStudio::model::Model] A model object
+#       #@return [OpenStudio::Model::Model] A model object
 #       def processResults(run_name)
 #         #make sql folder
 #         Dir.mkdir(@outdir.to_s+"\\sqlresults") unless File.exists?(@outdir.to_s+"\\sqlresults")
@@ -723,7 +723,7 @@
 #
 #       #This method will fix underheated hours
 #       #@author Phylroy A. Lopez
-#       #@param model [OpenStudio::model::Model] A model object
+#       #@param model [OpenStudio::Model::Model] A model object
 #       #@param folder_name [String] a simple string of the simulation folder path, remember to escape the slashes..(i.e. // not / )
 #       #@param epw_path [String] a simple string of the epw file path, remember to escape the slashes..(i.e. // not / )
 #       def fix_underheated_hours(model,epw_path,folder_name = "c:/temp/")