Standards.CoilCoolingDXMultiSpeed.rb in openstudio-standards-0.2.15.pre.rc1

- old
+ new

@@ -1,22 +1,24 @@
 class Standard
   # @!group CoilCoolingDXMultiSpeed
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @param coil_cooling_dx_multi_speed [OpenStudio::Model::CoilCoolingDXMultiSpeed] coil cooling dx multi speed object
+  # @param sql_db_vars_map [Hash] hash map
+  # @return [Hash] hash of coil objects
   def coil_cooling_dx_multi_speed_apply_efficiency_and_curves(coil_cooling_dx_multi_speed, sql_db_vars_map)
     successfully_set_all_properties = true
 
     # Define the criteria to find the chiller properties
     # in the hvac standards data set.
     search_criteria = {}
     search_criteria['template'] = template
     cooling_type = coil_cooling_dx_multi_speed.condenserType
     search_criteria['cooling_type'] = cooling_type
 
-    # TODO: Standards - add split system vs single package to model
+    # @todo Standards - add split system vs single package to model
     # For now, assume single package as default
     sub_category = 'Single Package'
 
     # Determine the heating type if unitary or zone hvac
     heat_pump = false
@@ -31,11 +33,11 @@
             heat_pump = true
             heating_type = 'Electric Resistance or None'
           elsif htg_coil.to_CoilHeatingGasMultiStage.is_initialized
             heating_type = 'All Other'
           end
-          # TODO: Add other unitary systems
+          # @todo Add other unitary systems
         end
       elsif coil_cooling_dx_multi_speed.containingZoneHVACComponent.is_initialized
         containing_comp = coil_cooling_dx_multi_speed.containingZoneHVACComponent.get
         if containing_comp.to_ZoneHVACPackagedTerminalAirConditioner.is_initialized
           sub_category = 'PTAC'
@@ -43,11 +45,11 @@
           if htg_coil.to_CoilHeatingElectric.is_initialized
             heating_type = 'Electric Resistance or None'
           elsif htg_coil.to_CoilHeatingWater.is_initialized || htg_coil.to_CoilHeatingGas.is_initialized || htg_col.to_CoilHeatingGasMultiStage
             heating_type = 'All Other'
           end
-          # TODO: Add other zone hvac systems
+          # @todo Add other zone hvac systems
         end
       end
     end
 
     # Add the heating type to the search criteria
@@ -215,10 +217,11 @@
     return sql_db_vars_map
   end
 
   # Finds capacity in W
   #
+  # @param coil_cooling_dx_multi_speed [OpenStudio::Model::CoilCoolingDXMultiSpeed] coil cooling dx multi speed object
   # @return [Double] capacity in W to be used for find object
   def coil_cooling_dx_multi_speed_find_capacity(coil_cooling_dx_multi_speed)
     capacity_w = nil
     clg_stages = coil_cooling_dx_multi_speed.stages
     if clg_stages.last.grossRatedTotalCoolingCapacity.is_initialized
@@ -240,11 +243,12 @@
     return capacity_w
   end
 
   # Finds lookup object in standards and return efficiency
   #
-  # @param rename [Bool] if true, object will be renamed to include capacity and efficiency level
-  # @return [Double] full load efficiency (COP)
+  # @param coil_cooling_dx_multi_speed [OpenStudio::Model::CoilCoolingDXMultiSpeed] coil cooling dx multi speed object
+  # @return [Array] array of full load efficiency (COP), new object name
+  # @todo align the method arguments and return types
   def coil_cooling_dx_multi_speed_standard_minimum_cop(coil_cooling_dx_multi_speed)
     search_criteria = coil_dx_find_search_criteria(coil_cooling_dx_multi_speed)
     cooling_type = search_criteria['cooling_type']
     heating_type = search_criteria['heating_type']
     capacity_w = coil_cooling_dx_multi_speed_find_capacity(coil_cooling_dx_multi_speed)