src/model/ElectricLoadCenterTransformer_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_ELECTRICLOADCENTERTRANSFORMER_IMPL_HPP | ||
| 7 | #define MODEL_ELECTRICLOADCENTERTRANSFORMER_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Schedule; | ||
| 16 | class ThermalZone; | ||
| 17 | class OutputMeter; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | /** ElectricLoadCenterTransformer_Impl is a ModelObject_Impl that is the implementation class for ElectricLoadCenterTransformer.*/ | ||
| 22 | class MODEL_API ElectricLoadCenterTransformer_Impl : public ModelObject_Impl | ||
| 23 | { | ||
| 24 | public: | ||
| 25 | /** @name Constructors and Destructors */ | ||
| 26 | //@{ | ||
| 27 | |||
| 28 | ElectricLoadCenterTransformer_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | ElectricLoadCenterTransformer_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | ElectricLoadCenterTransformer_Impl(const ElectricLoadCenterTransformer_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | 13 | virtual ~ElectricLoadCenterTransformer_Impl() override = default; | |
| 35 | |||
| 36 | //@} | ||
| 37 | /** @name Virtual Methods */ | ||
| 38 | //@{ | ||
| 39 | |||
| 40 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 41 | |||
| 42 | virtual IddObjectType iddObjectType() const override; | ||
| 43 | |||
| 44 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 45 | |||
| 46 | //@} | ||
| 47 | /** @name Getters */ | ||
| 48 | //@{ | ||
| 49 | |||
| 50 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 51 | |||
| 52 | std::string transformerUsage() const; | ||
| 53 | |||
| 54 | bool isTransformerUsageDefaulted() const; | ||
| 55 | |||
| 56 | boost::optional<ThermalZone> zone() const; | ||
| 57 | |||
| 58 | double radiativeFraction() const; | ||
| 59 | |||
| 60 | bool isRadiativeFractionDefaulted() const; | ||
| 61 | |||
| 62 | boost::optional<double> ratedCapacity() const; | ||
| 63 | |||
| 64 | std::string phase() const; | ||
| 65 | |||
| 66 | bool isPhaseDefaulted() const; | ||
| 67 | |||
| 68 | std::string conductorMaterial() const; | ||
| 69 | |||
| 70 | bool isConductorMaterialDefaulted() const; | ||
| 71 | |||
| 72 | double fullLoadTemperatureRise() const; | ||
| 73 | |||
| 74 | bool isFullLoadTemperatureRiseDefaulted() const; | ||
| 75 | |||
| 76 | double fractionofEddyCurrentLosses() const; | ||
| 77 | |||
| 78 | bool isFractionofEddyCurrentLossesDefaulted() const; | ||
| 79 | |||
| 80 | std::string performanceInputMethod() const; | ||
| 81 | |||
| 82 | bool isPerformanceInputMethodDefaulted() const; | ||
| 83 | |||
| 84 | boost::optional<double> ratedNoLoadLoss() const; | ||
| 85 | |||
| 86 | boost::optional<double> ratedLoadLoss() const; | ||
| 87 | |||
| 88 | double nameplateEfficiency() const; | ||
| 89 | |||
| 90 | bool isNameplateEfficiencyDefaulted() const; | ||
| 91 | |||
| 92 | double perUnitLoadforNameplateEfficiency() const; | ||
| 93 | |||
| 94 | bool isPerUnitLoadforNameplateEfficiencyDefaulted() const; | ||
| 95 | |||
| 96 | double referenceTemperatureforNameplateEfficiency() const; | ||
| 97 | |||
| 98 | bool isReferenceTemperatureforNameplateEfficiencyDefaulted() const; | ||
| 99 | |||
| 100 | boost::optional<double> perUnitLoadforMaximumEfficiency() const; | ||
| 101 | |||
| 102 | bool considerTransformerLossforUtilityCost() const; | ||
| 103 | |||
| 104 | bool isConsiderTransformerLossforUtilityCostDefaulted() const; | ||
| 105 | |||
| 106 | std::vector<std::string> meters() const; | ||
| 107 | |||
| 108 | boost::optional<std::string> getMeter(unsigned index) const; | ||
| 109 | |||
| 110 | //@} | ||
| 111 | /** @name Setters */ | ||
| 112 | //@{ | ||
| 113 | |||
| 114 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 115 | |||
| 116 | void resetAvailabilitySchedule(); | ||
| 117 | |||
| 118 | bool setTransformerUsage(const std::string& transformerUsage); | ||
| 119 | |||
| 120 | void resetTransformerUsage(); | ||
| 121 | |||
| 122 | bool setZone(const ThermalZone& thermalZone); | ||
| 123 | |||
| 124 | void resetZone(); | ||
| 125 | |||
| 126 | bool setRadiativeFraction(double radiativeFraction); | ||
| 127 | |||
| 128 | void resetRadiativeFraction(); | ||
| 129 | |||
| 130 | bool setRatedCapacity(double ratedCapacity); | ||
| 131 | |||
| 132 | void resetRatedCapacity(); | ||
| 133 | |||
| 134 | bool setPhase(const std::string& phase); | ||
| 135 | |||
| 136 | void resetPhase(); | ||
| 137 | |||
| 138 | bool setConductorMaterial(const std::string& conductorMaterial); | ||
| 139 | |||
| 140 | void resetConductorMaterial(); | ||
| 141 | |||
| 142 | bool setFullLoadTemperatureRise(double fullLoadTemperatureRise); | ||
| 143 | |||
| 144 | void resetFullLoadTemperatureRise(); | ||
| 145 | |||
| 146 | bool setFractionofEddyCurrentLosses(double fractionofEddyCurrentLosses); | ||
| 147 | |||
| 148 | void resetFractionofEddyCurrentLosses(); | ||
| 149 | |||
| 150 | bool setPerformanceInputMethod(const std::string& performanceInputMethod); | ||
| 151 | |||
| 152 | void resetPerformanceInputMethod(); | ||
| 153 | |||
| 154 | bool setRatedNoLoadLoss(double ratedNoLoadLoss); | ||
| 155 | |||
| 156 | void resetRatedNoLoadLoss(); | ||
| 157 | |||
| 158 | bool setRatedLoadLoss(double ratedLoadLoss); | ||
| 159 | |||
| 160 | void resetRatedLoadLoss(); | ||
| 161 | |||
| 162 | bool setNameplateEfficiency(double nameplateEfficiency); | ||
| 163 | |||
| 164 | void resetNameplateEfficiency(); | ||
| 165 | |||
| 166 | bool setPerUnitLoadforNameplateEfficiency(double perUnitLoadforNameplateEfficiency); | ||
| 167 | |||
| 168 | void resetPerUnitLoadforNameplateEfficiency(); | ||
| 169 | |||
| 170 | bool setReferenceTemperatureforNameplateEfficiency(double referenceTemperatureforNameplateEfficiency); | ||
| 171 | |||
| 172 | void resetReferenceTemperatureforNameplateEfficiency(); | ||
| 173 | |||
| 174 | bool setPerUnitLoadforMaximumEfficiency(double perUnitLoadforMaximumEfficiency); | ||
| 175 | |||
| 176 | void resetPerUnitLoadforMaximumEfficiency(); | ||
| 177 | |||
| 178 | bool setConsiderTransformerLossforUtilityCost(bool considerTransformerLossforUtilityCost); | ||
| 179 | |||
| 180 | void resetConsiderTransformerLossforUtilityCost(); | ||
| 181 | |||
| 182 | void eraseMeters(); | ||
| 183 | |||
| 184 | bool eraseMeter(unsigned index); | ||
| 185 | |||
| 186 | bool addMeter(const std::string& meterName); | ||
| 187 | |||
| 188 | bool setMeter(const std::string& meterName, unsigned index); | ||
| 189 | |||
| 190 | //@} | ||
| 191 | /** @name Other */ | ||
| 192 | //@{ | ||
| 193 | |||
| 194 | //@} | ||
| 195 | protected: | ||
| 196 | private: | ||
| 197 | REGISTER_LOGGER("openstudio.model.ElectricLoadCenterTransformer"); | ||
| 198 | }; | ||
| 199 | |||
| 200 | } // namespace detail | ||
| 201 | |||
| 202 | } // namespace model | ||
| 203 | } // namespace openstudio | ||
| 204 | |||
| 205 | #endif // MODEL_ELECTRICLOADCENTERTRANSFORMER_IMPL_HPP | ||
| 206 |