text: /***********************************************************************************************************************
  *  OpenStudio(R), Copyright (c) 2008-2021, Alliance for Sustainable Energy, LLC, and other contributors. 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 HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE UNITED STATES GOVERNMENT, OR THE UNITED
  *  STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, 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_ZONEHVACPACKAGEDTERMINALAIRCONDITIONER_IMPL_HPP
  #define MODEL_ZONEHVACPACKAGEDTERMINALAIRCONDITIONER_IMPL_HPP
  
  #include "ModelAPI.hpp"
  #include "ZoneHVACComponent_Impl.hpp"
  
  namespace openstudio {
  namespace model {
  
    class Schedule;
    class HVACComponent;
  
    namespace detail {
  
      /** ZoneHVACPackagedTerminalAirConditioner_Impl is a ZoneHVACComponent_Impl that is the implementation class for
     *  ZoneHVACPackagedTerminalAirConditioner. */
      class MODEL_API ZoneHVACPackagedTerminalAirConditioner_Impl : public ZoneHVACComponent_Impl
      {
  
       public:
        /** @name Constructors and Destructors */
        //@{
  
        ZoneHVACPackagedTerminalAirConditioner_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle);
  
        ZoneHVACPackagedTerminalAirConditioner_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle);
  
        ZoneHVACPackagedTerminalAirConditioner_Impl(const ZoneHVACPackagedTerminalAirConditioner_Impl& other, Model_Impl* model, bool keepHandle);
  
        virtual ~ZoneHVACPackagedTerminalAirConditioner_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;
  
        std::string outdoorAirMixerObjectType() const;
  
        std::string outdoorAirMixerName() 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;
  
        std::string fanPlacement() const;
  
        bool isFanPlacementDefaulted() const;
  
        boost::optional<Schedule> supplyAirFanOperatingModeSchedule() const;
  
        boost::optional<double> autosizedSupplyAirFlowRateDuringCoolingOperation() const;
  
        boost::optional<double> autosizedSupplyAirFlowRateDuringHeatingOperation() const;
  
        boost::optional<double> autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const;
  
        boost::optional<double> autosizedOutdoorAirFlowRateDuringCoolingOperation() const;
  
        boost::optional<double> autosizedOutdoorAirFlowRateDuringHeatingOperation() const;
  
        boost::optional<double> autosizedOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const;
  
        virtual void autosize() override;
  
        virtual void applySizingValues() override;
  
        //@}
        /** @name Setters */
        //@{
  
        bool setAvailabilitySchedule(Schedule& schedule);
  
        bool setOutdoorAirMixerObjectType(std::string outdoorAirMixerObjectType);
  
        bool setOutdoorAirMixerName(std::string outdoorAirMixerName);
  
        bool setSupplyAirFlowRateDuringCoolingOperation(boost::optional<double> supplyAirFlowRateDuringCoolingOperation);
  
        void autosizeSupplyAirFlowRateDuringCoolingOperation();
  
        bool setSupplyAirFlowRateDuringHeatingOperation(boost::optional<double> supplyAirFlowRateDuringHeatingOperation);
  
        void autosizeSupplyAirFlowRateDuringHeatingOperation();
  
        bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded);
  
        void resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded();
  
        void autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded();
  
        bool setOutdoorAirFlowRateDuringCoolingOperation(boost::optional<double> outdoorAirFlowRateDuringCoolingOperation);
  
        void autosizeOutdoorAirFlowRateDuringCoolingOperation();
  
        bool setOutdoorAirFlowRateDuringHeatingOperation(boost::optional<double> outdoorAirFlowRateDuringHeatingOperation);
  
        void autosizeOutdoorAirFlowRateDuringHeatingOperation();
  
        bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded);
  
        void resetOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded();
  
        void autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded();
  
        bool setSupplyAirFan(HVACComponent& fan);
  
        bool setHeatingCoil(HVACComponent& heatingCoil);
  
        bool setCoolingCoil(HVACComponent& coolingCoil);
  
        bool setFanPlacement(std::string fanPlacement);
  
        void resetFanPlacement();
  
        bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule);
  
        void resetSupplyAirFanOperatingModeSchedule();
  
        //@}
        /** @name Other */
        //@{
  
        //@}
       protected:
       private:
        REGISTER_LOGGER("openstudio.model.ZoneHVACPackagedTerminalAirConditioner");
  
        // optional getters so can remove() if constructor fails
        boost::optional<Schedule> optionalAvailabilitySchedule() const;
        boost::optional<HVACComponent> optionalSupplyAirFan() const;
        boost::optional<HVACComponent> optionalHeatingCoil() const;
        boost::optional<HVACComponent> optionalCoolingCoil() const;
  
        boost::optional<ModelObject> availabilityScheduleAsModelObject() const;
        boost::optional<ModelObject> supplyAirFanAsModelObject() const;
        boost::optional<ModelObject> heatingCoilAsModelObject() const;
        boost::optional<ModelObject> coolingCoilAsModelObject() 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 setSupplyAirFanOperatingModeScheduleAsModelObject(const boost::optional<ModelObject>& modelObject);
      };
  
    }  // namespace detail
  
  }  // namespace model
  }  // namespace openstudio
  
  #endif  // MODEL_ZONEHVACPACKAGEDTERMINALAIRCONDITIONER_IMPL_HPP
  