lib/openstudio-standards/standards/Standards.CoilDX.rb in openstudio-standards-0.2.14 vs lib/openstudio-standards/standards/Standards.CoilDX.rb in openstudio-standards-0.2.15.pre.rc1

@@ -5,10 +5,12 @@
   # @!group CoilDX
 
   # Finds the subcategory.  Possible choices are:
   # Single Package, Split System, PTAC, or PTHP
   #
+  # @param coil_dx [OpenStudio::Model::StraightComponent] coil cooling object, allowable types:
+  #   CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilCoolingDXMultiSpeed
   # @return [String] the coil_dx_subcategory(coil_dx)
   # @todo Add add split system vs single package to model object
   def coil_dx_subcategory(coil_dx)
     sub_category = 'Single Package'
 
@@ -33,19 +35,22 @@
           sub_category = 'PTAC'
         # PTHP
         elsif containing_comp.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
           sub_category = 'PTHP'
         end
-        # TODO: Add other zone hvac systems
+        # @todo Add other zone hvac systems
       end
     end
 
     return sub_category
   end
 
   # Determine if it is a heat pump
-  # @return [Bool] true if it is a heat pump, false if not
+  #
+  # @param coil_dx [OpenStudio::Model::StraightComponent] coil cooling object, allowable types:
+  #   CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilCoolingDXMultiSpeed
+  # @return [Bool] returns true if it is a heat pump, false if not
   def coil_dx_heat_pump?(coil_dx)
     heat_pump = false
 
     if coil_dx.airLoopHVAC.empty?
       if coil_dx.containingHVACComponent.is_initialized
@@ -60,11 +65,11 @@
         containing_comp = coil_dx.containingZoneHVACComponent.get
         # PTHP
         if containing_comp.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
           heat_pump = true
         end
-        # TODO: Add other zone hvac systems
+        # @todo Add other zone hvac systems
       end
     else
       if !coil_dx.airLoopHVAC.get.supplyComponents('OS:Coil:Heating:DX:SingleSpeed'.to_IddObjectType).empty? ||
          !coil_dx.airLoopHVAC.get.supplyComponents('OS:Coil:Heating:DX:VariableSpeed'.to_IddObjectType).empty?
         heat_pump = true
@@ -72,12 +77,15 @@
     end
 
     return heat_pump
   end
 
-  # Determine the heating type.  Possible choices are:
-  # Electric Resistance or None, All Other
+  # Determine the heating type.
+  # Possible choices are: Electric Resistance or None, All Other
+  #
+  # @param coil_dx [OpenStudio::Model::StraightComponent] coil cooling object, allowable types:
+  #   CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilCoolingDXMultiSpeed
   # @return [String] the heating type
   def coil_dx_heating_type(coil_dx)
     htg_type = nil
 
     # If Unitary or Zone HVAC
@@ -97,11 +105,11 @@
             htg_type = 'Electric Resistance or None'
           elsif htg_coil.to_CoilHeatingGasMultiStage.is_initialized
             htg_type = 'All Other'
           end
         end
-        # TODO: Add other unitary systems
+        # @todo Add other unitary systems
       elsif coil_dx.containingZoneHVACComponent.is_initialized
         containing_comp = coil_dx.containingZoneHVACComponent.get
         # PTAC
         if containing_comp.to_ZoneHVACPackagedTerminalAirConditioner.is_initialized
           htg_coil = containing_comp.to_ZoneHVACPackagedTerminalAirConditioner.get.heatingCoil
@@ -112,11 +120,11 @@
           end
         # PTHP
         elsif containing_comp.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
           htg_type = 'Electric Resistance or None'
         end
-        # TODO: Add other zone hvac systems
+        # @todo Add other zone hvac systems
       end
     end
 
     # If on an AirLoop
     if coil_dx.airLoopHVAC.is_initialized
@@ -147,10 +155,12 @@
     return htg_type
   end
 
   # Finds the search criteria
   #
+  # @param coil_dx [OpenStudio::Model::StraightComponent] coil cooling object, allowable types:
+  #   CoilCoolingDXSingleSpeed, CoilCoolingDXTwoSpeed, CoilCoolingDXMultiSpeed
   # @return [hash] has for search criteria to be used for find object
   def coil_dx_find_search_criteria(coil_dx)
     search_criteria = {}
     search_criteria['template'] = template
 
@@ -182,10 +192,10 @@
           if coil_dx.containingHVACComponent.is_initialized
             containing_comp = coil_dx.containingHVACComponent.get
             if containing_comp.to_AirLoopHVACUnitaryHeatPumpAirToAir.is_initialized
               search_criteria['heating_type'] = nil
             end
-            # TODO: Add other unitary systems
+            # @todo Add other unitary systems
           end
         end
       end
     end