src/model/FuelFactors.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_FUELFACTORS_HPP | ||
| 7 | #define MODEL_FUELFACTORS_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | class FuelFactors_Impl; | ||
| 21 | |||
| 22 | } // namespace detail | ||
| 23 | |||
| 24 | /** FuelFactors is a ModelObject that wraps the OpenStudio IDD object 'OS:FuelFactors'. */ | ||
| 25 | class MODEL_API FuelFactors : public ModelObject | ||
| 26 | { | ||
| 27 | public: | ||
| 28 | /** @name Constructors and Destructors */ | ||
| 29 | //@{ | ||
| 30 | |||
| 31 | explicit FuelFactors(const Model& model); | ||
| 32 | |||
| 33 | 31 | virtual ~FuelFactors() override = default; | |
| 34 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 35 | 1 | FuelFactors(const FuelFactors& other) = default; | |
| 36 | 6 | FuelFactors(FuelFactors&& other) = default; | |
| 37 | ✗ | FuelFactors& operator=(const FuelFactors&) = default; | |
| 38 | ✗ | FuelFactors& operator=(FuelFactors&&) = default; | |
| 39 | |||
| 40 | //@} | ||
| 41 | |||
| 42 | static IddObjectType iddObjectType(); | ||
| 43 | |||
| 44 | static std::vector<std::string> existingFuelResourceNameValues(); | ||
| 45 | |||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | std::string existingFuelResourceName() const; | ||
| 50 | |||
| 51 | double sourceEnergyFactor() const; | ||
| 52 | |||
| 53 | boost::optional<Schedule> sourceEnergySchedule() const; | ||
| 54 | |||
| 55 | double cO2EmissionFactor() const; | ||
| 56 | |||
| 57 | boost::optional<Schedule> cO2EmissionFactorSchedule() const; | ||
| 58 | |||
| 59 | double cOEmissionFactor() const; | ||
| 60 | |||
| 61 | boost::optional<Schedule> cOEmissionFactorSchedule() const; | ||
| 62 | |||
| 63 | double cH4EmissionFactor() const; | ||
| 64 | |||
| 65 | boost::optional<Schedule> cH4EmissionFactorSchedule() const; | ||
| 66 | |||
| 67 | double nOxEmissionFactor() const; | ||
| 68 | |||
| 69 | boost::optional<Schedule> nOxEmissionFactorSchedule() const; | ||
| 70 | |||
| 71 | double n2OEmissionFactor() const; | ||
| 72 | |||
| 73 | boost::optional<Schedule> n2OEmissionFactorSchedule() const; | ||
| 74 | |||
| 75 | double sO2EmissionFactor() const; | ||
| 76 | |||
| 77 | boost::optional<Schedule> sO2EmissionFactorSchedule() const; | ||
| 78 | |||
| 79 | double pMEmissionFactor() const; | ||
| 80 | |||
| 81 | boost::optional<Schedule> pMEmissionFactorSchedule() const; | ||
| 82 | |||
| 83 | double pM10EmissionFactor() const; | ||
| 84 | |||
| 85 | boost::optional<Schedule> pM10EmissionFactorSchedule() const; | ||
| 86 | |||
| 87 | double pM25EmissionFactor() const; | ||
| 88 | |||
| 89 | boost::optional<Schedule> pM25EmissionFactorSchedule() const; | ||
| 90 | |||
| 91 | double nH3EmissionFactor() const; | ||
| 92 | |||
| 93 | boost::optional<Schedule> nH3EmissionFactorSchedule() const; | ||
| 94 | |||
| 95 | double nMVOCEmissionFactor() const; | ||
| 96 | |||
| 97 | boost::optional<Schedule> nMVOCEmissionFactorSchedule() const; | ||
| 98 | |||
| 99 | double hgEmissionFactor() const; | ||
| 100 | |||
| 101 | boost::optional<Schedule> hgEmissionFactorSchedule() const; | ||
| 102 | |||
| 103 | double pbEmissionFactor() const; | ||
| 104 | |||
| 105 | boost::optional<Schedule> pbEmissionFactorSchedule() const; | ||
| 106 | |||
| 107 | double waterEmissionFactor() const; | ||
| 108 | |||
| 109 | boost::optional<Schedule> waterEmissionFactorSchedule() const; | ||
| 110 | |||
| 111 | double nuclearHighLevelEmissionFactor() const; | ||
| 112 | |||
| 113 | boost::optional<Schedule> nuclearHighLevelEmissionFactorSchedule() const; | ||
| 114 | |||
| 115 | double nuclearLowLevelEmissionFactor() const; | ||
| 116 | |||
| 117 | boost::optional<Schedule> nuclearLowLevelEmissionFactorSchedule() const; | ||
| 118 | |||
| 119 | //@} | ||
| 120 | /** @name Setters */ | ||
| 121 | //@{ | ||
| 122 | |||
| 123 | bool setExistingFuelResourceName(const std::string& existingFuelResourceName); | ||
| 124 | |||
| 125 | bool setSourceEnergyFactor(double sourceEnergyFactor); | ||
| 126 | |||
| 127 | bool setSourceEnergySchedule(Schedule& schedule); | ||
| 128 | void resetSourceEnergySchedule(); | ||
| 129 | |||
| 130 | bool setCO2EmissionFactor(double cO2EmissionFactor); | ||
| 131 | |||
| 132 | bool setCO2EmissionFactorSchedule(Schedule& schedule); | ||
| 133 | void resetCO2EmissionFactorSchedule(); | ||
| 134 | |||
| 135 | bool setCOEmissionFactor(double cOEmissionFactor); | ||
| 136 | |||
| 137 | bool setCOEmissionFactorSchedule(Schedule& schedule); | ||
| 138 | void resetCOEmissionFactorSchedule(); | ||
| 139 | |||
| 140 | bool setCH4EmissionFactor(double cH4EmissionFactor); | ||
| 141 | |||
| 142 | bool setCH4EmissionFactorSchedule(Schedule& schedule); | ||
| 143 | void resetCH4EmissionFactorSchedule(); | ||
| 144 | |||
| 145 | bool setNOxEmissionFactor(double nOxEmissionFactor); | ||
| 146 | |||
| 147 | bool setNOxEmissionFactorSchedule(Schedule& schedule); | ||
| 148 | |||
| 149 | void resetNOxEmissionFactorSchedule(); | ||
| 150 | |||
| 151 | bool setN2OEmissionFactor(double n2OEmissionFactor); | ||
| 152 | |||
| 153 | bool setN2OEmissionFactorSchedule(Schedule& schedule); | ||
| 154 | void resetN2OEmissionFactorSchedule(); | ||
| 155 | |||
| 156 | bool setSO2EmissionFactor(double sO2EmissionFactor); | ||
| 157 | |||
| 158 | bool setSO2EmissionFactorSchedule(Schedule& schedule); | ||
| 159 | void resetSO2EmissionFactorSchedule(); | ||
| 160 | |||
| 161 | bool setPMEmissionFactor(double pMEmissionFactor); | ||
| 162 | |||
| 163 | bool setPMEmissionFactorSchedule(Schedule& schedule); | ||
| 164 | void resetPMEmissionFactorSchedule(); | ||
| 165 | |||
| 166 | bool setPM10EmissionFactor(double pM10EmissionFactor); | ||
| 167 | |||
| 168 | bool setPM10EmissionFactorSchedule(Schedule& schedule); | ||
| 169 | void resetPM10EmissionFactorSchedule(); | ||
| 170 | |||
| 171 | bool setPM25EmissionFactor(double pM25EmissionFactor); | ||
| 172 | |||
| 173 | bool setPM25EmissionFactorSchedule(Schedule& schedule); | ||
| 174 | void resetPM25EmissionFactorSchedule(); | ||
| 175 | |||
| 176 | bool setNH3EmissionFactor(double nH3EmissionFactor); | ||
| 177 | |||
| 178 | bool setNH3EmissionFactorSchedule(Schedule& schedule); | ||
| 179 | void resetNH3EmissionFactorSchedule(); | ||
| 180 | |||
| 181 | bool setNMVOCEmissionFactor(double nMVOCEmissionFactor); | ||
| 182 | |||
| 183 | bool setNMVOCEmissionFactorSchedule(Schedule& schedule); | ||
| 184 | void resetNMVOCEmissionFactorSchedule(); | ||
| 185 | |||
| 186 | bool setHgEmissionFactor(double hgEmissionFactor); | ||
| 187 | |||
| 188 | bool setHgEmissionFactorSchedule(Schedule& schedule); | ||
| 189 | void resetHgEmissionFactorSchedule(); | ||
| 190 | |||
| 191 | bool setPbEmissionFactor(double pbEmissionFactor); | ||
| 192 | |||
| 193 | bool setPbEmissionFactorSchedule(Schedule& schedule); | ||
| 194 | void resetPbEmissionFactorSchedule(); | ||
| 195 | |||
| 196 | bool setWaterEmissionFactor(double waterEmissionFactor); | ||
| 197 | |||
| 198 | bool setWaterEmissionFactorSchedule(Schedule& schedule); | ||
| 199 | void resetWaterEmissionFactorSchedule(); | ||
| 200 | |||
| 201 | bool setNuclearHighLevelEmissionFactor(double nuclearHighLevelEmissionFactor); | ||
| 202 | |||
| 203 | bool setNuclearHighLevelEmissionFactorSchedule(Schedule& schedule); | ||
| 204 | void resetNuclearHighLevelEmissionFactorSchedule(); | ||
| 205 | |||
| 206 | bool setNuclearLowLevelEmissionFactor(double nuclearLowLevelEmissionFactor); | ||
| 207 | |||
| 208 | bool setNuclearLowLevelEmissionFactorSchedule(Schedule& schedule); | ||
| 209 | void resetNuclearLowLevelEmissionFactorSchedule(); | ||
| 210 | |||
| 211 | //@} | ||
| 212 | /** @name Other */ | ||
| 213 | //@{ | ||
| 214 | |||
| 215 | //@} | ||
| 216 | protected: | ||
| 217 | /// @cond | ||
| 218 | using ImplType = detail::FuelFactors_Impl; | ||
| 219 | |||
| 220 | explicit FuelFactors(std::shared_ptr<detail::FuelFactors_Impl> impl); | ||
| 221 | |||
| 222 | friend class detail::FuelFactors_Impl; | ||
| 223 | friend class Model; | ||
| 224 | friend class IdfObject; | ||
| 225 | friend class openstudio::detail::IdfObject_Impl; | ||
| 226 | /// @endcond | ||
| 227 | private: | ||
| 228 | REGISTER_LOGGER("openstudio.model.FuelFactors"); | ||
| 229 | }; | ||
| 230 | |||
| 231 | /** \relates FuelFactors*/ | ||
| 232 | using OptionalFuelFactors = boost::optional<FuelFactors>; | ||
| 233 | |||
| 234 | /** \relates FuelFactors*/ | ||
| 235 | using FuelFactorsVector = std::vector<FuelFactors>; | ||
| 236 | |||
| 237 | } // namespace model | ||
| 238 | } // namespace openstudio | ||
| 239 | |||
| 240 | #endif // MODEL_FUELFACTORS_HPP | ||
| 241 |