src/model/BoilerSteam.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_BOILERSTEAM_HPP | ||
| 7 | #define MODEL_BOILERSTEAM_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | class BoilerSteam_Impl; | ||
| 19 | |||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** BoilerSteam is a StraightComponent that wraps the OpenStudio IDD object 'OS:Boiler:Steam'. */ | ||
| 23 | class MODEL_API BoilerSteam : public StraightComponent | ||
| 24 | { | ||
| 25 | |||
| 26 | public: | ||
| 27 | explicit BoilerSteam(const Model& model); | ||
| 28 | |||
| 29 | 3 | virtual ~BoilerSteam() override = default; | |
| 30 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 31 | ✗ | BoilerSteam(const BoilerSteam& other) = default; | |
| 32 | ✗ | BoilerSteam(BoilerSteam&& other) = default; | |
| 33 | ✗ | BoilerSteam& operator=(const BoilerSteam&) = default; | |
| 34 | ✗ | BoilerSteam& operator=(BoilerSteam&&) = default; | |
| 35 | |||
| 36 | static IddObjectType iddObjectType(); | ||
| 37 | |||
| 38 | static std::vector<std::string> fuelTypeValues(); | ||
| 39 | |||
| 40 | /** @name Getters and Setters */ | ||
| 41 | //@{ | ||
| 42 | |||
| 43 | std::string fuelType() const; | ||
| 44 | bool setFuelType(const std::string& fuelType); | ||
| 45 | |||
| 46 | boost::optional<double> maximumOperatingPressure() const; | ||
| 47 | bool setMaximumOperatingPressure(double maximumOperatingPressure); | ||
| 48 | void resetMaximumOperatingPressure(); | ||
| 49 | |||
| 50 | boost::optional<double> theoreticalEfficiency() const; | ||
| 51 | bool setTheoreticalEfficiency(double theoreticalEfficiency); | ||
| 52 | void resetTheoreticalEfficiency(); | ||
| 53 | |||
| 54 | boost::optional<double> designOutletSteamTemperature() const; | ||
| 55 | bool setDesignOutletSteamTemperature(double designOutletSteamTemperature); | ||
| 56 | void resetDesignOutletSteamTemperature(); | ||
| 57 | |||
| 58 | boost::optional<double> nominalCapacity() const; | ||
| 59 | bool isNominalCapacityAutosized() const; | ||
| 60 | bool setNominalCapacity(double nominalCapacity); | ||
| 61 | void resetNominalCapacity(); | ||
| 62 | void autosizeNominalCapacity(); | ||
| 63 | |||
| 64 | boost::optional<double> minimumPartLoadRatio() const; | ||
| 65 | bool setMinimumPartLoadRatio(double minimumPartLoadRatio); | ||
| 66 | void resetMinimumPartLoadRatio(); | ||
| 67 | |||
| 68 | boost::optional<double> maximumPartLoadRatio() const; | ||
| 69 | bool setMaximumPartLoadRatio(double maximumPartLoadRatio); | ||
| 70 | void resetMaximumPartLoadRatio(); | ||
| 71 | |||
| 72 | boost::optional<double> optimumPartLoadRatio() const; | ||
| 73 | bool setOptimumPartLoadRatio(double optimumPartLoadRatio); | ||
| 74 | void resetOptimumPartLoadRatio(); | ||
| 75 | |||
| 76 | boost::optional<double> coefficient1ofFuelUseFunctionofPartLoadRatioCurve() const; | ||
| 77 | bool setCoefficient1ofFuelUseFunctionofPartLoadRatioCurve(double coefficient1ofFuelUseFunctionofPartLoadRatioCurve); | ||
| 78 | void resetCoefficient1ofFuelUseFunctionofPartLoadRatioCurve(); | ||
| 79 | |||
| 80 | boost::optional<double> coefficient2ofFuelUseFunctionofPartLoadRatioCurve() const; | ||
| 81 | bool setCoefficient2ofFuelUseFunctionofPartLoadRatioCurve(double coefficient2ofFuelUseFunctionofPartLoadRatioCurve); | ||
| 82 | void resetCoefficient2ofFuelUseFunctionofPartLoadRatioCurve(); | ||
| 83 | |||
| 84 | boost::optional<double> coefficient3ofFuelUseFunctionofPartLoadRatioCurve() const; | ||
| 85 | bool setCoefficient3ofFuelUseFunctionofPartLoadRatioCurve(double coefficient3ofFuelUseFunctionofPartLoadRatioCurve); | ||
| 86 | void resetCoefficient3ofFuelUseFunctionofPartLoadRatioCurve(); | ||
| 87 | |||
| 88 | double sizingFactor() const; | ||
| 89 | bool isSizingFactorDefaulted() const; | ||
| 90 | bool setSizingFactor(double sizingFactor); | ||
| 91 | void resetSizingFactor(); | ||
| 92 | |||
| 93 | std::string endUseSubcategory() const; | ||
| 94 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 95 | |||
| 96 | //@} | ||
| 97 | /** @name Other */ | ||
| 98 | //@{ | ||
| 99 | |||
| 100 | //@} | ||
| 101 | |||
| 102 | boost::optional<double> autosizedNominalCapacity() const; | ||
| 103 | |||
| 104 | protected: | ||
| 105 | /// @cond | ||
| 106 | using ImplType = detail::BoilerSteam_Impl; | ||
| 107 | |||
| 108 | explicit BoilerSteam(std::shared_ptr<detail::BoilerSteam_Impl> impl); | ||
| 109 | |||
| 110 | friend class detail::BoilerSteam_Impl; | ||
| 111 | friend class Model; | ||
| 112 | friend class IdfObject; | ||
| 113 | friend class openstudio::detail::IdfObject_Impl; | ||
| 114 | |||
| 115 | /// @endcond | ||
| 116 | |||
| 117 | private: | ||
| 118 | REGISTER_LOGGER("openstudio.model.BoilerSteam"); | ||
| 119 | }; | ||
| 120 | |||
| 121 | /** \relates BoilerSteam*/ | ||
| 122 | using OptionalBoilerSteam = boost::optional<BoilerSteam>; | ||
| 123 | |||
| 124 | /** \relates BoilerSteam*/ | ||
| 125 | using BoilerSteamVector = std::vector<BoilerSteam>; | ||
| 126 | |||
| 127 | } // namespace model | ||
| 128 | } // namespace openstudio | ||
| 129 | |||
| 130 | #endif // MODEL_BOILERSTEAM_HPP | ||
| 131 |