src/model/SizingPlant.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_SIZINGPLANT_HPP | ||
| 7 | #define MODEL_SIZINGPLANT_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class PlantLoop; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | class SizingPlant_Impl; | ||
| 21 | |||
| 22 | } // namespace detail | ||
| 23 | |||
| 24 | /** SizingPlant is a ModelObject that wraps the OpenStudio IDD object 'OS:Sizing:Plant'. */ | ||
| 25 | class MODEL_API SizingPlant : public ModelObject | ||
| 26 | { | ||
| 27 | public: | ||
| 28 | explicit SizingPlant(const Model& model, const PlantLoop& plantLoop); | ||
| 29 | |||
| 30 | 4867 | virtual ~SizingPlant() override = default; | |
| 31 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 32 | 1058 | SizingPlant(const SizingPlant& other) = default; | |
| 33 | 1527 | SizingPlant(SizingPlant&& other) = default; | |
| 34 | ✗ | SizingPlant& operator=(const SizingPlant&) = default; | |
| 35 | ✗ | SizingPlant& operator=(SizingPlant&&) = default; | |
| 36 | |||
| 37 | static IddObjectType iddObjectType(); | ||
| 38 | |||
| 39 | static std::vector<std::string> loopTypeValues(); | ||
| 40 | |||
| 41 | static std::vector<std::string> sizingOptionValues(); | ||
| 42 | |||
| 43 | static std::vector<std::string> coincidentSizingFactorModeValues(); | ||
| 44 | |||
| 45 | PlantLoop plantLoop() const; | ||
| 46 | |||
| 47 | bool setPlantLoop(const PlantLoop& plantLoop); | ||
| 48 | |||
| 49 | std::string loopType() const; | ||
| 50 | |||
| 51 | bool setLoopType(const std::string& loopType); | ||
| 52 | |||
| 53 | double designLoopExitTemperature() const; | ||
| 54 | |||
| 55 | bool setDesignLoopExitTemperature(double designLoopExitTemperature); | ||
| 56 | |||
| 57 | double loopDesignTemperatureDifference() const; | ||
| 58 | |||
| 59 | bool setLoopDesignTemperatureDifference(double loopDesignTemperatureDifference); | ||
| 60 | |||
| 61 | std::string sizingOption() const; | ||
| 62 | |||
| 63 | bool setSizingOption(const std::string& sizingOption); | ||
| 64 | |||
| 65 | int zoneTimestepsinAveragingWindow() const; | ||
| 66 | |||
| 67 | bool setZoneTimestepsinAveragingWindow(int zoneTimestepsinAveragingWindow); | ||
| 68 | |||
| 69 | std::string coincidentSizingFactorMode() const; | ||
| 70 | |||
| 71 | bool setCoincidentSizingFactorMode(const std::string& coincidentSizingFactorMode); | ||
| 72 | |||
| 73 | protected: | ||
| 74 | /// @cond | ||
| 75 | using ImplType = detail::SizingPlant_Impl; | ||
| 76 | |||
| 77 | explicit SizingPlant(std::shared_ptr<detail::SizingPlant_Impl> impl); | ||
| 78 | |||
| 79 | friend class detail::SizingPlant_Impl; | ||
| 80 | friend class Model; | ||
| 81 | friend class IdfObject; | ||
| 82 | friend class openstudio::detail::IdfObject_Impl; | ||
| 83 | /// @endcond | ||
| 84 | |||
| 85 | private: | ||
| 86 | REGISTER_LOGGER("openstudio.model.SizingPlant"); | ||
| 87 | }; | ||
| 88 | |||
| 89 | /** \relates SizingPlant*/ | ||
| 90 | using OptionalSizingPlant = boost::optional<SizingPlant>; | ||
| 91 | |||
| 92 | /** \relates SizingPlant*/ | ||
| 93 | using SizingPlantVector = std::vector<SizingPlant>; | ||
| 94 | |||
| 95 | } // namespace model | ||
| 96 | } // namespace openstudio | ||
| 97 | |||
| 98 | #endif // MODEL_SIZINGPLANT_HPP | ||
| 99 |