src/model/AirTerminalSingleDuctConstantVolumeFourPipeInduction_Impl.hpp
| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | /*********************************************************************************************************************** | ||
| 2 | * OpenStudio(R), Copyright (c) Alliance for Energy Innovation, LLC. | ||
| 3 | * See also https://openstudio.net/license | ||
| 4 | ***********************************************************************************************************************/ | ||
| 5 | |||
| 6 | #ifndef MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEFOURPIPEINDUCTION_IMPL_HPP | ||
| 7 | #define MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEFOURPIPEINDUCTION_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Schedule; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | /** AirTerminalSingleDuctConstantVolumeFourPipeInduction_Impl is a StraightComponent_Impl that is the implementation class for AirTerminalSingleDuctConstantVolumeFourPipeInduction.*/ | ||
| 20 | class MODEL_API AirTerminalSingleDuctConstantVolumeFourPipeInduction_Impl : public StraightComponent_Impl | ||
| 21 | { | ||
| 22 | public: | ||
| 23 | /** @name Constructors and Destructors */ | ||
| 24 | //@{ | ||
| 25 | |||
| 26 | AirTerminalSingleDuctConstantVolumeFourPipeInduction_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 27 | |||
| 28 | AirTerminalSingleDuctConstantVolumeFourPipeInduction_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, | ||
| 29 | bool keepHandle); | ||
| 30 | |||
| 31 | AirTerminalSingleDuctConstantVolumeFourPipeInduction_Impl(const AirTerminalSingleDuctConstantVolumeFourPipeInduction_Impl& other, | ||
| 32 | Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | 19 | virtual ~AirTerminalSingleDuctConstantVolumeFourPipeInduction_Impl() override = default; | |
| 35 | |||
| 36 | //@} | ||
| 37 | /** @name Virtual Methods */ | ||
| 38 | //@{ | ||
| 39 | |||
| 40 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 41 | |||
| 42 | virtual IddObjectType iddObjectType() const override; | ||
| 43 | |||
| 44 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 45 | |||
| 46 | virtual bool addToNode(Node& node) override; | ||
| 47 | |||
| 48 | virtual std::vector<ModelObject> children() const override; | ||
| 49 | |||
| 50 | virtual ModelObject clone(Model model) const override; | ||
| 51 | |||
| 52 | virtual std::vector<IdfObject> remove() override; | ||
| 53 | |||
| 54 | virtual bool isRemovable() const override; | ||
| 55 | |||
| 56 | virtual unsigned inletPort() const override; | ||
| 57 | |||
| 58 | virtual unsigned outletPort() const override; | ||
| 59 | |||
| 60 | boost::optional<Node> inducedAirInletNode() const; | ||
| 61 | |||
| 62 | unsigned inducedAirInletPort() const; | ||
| 63 | |||
| 64 | virtual ComponentType componentType() const override; | ||
| 65 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 66 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 67 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 68 | |||
| 69 | //@} | ||
| 70 | /** @name Getters */ | ||
| 71 | //@{ | ||
| 72 | |||
| 73 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 74 | |||
| 75 | boost::optional<double> maximumTotalAirFlowRate() const; | ||
| 76 | |||
| 77 | bool isMaximumTotalAirFlowRateAutosized() const; | ||
| 78 | |||
| 79 | double inductionRatio() const; | ||
| 80 | |||
| 81 | bool isInductionRatioDefaulted() const; | ||
| 82 | |||
| 83 | HVACComponent heatingCoil() const; | ||
| 84 | |||
| 85 | boost::optional<double> maximumHotWaterFlowRate() const; | ||
| 86 | |||
| 87 | bool isMaximumHotWaterFlowRateAutosized() const; | ||
| 88 | |||
| 89 | double minimumHotWaterFlowRate() const; | ||
| 90 | |||
| 91 | bool isMinimumHotWaterFlowRateDefaulted() const; | ||
| 92 | |||
| 93 | double heatingConvergenceTolerance() const; | ||
| 94 | |||
| 95 | bool isHeatingConvergenceToleranceDefaulted() const; | ||
| 96 | |||
| 97 | boost::optional<HVACComponent> coolingCoil() const; | ||
| 98 | |||
| 99 | boost::optional<double> maximumColdWaterFlowRate() const; | ||
| 100 | |||
| 101 | bool isMaximumColdWaterFlowRateAutosized() const; | ||
| 102 | |||
| 103 | double minimumColdWaterFlowRate() const; | ||
| 104 | |||
| 105 | bool isMinimumColdWaterFlowRateDefaulted() const; | ||
| 106 | |||
| 107 | double coolingConvergenceTolerance() const; | ||
| 108 | |||
| 109 | bool isCoolingConvergenceToleranceDefaulted() const; | ||
| 110 | |||
| 111 | boost::optional<double> autosizedMaximumTotalAirFlowRate() const; | ||
| 112 | |||
| 113 | boost::optional<double> autosizedMaximumHotWaterFlowRate() const; | ||
| 114 | |||
| 115 | boost::optional<double> autosizedMaximumColdWaterFlowRate() const; | ||
| 116 | |||
| 117 | virtual void autosize() override; | ||
| 118 | |||
| 119 | virtual void applySizingValues() override; | ||
| 120 | |||
| 121 | //@} | ||
| 122 | /** @name Setters */ | ||
| 123 | //@{ | ||
| 124 | |||
| 125 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 126 | |||
| 127 | void resetAvailabilitySchedule(); | ||
| 128 | |||
| 129 | bool setMaximumTotalAirFlowRate(boost::optional<double> maximumTotalAirFlowRate); | ||
| 130 | |||
| 131 | void autosizeMaximumTotalAirFlowRate(); | ||
| 132 | |||
| 133 | bool setInductionRatio(double inductionRatio); | ||
| 134 | |||
| 135 | void resetInductionRatio(); | ||
| 136 | |||
| 137 | bool setHeatingCoil(const HVACComponent& heatingCoil); | ||
| 138 | |||
| 139 | bool setMaximumHotWaterFlowRate(boost::optional<double> maximumHotWaterFlowRate); | ||
| 140 | |||
| 141 | void resetMaximumHotWaterFlowRate(); | ||
| 142 | |||
| 143 | void autosizeMaximumHotWaterFlowRate(); | ||
| 144 | |||
| 145 | bool setMinimumHotWaterFlowRate(double minimumHotWaterFlowRate); | ||
| 146 | |||
| 147 | void resetMinimumHotWaterFlowRate(); | ||
| 148 | |||
| 149 | bool setHeatingConvergenceTolerance(double heatingConvergenceTolerance); | ||
| 150 | |||
| 151 | void resetHeatingConvergenceTolerance(); | ||
| 152 | |||
| 153 | bool setCoolingCoil(const boost::optional<HVACComponent>& coolingCoil); | ||
| 154 | |||
| 155 | void resetCoolingCoil(); | ||
| 156 | |||
| 157 | bool setMaximumColdWaterFlowRate(boost::optional<double> maximumColdWaterFlowRate); | ||
| 158 | |||
| 159 | void resetMaximumColdWaterFlowRate(); | ||
| 160 | |||
| 161 | void autosizeMaximumColdWaterFlowRate(); | ||
| 162 | |||
| 163 | bool setMinimumColdWaterFlowRate(double minimumColdWaterFlowRate); | ||
| 164 | |||
| 165 | void resetMinimumColdWaterFlowRate(); | ||
| 166 | |||
| 167 | bool setCoolingConvergenceTolerance(double coolingConvergenceTolerance); | ||
| 168 | |||
| 169 | void resetCoolingConvergenceTolerance(); | ||
| 170 | |||
| 171 | //@} | ||
| 172 | /** @name Other */ | ||
| 173 | //@{ | ||
| 174 | |||
| 175 | //@} | ||
| 176 | protected: | ||
| 177 | private: | ||
| 178 | − | REGISTER_LOGGER("openstudio.model.AirTerminalSingleDuctConstantVolumeFourPipeInduction"); | |
| 179 | |||
| 180 | // TODO: Check the return types of these methods. | ||
| 181 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 182 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 183 | // objects should be returned as boost::optionals | ||
| 184 | boost::optional<HVACComponent> optionalHeatingCoil() const; | ||
| 185 | }; | ||
| 186 | |||
| 187 | } // namespace detail | ||
| 188 | |||
| 189 | } // namespace model | ||
| 190 | } // namespace openstudio | ||
| 191 | |||
| 192 | #endif // MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEFOURPIPEINDUCTION_IMPL_HPP | ||
| 193 |