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