src/model/BoilerSteam_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_BOILERSTEAM_IMPL_HPP | ||
| 7 | #define MODEL_BOILERSTEAM_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Node; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | /** BoilerSteam_Impl is a StraightComponent_Impl that is the implementation class for BoilerSteam.*/ | ||
| 20 | class MODEL_API BoilerSteam_Impl : public StraightComponent_Impl | ||
| 21 | { | ||
| 22 | |||
| 23 | public: | ||
| 24 | /** @name Constructors and Destructors */ | ||
| 25 | //@{ | ||
| 26 | |||
| 27 | BoilerSteam_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | BoilerSteam_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | BoilerSteam_Impl(const BoilerSteam_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | 6 | virtual ~BoilerSteam_Impl() override = default; | |
| 34 | |||
| 35 | //@} | ||
| 36 | /** @name Virtual Methods */ | ||
| 37 | //@{ | ||
| 38 | |||
| 39 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 40 | |||
| 41 | virtual IddObjectType iddObjectType() const override; | ||
| 42 | |||
| 43 | virtual void autosize() override; | ||
| 44 | |||
| 45 | virtual void applySizingValues() override; | ||
| 46 | |||
| 47 | virtual unsigned inletPort() const override; | ||
| 48 | |||
| 49 | virtual unsigned outletPort() const override; | ||
| 50 | |||
| 51 | virtual bool addToNode(Node& node) override; | ||
| 52 | |||
| 53 | virtual ComponentType componentType() const override; | ||
| 54 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 55 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 56 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 57 | |||
| 58 | //@} | ||
| 59 | /** @name Getters */ | ||
| 60 | //@{ | ||
| 61 | |||
| 62 | std::string fuelType() const; | ||
| 63 | |||
| 64 | boost::optional<double> maximumOperatingPressure() const; | ||
| 65 | |||
| 66 | boost::optional<double> theoreticalEfficiency() const; | ||
| 67 | |||
| 68 | boost::optional<double> designOutletSteamTemperature() const; | ||
| 69 | |||
| 70 | boost::optional<double> nominalCapacity() const; | ||
| 71 | |||
| 72 | bool isNominalCapacityAutosized() const; | ||
| 73 | |||
| 74 | boost::optional<double> minimumPartLoadRatio() const; | ||
| 75 | |||
| 76 | boost::optional<double> maximumPartLoadRatio() const; | ||
| 77 | |||
| 78 | boost::optional<double> optimumPartLoadRatio() const; | ||
| 79 | |||
| 80 | boost::optional<double> coefficient1ofFuelUseFunctionofPartLoadRatioCurve() const; | ||
| 81 | |||
| 82 | boost::optional<double> coefficient2ofFuelUseFunctionofPartLoadRatioCurve() const; | ||
| 83 | |||
| 84 | boost::optional<double> coefficient3ofFuelUseFunctionofPartLoadRatioCurve() const; | ||
| 85 | |||
| 86 | double sizingFactor() const; | ||
| 87 | |||
| 88 | bool isSizingFactorDefaulted() const; | ||
| 89 | |||
| 90 | boost::optional<double> autosizedNominalCapacity() const; | ||
| 91 | |||
| 92 | std::string endUseSubcategory() const; | ||
| 93 | |||
| 94 | //@} | ||
| 95 | /** @name Setters */ | ||
| 96 | //@{ | ||
| 97 | |||
| 98 | bool setFuelType(const std::string& fuelType); | ||
| 99 | |||
| 100 | bool setMaximumOperatingPressure(boost::optional<double> maximumOperatingPressure); | ||
| 101 | |||
| 102 | void resetMaximumOperatingPressure(); | ||
| 103 | |||
| 104 | bool setTheoreticalEfficiency(boost::optional<double> theoreticalEfficiency); | ||
| 105 | |||
| 106 | void resetTheoreticalEfficiency(); | ||
| 107 | |||
| 108 | bool setDesignOutletSteamTemperature(boost::optional<double> designOutletSteamTemperature); | ||
| 109 | |||
| 110 | void resetDesignOutletSteamTemperature(); | ||
| 111 | |||
| 112 | bool setNominalCapacity(boost::optional<double> nominalCapacity); | ||
| 113 | |||
| 114 | void resetNominalCapacity(); | ||
| 115 | |||
| 116 | void autosizeNominalCapacity(); | ||
| 117 | |||
| 118 | bool setMinimumPartLoadRatio(boost::optional<double> minimumPartLoadRatio); | ||
| 119 | |||
| 120 | void resetMinimumPartLoadRatio(); | ||
| 121 | |||
| 122 | bool setMaximumPartLoadRatio(boost::optional<double> maximumPartLoadRatio); | ||
| 123 | |||
| 124 | void resetMaximumPartLoadRatio(); | ||
| 125 | |||
| 126 | bool setOptimumPartLoadRatio(boost::optional<double> optimumPartLoadRatio); | ||
| 127 | |||
| 128 | void resetOptimumPartLoadRatio(); | ||
| 129 | |||
| 130 | bool setCoefficient1ofFuelUseFunctionofPartLoadRatioCurve(boost::optional<double> coefficient1ofFuelUseFunctionofPartLoadRatioCurve); | ||
| 131 | |||
| 132 | void resetCoefficient1ofFuelUseFunctionofPartLoadRatioCurve(); | ||
| 133 | |||
| 134 | bool setCoefficient2ofFuelUseFunctionofPartLoadRatioCurve(boost::optional<double> coefficient2ofFuelUseFunctionofPartLoadRatioCurve); | ||
| 135 | |||
| 136 | void resetCoefficient2ofFuelUseFunctionofPartLoadRatioCurve(); | ||
| 137 | |||
| 138 | bool setCoefficient3ofFuelUseFunctionofPartLoadRatioCurve(boost::optional<double> coefficient3ofFuelUseFunctionofPartLoadRatioCurve); | ||
| 139 | |||
| 140 | void resetCoefficient3ofFuelUseFunctionofPartLoadRatioCurve(); | ||
| 141 | |||
| 142 | bool setSizingFactor(double sizingFactor); | ||
| 143 | |||
| 144 | void resetSizingFactor(); | ||
| 145 | |||
| 146 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 147 | |||
| 148 | //@} | ||
| 149 | /** @name Other */ | ||
| 150 | //@{ | ||
| 151 | |||
| 152 | //@} | ||
| 153 | protected: | ||
| 154 | private: | ||
| 155 | REGISTER_LOGGER("openstudio.model.BoilerSteam"); | ||
| 156 | |||
| 157 | std::vector<std::string> fuelTypeValues() const; | ||
| 158 | }; | ||
| 159 | |||
| 160 | } // namespace detail | ||
| 161 | |||
| 162 | } // namespace model | ||
| 163 | } // namespace openstudio | ||
| 164 | |||
| 165 | #endif // MODEL_BOILERSTEAM_IMPL_HPP | ||
| 166 |