text: /***********************************************************************************************************************
   *  OpenStudio(R), Copyright (c) 2008-2017, Alliance for Sustainable Energy, LLC. All rights reserved.
   *
   *  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
   *  following conditions are met:
   *
   *  (1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following
   *  disclaimer.
   *
   *  (2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
   *  following disclaimer in the documentation and/or other materials provided with the distribution.
   *
   *  (3) Neither the name of the copyright holder nor the names of any contributors may be used to endorse or promote
   *  products derived from this software without specific prior written permission from the respective party.
   *
   *  (4) Other than as required in clauses (1) and (2), distributions in any form of modifications or other derivative
   *  works may not use the "OpenStudio" trademark, "OS", "os", or any other confusingly similar designation without
   *  specific prior written permission from Alliance for Sustainable Energy, LLC.
   *
   *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
   *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES GOVERNMENT, OR ANY CONTRIBUTORS BE LIABLE FOR
   *  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
   *  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   **********************************************************************************************************************/
  
  #ifndef MODEL_ZONEHVACWATERTOAIRHEATPUMP_IMPL_HPP
  #define MODEL_ZONEHVACWATERTOAIRHEATPUMP_IMPL_HPP
  
  #include "ModelAPI.hpp"
  #include "ZoneHVACComponent_Impl.hpp"
  
  namespace openstudio {
  namespace model {
  
  class Schedule;
  
  class HVACComponent;
  
  
  namespace detail {
  
    /** ZoneHVACWaterToAirHeatPump_Impl is a ZoneHVACComponent_Impl that is the implementation class for ZoneHVACWaterToAirHeatPump.*/
    class MODEL_API ZoneHVACWaterToAirHeatPump_Impl : public ZoneHVACComponent_Impl {
  
    public:
      /** @name Constructors and Destructors */
      //@{
  
      ZoneHVACWaterToAirHeatPump_Impl(const IdfObject& idfObject,
                                      Model_Impl* model,
                                      bool keepHandle);
  
      ZoneHVACWaterToAirHeatPump_Impl(const openstudio::detail::WorkspaceObject_Impl& other,
                                      Model_Impl* model,
                                      bool keepHandle);
  
      ZoneHVACWaterToAirHeatPump_Impl(const ZoneHVACWaterToAirHeatPump_Impl& other,
                                      Model_Impl* model,
                                      bool keepHandle);
  
      virtual ~ZoneHVACWaterToAirHeatPump_Impl() {}
  
      //@}
      /** @name Virtual Methods */
      //@{
  
      virtual ModelObject clone(Model model) const override;
     
      virtual std::vector<IdfObject> remove() override;
  
      virtual const std::vector<std::string>& outputVariableNames() const override;
  
      virtual IddObjectType iddObjectType() const override;
  
      virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override;
  
      virtual std::vector<ModelObject> children() const override;
  
      virtual unsigned inletPort() const override;
  
      virtual unsigned outletPort() const override;
  
      //@}
      /** @name Getters */
      //@{
  
      Schedule availabilitySchedule() const;
  
      boost::optional<double> supplyAirFlowRateDuringCoolingOperation() const;
  
      bool isSupplyAirFlowRateDuringCoolingOperationAutosized() const;
  
      boost::optional<double> supplyAirFlowRateDuringHeatingOperation() const;
  
      bool isSupplyAirFlowRateDuringHeatingOperationAutosized() const;
  
      boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const;
  
      bool isSupplyAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const;
  
      boost::optional<double> outdoorAirFlowRateDuringCoolingOperation() const;
  
      bool isOutdoorAirFlowRateDuringCoolingOperationAutosized() const;
  
      boost::optional<double> outdoorAirFlowRateDuringHeatingOperation() const;
  
      bool isOutdoorAirFlowRateDuringHeatingOperationAutosized() const;
  
      boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const;
  
      bool isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const;
  
      HVACComponent supplyAirFan() const;
  
      HVACComponent heatingCoil() const;
  
      HVACComponent coolingCoil() const;
  
      double maximumCyclingRate() const;
  
      bool isMaximumCyclingRateDefaulted() const;
  
      double heatPumpTimeConstant() const;
  
      bool isHeatPumpTimeConstantDefaulted() const;
  
      double fractionofOnCyclePowerUse() const;
  
      bool isFractionofOnCyclePowerUseDefaulted() const;
  
      double heatPumpFanDelayTime() const;
  
      bool isHeatPumpFanDelayTimeDefaulted() const;
  
      HVACComponent supplementalHeatingCoil() const;
  
      boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater() const;
  
      bool isMaximumSupplyAirTemperaturefromSupplementalHeaterAutosized() const;
  
      double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation() const;
  
      bool isMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperationDefaulted() const;
  
      std::string outdoorDryBulbTemperatureSensorNodeName() const;
  
      std::string fanPlacement() const;
  
      bool isFanPlacementDefaulted() const;
      boost::optional<Schedule> supplyAirFanOperatingModeSchedule() const;
  
      //@}
      /** @name Setters */
      //@{
  
      bool setAvailabilitySchedule(Schedule& schedule);
  
      bool setSupplyAirFlowRateDuringCoolingOperation(boost::optional<double> supplyAirFlowRateDuringCoolingOperation);
  
      bool setSupplyAirFlowRateDuringCoolingOperation(double supplyAirFlowRateDuringCoolingOperation);
      
      void resetSupplyAirFlowRateDuringCoolingOperation();
  
      void autosizeSupplyAirFlowRateDuringCoolingOperation();
  
      bool setSupplyAirFlowRateDuringHeatingOperation(boost::optional<double> supplyAirFlowRateDuringHeatingOperation);
  
      bool setSupplyAirFlowRateDuringHeatingOperation(double supplyAirFlowRateDuringHeatingOperation);
  
      void resetSupplyAirFlowRateDuringHeatingOperation();
  
      void autosizeSupplyAirFlowRateDuringHeatingOperation();
  
      bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded);
  
      bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(double supplyAirFlowRateWhenNoCoolingorHeatingisNeeded);
  
      void resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded();
  
      void autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded();
  
      bool setOutdoorAirFlowRateDuringCoolingOperation(boost::optional<double> outdoorAirFlowRateDuringCoolingOperation);
  
      bool setOutdoorAirFlowRateDuringCoolingOperation(double outdoorAirFlowRateDuringCoolingOperation);
      
      void resetOutdoorAirFlowRateDuringCoolingOperation();
      
      void autosizeOutdoorAirFlowRateDuringCoolingOperation();
  
      bool setOutdoorAirFlowRateDuringHeatingOperation(boost::optional<double> outdoorAirFlowRateDuringHeatingOperation);
  
      bool setOutdoorAirFlowRateDuringHeatingOperation(double outdoorAirFlowRateDuringHeatingOperation);
  
      void resetOutdoorAirFlowRateDuringHeatingOperation();
  
      void autosizeOutdoorAirFlowRateDuringHeatingOperation();
  
      bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded);
  
      bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(double outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded);
  
      void resetOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded();
  
      void autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded();
  
      bool setSupplyAirFan(HVACComponent& fansOnOff);
  
      bool setHeatingCoil(HVACComponent& heatingCoilsWaterToAirHP);
  
      bool setCoolingCoil(HVACComponent& coolingCoilsWaterToAirHP);
  
      bool setMaximumCyclingRate(boost::optional<double> maximumCyclingRate);
  
      bool setMaximumCyclingRate(double maximumCyclingRate);
  
      void resetMaximumCyclingRate();
  
      bool setHeatPumpTimeConstant(boost::optional<double> heatPumpTimeConstant);
  
      bool setHeatPumpTimeConstant(double heatPumpTimeConstant);
  
      void resetHeatPumpTimeConstant();
  
      bool setFractionofOnCyclePowerUse(boost::optional<double> fractionofOnCyclePowerUse);
  
      bool setFractionofOnCyclePowerUse(double fractionofOnCyclePowerUse);
  
      void resetFractionofOnCyclePowerUse();
  
      bool setHeatPumpFanDelayTime(boost::optional<double> heatPumpFanDelayTime);
  
      bool setHeatPumpFanDelayTime(double heatPumpFanDelayTime);
  
      void resetHeatPumpFanDelayTime();
  
      bool setSupplementalHeatingCoil( HVACComponent& heatingCoilName);
  
      bool setMaximumSupplyAirTemperaturefromSupplementalHeater(boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater);
  
      bool setMaximumSupplyAirTemperaturefromSupplementalHeater(double maximumSupplyAirTemperaturefromSupplementalHeater);
  
      void resetMaximumSupplyAirTemperaturefromSupplementalHeater();
      
      void autosizeMaximumSupplyAirTemperaturefromSupplementalHeater();
  
      bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(boost::optional<double> maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation);
  
      bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation);
  
      void resetMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation();
  
      // DLM: this appears to not be implemented
      //bool setOutdoorDryBulbTemperatureSensorNodeName(std::string outdoorDryBulbTemperatureSensorNodeName);
  
      bool setFanPlacement(std::string fanPlacement);
  
      void resetFanPlacement();
  
      bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule);
  
      void resetSupplyAirFanOperatingModeSchedule();
  
      //@}
      /** @name Other */
      //@{
  
      //@}
     protected:
     private:
      REGISTER_LOGGER("openstudio.model.ZoneHVACWaterToAirHeatPump");
  
       // Optional getters for use by methods like children() so can remove() if the constructor fails.
      // There are other ways for the public versions of these getters to fail--perhaps all required
      // objects should be returned as boost::optionals
      boost::optional<Schedule> optionalAvailabilitySchedule() const;
      boost::optional<HVACComponent> optionalSupplyAirFan() const;
      boost::optional<HVACComponent> optionalHeatingCoil() const;
      boost::optional<HVACComponent> optionalCoolingCoil() const;
      boost::optional<HVACComponent> optionalSupplementalHeatingCoil() const;
  
      std::vector<std::string> fanPlacementValues() const;
  
      boost::optional<ModelObject> availabilityScheduleAsModelObject() const;
      boost::optional<ModelObject> supplyAirFanAsModelObject() const;
      boost::optional<ModelObject> heatingCoilAsModelObject() const;
      boost::optional<ModelObject> coolingCoilAsModelObject() const;
      boost::optional<ModelObject> supplementalHeatingCoilAsModelObject() const;
      boost::optional<ModelObject> supplyAirFanOperatingModeScheduleAsModelObject() const;
  
      bool setAvailabilityScheduleAsModelObject(const boost::optional<ModelObject>& modelObject);
      bool setSupplyAirFanAsModelObject(const boost::optional<ModelObject>& modelObject);
      bool setHeatingCoilAsModelObject(const boost::optional<ModelObject>& modelObject);
      bool setCoolingCoilAsModelObject(const boost::optional<ModelObject>& modelObject);
      bool setSupplementalHeatingCoilAsModelObject(const boost::optional<ModelObject>& modelObject);
      bool setSupplyAirFanOperatingModeScheduleAsModelObject(const boost::optional<ModelObject>& modelObject);
    };
  
  } // detail
  
  } // model
  } // openstudio
  
  #endif // MODEL_ZONEHVACWATERTOAIRHEATPUMP_IMPL_HPP
  
  