src/model/RefrigerationTranscriticalSystem.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_REFRIGERATIONTRANSCRITICALSYSTEM_HPP | ||
| 7 | #define MODEL_REFRIGERATIONTRANSCRITICALSYSTEM_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class RefrigerationCase; | ||
| 17 | class RefrigerationCompressor; | ||
| 18 | class RefrigerationWalkIn; | ||
| 19 | class RefrigerationGasCoolerAirCooled; | ||
| 20 | class ThermalZone; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | class RefrigerationTranscriticalSystem_Impl; | ||
| 25 | |||
| 26 | } // namespace detail | ||
| 27 | |||
| 28 | /** RefrigerationTranscriticalSystem is a ModelObject that wraps the OpenStudio IDD object 'OS:Refrigeration:TranscriticalSystem'. */ | ||
| 29 | class MODEL_API RefrigerationTranscriticalSystem : public ModelObject | ||
| 30 | { | ||
| 31 | public: | ||
| 32 | /** @name Constructors and Destructors */ | ||
| 33 | //@{ | ||
| 34 | |||
| 35 | explicit RefrigerationTranscriticalSystem(const Model& model); | ||
| 36 | |||
| 37 | 55 | virtual ~RefrigerationTranscriticalSystem() override = default; | |
| 38 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 39 | ✗ | RefrigerationTranscriticalSystem(const RefrigerationTranscriticalSystem& other) = default; | |
| 40 | 1 | RefrigerationTranscriticalSystem(RefrigerationTranscriticalSystem&& other) = default; | |
| 41 | ✗ | RefrigerationTranscriticalSystem& operator=(const RefrigerationTranscriticalSystem&) = default; | |
| 42 | ✗ | RefrigerationTranscriticalSystem& operator=(RefrigerationTranscriticalSystem&&) = default; | |
| 43 | |||
| 44 | //@} | ||
| 45 | |||
| 46 | static IddObjectType iddObjectType(); | ||
| 47 | |||
| 48 | static std::vector<std::string> refrigerationSystemWorkingFluidTypeValues(); | ||
| 49 | |||
| 50 | std::vector<IdfObject> remove(); | ||
| 51 | |||
| 52 | ModelObject clone(Model model) const; | ||
| 53 | |||
| 54 | bool addMediumTemperatureCase(const RefrigerationCase& refrigerationCase); | ||
| 55 | |||
| 56 | void removeMediumTemperatureCase(const RefrigerationCase& refrigerationCase); | ||
| 57 | |||
| 58 | void removeAllMediumTemperatureCases(); | ||
| 59 | |||
| 60 | std::vector<RefrigerationCase> mediumTemperatureCases() const; | ||
| 61 | |||
| 62 | bool addLowTemperatureCase(const RefrigerationCase& refrigerationCase); | ||
| 63 | |||
| 64 | void removeLowTemperatureCase(const RefrigerationCase& refrigerationCase); | ||
| 65 | |||
| 66 | void removeAllLowTemperatureCases(); | ||
| 67 | |||
| 68 | std::vector<RefrigerationCase> lowTemperatureCases() const; | ||
| 69 | |||
| 70 | bool addMediumTemperatureWalkin(const RefrigerationWalkIn& refrigerationWalkin); | ||
| 71 | |||
| 72 | void removeMediumTemperatureWalkin(const RefrigerationWalkIn& refrigerationWalkin); | ||
| 73 | |||
| 74 | void removeAllMediumTemperatureWalkins(); | ||
| 75 | |||
| 76 | std::vector<RefrigerationWalkIn> mediumTemperatureWalkins() const; | ||
| 77 | |||
| 78 | bool addLowTemperatureWalkin(const RefrigerationWalkIn& refrigerationWalkin); | ||
| 79 | |||
| 80 | void removeLowTemperatureWalkin(const RefrigerationWalkIn& refrigerationWalkin); | ||
| 81 | |||
| 82 | void removeAllLowTemperatureWalkins(); | ||
| 83 | |||
| 84 | std::vector<RefrigerationWalkIn> lowTemperatureWalkins() const; | ||
| 85 | |||
| 86 | bool addHighPressureCompressor(const RefrigerationCompressor& compressor); | ||
| 87 | |||
| 88 | void removeHighPressureCompressor(const RefrigerationCompressor& compressor); | ||
| 89 | |||
| 90 | void removeAllHighPressureCompressors(); | ||
| 91 | |||
| 92 | std::vector<RefrigerationCompressor> highPressureCompressors() const; | ||
| 93 | |||
| 94 | bool addLowPressureCompressor(const RefrigerationCompressor& compressor); | ||
| 95 | |||
| 96 | void removeLowPressureCompressor(const RefrigerationCompressor& compressor); | ||
| 97 | |||
| 98 | void removeAllLowPressureCompressors(); | ||
| 99 | |||
| 100 | std::vector<RefrigerationCompressor> lowPressureCompressors() const; | ||
| 101 | |||
| 102 | /** @name Getters */ | ||
| 103 | //@{ | ||
| 104 | |||
| 105 | boost::optional<RefrigerationGasCoolerAirCooled> refrigerationGasCooler() const; | ||
| 106 | |||
| 107 | double receiverPressure() const; | ||
| 108 | |||
| 109 | bool isReceiverPressureDefaulted() const; | ||
| 110 | |||
| 111 | double subcoolerEffectiveness() const; | ||
| 112 | |||
| 113 | bool isSubcoolerEffectivenessDefaulted() const; | ||
| 114 | |||
| 115 | std::string refrigerationSystemWorkingFluidType() const; | ||
| 116 | |||
| 117 | double sumUASuctionPipingforMediumTemperatureLoads() const; | ||
| 118 | |||
| 119 | bool isSumUASuctionPipingforMediumTemperatureLoadsDefaulted() const; | ||
| 120 | |||
| 121 | boost::optional<ThermalZone> mediumTemperatureSuctionPipingZone() const; | ||
| 122 | |||
| 123 | double sumUASuctionPipingforLowTemperatureLoads() const; | ||
| 124 | |||
| 125 | bool isSumUASuctionPipingforLowTemperatureLoadsDefaulted() const; | ||
| 126 | |||
| 127 | boost::optional<ThermalZone> lowTemperatureSuctionPipingZone() const; | ||
| 128 | |||
| 129 | std::string endUseSubcategory() const; | ||
| 130 | |||
| 131 | bool isEndUseSubcategoryDefaulted() const; | ||
| 132 | |||
| 133 | //@} | ||
| 134 | /** @name Setters */ | ||
| 135 | //@{ | ||
| 136 | |||
| 137 | bool setRefrigerationGasCooler(const RefrigerationGasCoolerAirCooled& refrigerationGasCoolerAirCooled); | ||
| 138 | |||
| 139 | bool setReceiverPressure(double receiverPressure); | ||
| 140 | |||
| 141 | void resetReceiverPressure(); | ||
| 142 | |||
| 143 | bool setSubcoolerEffectiveness(double subcoolerEffectiveness); | ||
| 144 | |||
| 145 | void resetSubcoolerEffectiveness(); | ||
| 146 | |||
| 147 | bool setRefrigerationSystemWorkingFluidType(const std::string& refrigerationSystemWorkingFluidType); | ||
| 148 | |||
| 149 | bool setSumUASuctionPipingforMediumTemperatureLoads(double sumUASuctionPipingforMediumTemperatureLoads); | ||
| 150 | |||
| 151 | void resetSumUASuctionPipingforMediumTemperatureLoads(); | ||
| 152 | |||
| 153 | bool setMediumTemperatureSuctionPipingZone(const ThermalZone& thermalZone); | ||
| 154 | |||
| 155 | void resetMediumTemperatureSuctionPipingZone(); | ||
| 156 | |||
| 157 | bool setSumUASuctionPipingforLowTemperatureLoads(double sumUASuctionPipingforLowTemperatureLoads); | ||
| 158 | |||
| 159 | void resetSumUASuctionPipingforLowTemperatureLoads(); | ||
| 160 | |||
| 161 | bool setLowTemperatureSuctionPipingZone(const ThermalZone& thermalZone); | ||
| 162 | |||
| 163 | void resetLowTemperatureSuctionPipingZone(); | ||
| 164 | |||
| 165 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 166 | |||
| 167 | void resetEndUseSubcategory(); | ||
| 168 | |||
| 169 | //@} | ||
| 170 | /** @name Other */ | ||
| 171 | //@{ | ||
| 172 | |||
| 173 | //@} | ||
| 174 | protected: | ||
| 175 | /// @cond | ||
| 176 | using ImplType = detail::RefrigerationTranscriticalSystem_Impl; | ||
| 177 | |||
| 178 | explicit RefrigerationTranscriticalSystem(std::shared_ptr<detail::RefrigerationTranscriticalSystem_Impl> impl); | ||
| 179 | |||
| 180 | friend class detail::RefrigerationTranscriticalSystem_Impl; | ||
| 181 | friend class Model; | ||
| 182 | friend class IdfObject; | ||
| 183 | friend class openstudio::detail::IdfObject_Impl; | ||
| 184 | /// @endcond | ||
| 185 | private: | ||
| 186 | REGISTER_LOGGER("openstudio.model.RefrigerationTranscriticalSystem"); | ||
| 187 | }; | ||
| 188 | |||
| 189 | /** \relates RefrigerationTranscriticalSystem*/ | ||
| 190 | using OptionalRefrigerationTranscriticalSystem = boost::optional<RefrigerationTranscriticalSystem>; | ||
| 191 | |||
| 192 | /** \relates RefrigerationTranscriticalSystem*/ | ||
| 193 | using RefrigerationTranscriticalSystemVector = std::vector<RefrigerationTranscriticalSystem>; | ||
| 194 | |||
| 195 | } // namespace model | ||
| 196 | } // namespace openstudio | ||
| 197 | |||
| 198 | #endif // MODEL_REFRIGERATIONTRANSCRITICALSYSTEM_HPP | ||
| 199 |