src/model/RefrigerationSystem_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_REFRIGERATIONSYSTEM_IMPL_HPP | ||
| 7 | #define MODEL_REFRIGERATIONSYSTEM_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class ModelObjectList; | ||
| 16 | class RefrigerationAirChiller; | ||
| 17 | class RefrigerationCase; | ||
| 18 | class RefrigerationCompressor; | ||
| 19 | class RefrigerationWalkIn; | ||
| 20 | class RefrigerationSecondarySystem; | ||
| 21 | class RefrigerationCondenserCascade; | ||
| 22 | class RefrigerationSubcoolerLiquidSuction; | ||
| 23 | class RefrigerationSubcoolerMechanical; | ||
| 24 | class ThermalZone; | ||
| 25 | |||
| 26 | namespace detail { | ||
| 27 | |||
| 28 | /** RefrigerationSystem_Impl is a ModelObject_Impl that is the implementation class for RefrigerationSystem.*/ | ||
| 29 | class MODEL_API RefrigerationSystem_Impl : public ModelObject_Impl | ||
| 30 | { | ||
| 31 | public: | ||
| 32 | /** @name Constructors and Destructors */ | ||
| 33 | //@{ | ||
| 34 | |||
| 35 | RefrigerationSystem_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 36 | |||
| 37 | RefrigerationSystem_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 38 | |||
| 39 | RefrigerationSystem_Impl(const RefrigerationSystem_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 40 | |||
| 41 | 94 | virtual ~RefrigerationSystem_Impl() override = default; | |
| 42 | |||
| 43 | //@} | ||
| 44 | /** @name Virtual Methods */ | ||
| 45 | //@{ | ||
| 46 | |||
| 47 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 48 | |||
| 49 | virtual IddObjectType iddObjectType() const override; | ||
| 50 | |||
| 51 | //@} | ||
| 52 | /** @name Getters */ | ||
| 53 | //@{ | ||
| 54 | |||
| 55 | std::vector<IdfObject> remove() override; | ||
| 56 | |||
| 57 | ModelObject clone(Model model) const override; | ||
| 58 | |||
| 59 | std::vector<RefrigerationCase> cases() const; | ||
| 60 | |||
| 61 | std::vector<RefrigerationWalkIn> walkins() const; | ||
| 62 | |||
| 63 | std::vector<RefrigerationCompressor> compressors() const; | ||
| 64 | |||
| 65 | std::vector<RefrigerationCompressor> highStageCompressors() const; | ||
| 66 | |||
| 67 | std::vector<RefrigerationSecondarySystem> secondarySystemLoads() const; | ||
| 68 | |||
| 69 | std::vector<RefrigerationCondenserCascade> cascadeCondenserLoads() const; | ||
| 70 | |||
| 71 | std::vector<RefrigerationAirChiller> airChillers() const; | ||
| 72 | |||
| 73 | template <class T> | ||
| 74 | std::vector<T> listTemplate(const boost::optional<ModelObjectList>& modelObjectList) const; | ||
| 75 | |||
| 76 | boost::optional<ModelObjectList> refrigeratedCaseAndWalkInList() const; | ||
| 77 | |||
| 78 | boost::optional<ModelObjectList> refrigerationTransferLoadList() const; | ||
| 79 | |||
| 80 | boost::optional<ModelObject> refrigerationCondenser() const; | ||
| 81 | |||
| 82 | ModelObjectList compressorList() const; | ||
| 83 | |||
| 84 | double minimumCondensingTemperature() const; | ||
| 85 | |||
| 86 | std::string refrigerationSystemWorkingFluidType() const; | ||
| 87 | |||
| 88 | std::string suctionTemperatureControlType() const; | ||
| 89 | |||
| 90 | bool isSuctionTemperatureControlTypeDefaulted() const; | ||
| 91 | |||
| 92 | boost::optional<RefrigerationSubcoolerMechanical> mechanicalSubcooler() const; | ||
| 93 | |||
| 94 | boost::optional<RefrigerationSubcoolerLiquidSuction> liquidSuctionHeatExchangerSubcooler() const; | ||
| 95 | |||
| 96 | double sumUASuctionPiping() const; | ||
| 97 | |||
| 98 | bool isSumUASuctionPipingDefaulted() const; | ||
| 99 | |||
| 100 | boost::optional<ThermalZone> suctionPipingZone() const; | ||
| 101 | |||
| 102 | std::string endUseSubcategory() const; | ||
| 103 | |||
| 104 | bool isEndUseSubcategoryDefaulted() const; | ||
| 105 | |||
| 106 | std::string numberofCompressorStages() const; | ||
| 107 | |||
| 108 | std::string intercoolerType() const; | ||
| 109 | |||
| 110 | bool isIntercoolerTypeDefaulted() const; | ||
| 111 | |||
| 112 | double shellandCoilIntercoolerEffectiveness() const; | ||
| 113 | |||
| 114 | bool isShellandCoilIntercoolerEffectivenessDefaulted() const; | ||
| 115 | |||
| 116 | boost::optional<ModelObjectList> highStageCompressorList() const; | ||
| 117 | |||
| 118 | virtual std::vector<EMSActuatorNames> emsActuatorNames() const override; | ||
| 119 | |||
| 120 | virtual std::vector<std::string> emsInternalVariableNames() const override; | ||
| 121 | |||
| 122 | //@} | ||
| 123 | /** @name Setters */ | ||
| 124 | //@{ | ||
| 125 | |||
| 126 | template <class T> | ||
| 127 | void removeAllTemplate(boost::optional<ModelObjectList>& modelObjectList); | ||
| 128 | |||
| 129 | template <class T> | ||
| 130 | void removeTemplate(const T& modelObject, boost::optional<ModelObjectList>& modelObjectList); | ||
| 131 | |||
| 132 | template <class T> | ||
| 133 | bool addTemplate(const T& modelObject, boost::optional<ModelObjectList>& modelObjectList); | ||
| 134 | |||
| 135 | bool addCase(const RefrigerationCase& refrigerationCase); | ||
| 136 | |||
| 137 | void removeCase(const RefrigerationCase& refrigerationCase); | ||
| 138 | |||
| 139 | void removeAllCases(); | ||
| 140 | |||
| 141 | bool addWalkin(const RefrigerationWalkIn& refrigerationWalkin); | ||
| 142 | |||
| 143 | void removeWalkin(const RefrigerationWalkIn& refrigerationWalkin); | ||
| 144 | |||
| 145 | void removeAllWalkins(); | ||
| 146 | |||
| 147 | bool addCompressor(const RefrigerationCompressor& compressor); | ||
| 148 | |||
| 149 | void removeCompressor(const RefrigerationCompressor& compressor); | ||
| 150 | |||
| 151 | void removeAllCompressors(); | ||
| 152 | |||
| 153 | bool addHighStageCompressor(const RefrigerationCompressor& highStageCompressor); | ||
| 154 | |||
| 155 | void removeHighStageCompressor(const RefrigerationCompressor& highStageCompressor); | ||
| 156 | |||
| 157 | void removeAllHighStageCompressors(); | ||
| 158 | |||
| 159 | bool addSecondarySystemLoad(const RefrigerationSecondarySystem& refrigerationSecondarySystem); | ||
| 160 | |||
| 161 | void removeSecondarySystemLoad(const RefrigerationSecondarySystem& refrigerationSecondarySystem); | ||
| 162 | |||
| 163 | void removeAllSecondarySystemLoads(); | ||
| 164 | |||
| 165 | bool addCascadeCondenserLoad(const RefrigerationCondenserCascade& refrigerationCondenserCascade); | ||
| 166 | |||
| 167 | void removeCascadeCondenserLoad(const RefrigerationCondenserCascade& refrigerationCondenserCascade); | ||
| 168 | |||
| 169 | void removeAllCascadeCondenserLoads(); | ||
| 170 | |||
| 171 | bool addAirChiller(const RefrigerationAirChiller& airChiller); | ||
| 172 | |||
| 173 | void removeAirChiller(const RefrigerationAirChiller& airChiller); | ||
| 174 | |||
| 175 | void removeAllAirChillers(); | ||
| 176 | |||
| 177 | bool setRefrigeratedCaseAndWalkInList(const boost::optional<ModelObjectList>& modelObjectList); | ||
| 178 | |||
| 179 | void resetRefrigeratedCaseAndWalkInList(); | ||
| 180 | |||
| 181 | bool setRefrigerationTransferLoadList(const boost::optional<ModelObjectList>& modelObjectList); | ||
| 182 | |||
| 183 | void resetRefrigerationTransferLoadList(); | ||
| 184 | |||
| 185 | bool setRefrigerationCondenser(const ModelObject& refrigerationCondenser); | ||
| 186 | |||
| 187 | void resetRefrigerationCondenser(); | ||
| 188 | |||
| 189 | bool setCompressorList(const ModelObjectList& modelObjectList); | ||
| 190 | |||
| 191 | bool setMinimumCondensingTemperature(double minimumCondensingTemperature); | ||
| 192 | |||
| 193 | bool setRefrigerationSystemWorkingFluidType(const std::string& refrigerationSystemWorkingFluidType); | ||
| 194 | |||
| 195 | bool setSuctionTemperatureControlType(const std::string& suctionTemperatureControlType); | ||
| 196 | |||
| 197 | void resetSuctionTemperatureControlType(); | ||
| 198 | |||
| 199 | bool setMechanicalSubcooler(const boost::optional<RefrigerationSubcoolerMechanical>& refrigerationSubcoolerMechanical); | ||
| 200 | |||
| 201 | void resetMechanicalSubcooler(); | ||
| 202 | |||
| 203 | bool setLiquidSuctionHeatExchangerSubcooler(const boost::optional<RefrigerationSubcoolerLiquidSuction>& refrigerationSubcoolerLiquidSuction); | ||
| 204 | |||
| 205 | void resetLiquidSuctionHeatExchangerSubcooler(); | ||
| 206 | |||
| 207 | bool setSumUASuctionPiping(double sumUASuctionPiping); | ||
| 208 | |||
| 209 | void resetSumUASuctionPiping(); | ||
| 210 | |||
| 211 | bool setSuctionPipingZone(const boost::optional<ThermalZone>& thermalZone); | ||
| 212 | |||
| 213 | void resetSuctionPipingZone(); | ||
| 214 | |||
| 215 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 216 | |||
| 217 | void resetEndUseSubcategory(); | ||
| 218 | |||
| 219 | bool setIntercoolerType(const std::string& intercoolerType); | ||
| 220 | |||
| 221 | void resetIntercoolerType(); | ||
| 222 | |||
| 223 | bool setShellandCoilIntercoolerEffectiveness(double shellandCoilIntercoolerEffectiveness); | ||
| 224 | |||
| 225 | void resetShellandCoilIntercoolerEffectiveness(); | ||
| 226 | |||
| 227 | bool setHighStageCompressorList(const boost::optional<ModelObjectList>& modelObjectList); | ||
| 228 | |||
| 229 | void resetHighStageCompressorList(); | ||
| 230 | |||
| 231 | //@} | ||
| 232 | /** @name Other */ | ||
| 233 | //@{ | ||
| 234 | |||
| 235 | //@} | ||
| 236 | protected: | ||
| 237 | private: | ||
| 238 | − | REGISTER_LOGGER("openstudio.model.RefrigerationSystem"); | |
| 239 | |||
| 240 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 241 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 242 | // objects should be returned as boost::optionals | ||
| 243 | boost::optional<ModelObject> optionalRefrigerationCondenser() const; | ||
| 244 | boost::optional<ModelObjectList> optionalCompressorList() const; | ||
| 245 | }; | ||
| 246 | |||
| 247 | } // namespace detail | ||
| 248 | |||
| 249 | } // namespace model | ||
| 250 | } // namespace openstudio | ||
| 251 | |||
| 252 | #endif // MODEL_REFRIGERATIONSYSTEM_IMPL_HPP | ||
| 253 |