src/model/ElectricLoadCenterStorageSimple_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_ELECTRICLOADCENTERSTORAGESIMPLE_IMPL_HPP | ||
| 7 | #define MODEL_ELECTRICLOADCENTERSTORAGESIMPLE_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ElectricalStorage_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Schedule; | ||
| 16 | class ThermalZone; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | /** ElectricLoadCenterStorageSimple_Impl is a ElectricalStorage_Impl that is the implementation class for ElectricLoadCenterStorageSimple.*/ | ||
| 21 | class MODEL_API ElectricLoadCenterStorageSimple_Impl : public ElectricalStorage_Impl | ||
| 22 | { | ||
| 23 | public: | ||
| 24 | /** @name Constructors and Destructors */ | ||
| 25 | //@{ | ||
| 26 | |||
| 27 | ElectricLoadCenterStorageSimple_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | ElectricLoadCenterStorageSimple_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | ElectricLoadCenterStorageSimple_Impl(const ElectricLoadCenterStorageSimple_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | 2 | virtual ~ElectricLoadCenterStorageSimple_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 std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 44 | |||
| 45 | //@} | ||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | // Convenience method to return the electricalLoadCenter on which it's assigned (optional) | ||
| 50 | // Included in Base Class | ||
| 51 | // boost::optional<ElectricLoadCenterDistribution> electricLoadCenterDistribution() const; | ||
| 52 | |||
| 53 | Schedule availabilitySchedule() const; | ||
| 54 | bool isAvailabilityScheduleDefaulted() const; | ||
| 55 | |||
| 56 | virtual boost::optional<ThermalZone> thermalZone() const override; | ||
| 57 | |||
| 58 | double radiativeFractionforZoneHeatGains() const; | ||
| 59 | bool isRadiativeFractionforZoneHeatGainsDefaulted() const; | ||
| 60 | |||
| 61 | double nominalEnergeticEfficiencyforCharging() const; | ||
| 62 | bool isNominalEnergeticEfficiencyforChargingDefaulted() const; | ||
| 63 | |||
| 64 | // TODO: I've requested an .IDD change in EnergyPlus, to make this "Nominal Energetic Efficiency for Discharging" | ||
| 65 | // TODO: https://github.com/NREL/EnergyPlus/issues/5730 | ||
| 66 | double nominalDischargingEnergeticEfficiency() const; | ||
| 67 | bool isNominalDischargingEnergeticEfficiencyDefaulted() const; | ||
| 68 | |||
| 69 | double maximumStorageCapacity() const; | ||
| 70 | |||
| 71 | double maximumPowerforDischarging() const; | ||
| 72 | |||
| 73 | double maximumPowerforCharging() const; | ||
| 74 | |||
| 75 | double initialStateofCharge() const; | ||
| 76 | bool isInitialStateofChargeDefaulted() const; | ||
| 77 | |||
| 78 | virtual std::vector<EMSActuatorNames> emsActuatorNames() const override; | ||
| 79 | |||
| 80 | virtual std::vector<std::string> emsInternalVariableNames() const override; | ||
| 81 | |||
| 82 | //@} | ||
| 83 | /** @name Setters */ | ||
| 84 | //@{ | ||
| 85 | |||
| 86 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 87 | void resetAvailabilitySchedule(); | ||
| 88 | |||
| 89 | // Override ElectricalStorage (Base class) methods | ||
| 90 | virtual bool setThermalZone(const ThermalZone& thermalZone) override; | ||
| 91 | virtual void resetThermalZone() override; | ||
| 92 | |||
| 93 | bool setRadiativeFractionforZoneHeatGains(double radiativeFractionforZoneHeatGains); | ||
| 94 | void resetRadiativeFractionforZoneHeatGains(); | ||
| 95 | |||
| 96 | bool setNominalEnergeticEfficiencyforCharging(double nominalEnergeticEfficiencyforCharging); | ||
| 97 | void resetNominalEnergeticEfficiencyforCharging(); | ||
| 98 | |||
| 99 | bool setNominalDischargingEnergeticEfficiency(double nominalDischargingEnergeticEfficiency); | ||
| 100 | void resetNominalDischargingEnergeticEfficiency(); | ||
| 101 | |||
| 102 | bool setMaximumStorageCapacity(double maximumStorageCapacity); | ||
| 103 | |||
| 104 | bool setMaximumPowerforDischarging(double maximumPowerforDischarging); | ||
| 105 | |||
| 106 | bool setMaximumPowerforCharging(double maximumPowerforCharging); | ||
| 107 | |||
| 108 | bool setInitialStateofCharge(double initialStateofCharge); | ||
| 109 | void resetInitialStateofCharge(); | ||
| 110 | |||
| 111 | //@} | ||
| 112 | /** @name Other */ | ||
| 113 | //@{ | ||
| 114 | |||
| 115 | // TODO: Remove if not used. Don't think I need to override any of these | ||
| 116 | //ModelObject clone(Model model) const override; | ||
| 117 | |||
| 118 | //std::vector<openstudio::IdfObject> remove() override; | ||
| 119 | |||
| 120 | //std::vector<ModelObject> children() const override; | ||
| 121 | |||
| 122 | //@} | ||
| 123 | protected: | ||
| 124 | private: | ||
| 125 | REGISTER_LOGGER("openstudio.model.ElectricLoadCenterStorageSimple"); | ||
| 126 | boost::optional<Schedule> optionalAvailabilitySchedule() const; | ||
| 127 | }; | ||
| 128 | |||
| 129 | } // namespace detail | ||
| 130 | |||
| 131 | } // namespace model | ||
| 132 | } // namespace openstudio | ||
| 133 | |||
| 134 | #endif // MODEL_ELECTRICLOADCENTERSTORAGESIMPLE_IMPL_HPP | ||
| 135 |