class Standard
  # @!group CoilHeatingGas

  # Prototype CoilHeatingGas object
  #
  # @param model [OpenStudio::Model::Model] OpenStudio model object
  # @param air_loop_node [<OpenStudio::Model::Node>] the coil will be placed on this node of the air loop
  # @param name [String] the name of the system, or nil in which case it will be defaulted
  # @param schedule [String] name of the availability schedule, or [<OpenStudio::Model::Schedule>] Schedule object, or nil in which case default to always on
  # @param nominal_capacity [Double] rated nominal capacity
  # @param efficiency [Double] rated heating efficiency
  # @return [OpenStudio::Model::CoilHeatingGas] the gas heating coil
  def create_coil_heating_gas(model,
                              air_loop_node: nil,
                              name: 'Gas Htg Coil',
                              schedule: nil,
                              nominal_capacity: nil,
                              efficiency: 0.80)

    htg_coil = OpenStudio::Model::CoilHeatingGas.new(model)

    # add to air loop if specified
    htg_coil.addToNode(air_loop_node) unless air_loop_node.nil?

    # set coil name
    htg_coil.setName(name)

    # set coil availability schedule
    if schedule.nil?
      # default always on
      coil_availability_schedule = model.alwaysOnDiscreteSchedule
    elsif schedule.class == String
      coil_availability_schedule = model_add_schedule(model, schedule)

      if coil_availability_schedule.nil? && schedule == 'alwaysOffDiscreteSchedule'
        coil_availability_schedule = model.alwaysOffDiscreteSchedule
      elsif coil_availability_schedule.nil?
        coil_availability_schedule = model.alwaysOnDiscreteSchedule
      end
    elsif !schedule.to_Schedule.empty?
      coil_availability_schedule = schedule
    else
      coil_availability_schedule = model.alwaysOnDiscreteSchedule
    end
    htg_coil.setAvailabilitySchedule(coil_availability_schedule)

    # set capacity
    htg_coil.setNominalCapacity(nominal_capacity) unless nominal_capacity.nil?

    # set efficiency
    htg_coil.setGasBurnerEfficiency(efficiency)

    # defaults
    htg_coil.setParasiticElectricLoad(0)
    htg_coil.setParasiticGasLoad(0)

    return htg_coil
  end

  # Updates the efficiency of some gas heating coils per the prototype assumptions.
  # Defaults to making no changes.
  #
  # @param coil_heating_gas [OpenStudio::Model::CoilHeatingGas] a gas heating coil
  # @return [Boolean] returns true if successful, false if not
  def coil_heating_gas_apply_prototype_efficiency(coil_heating_gas)
    # do nothing
    return true
  end
end