src/model/ElectricLoadCenterStorageConverter_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_ELECTRICLOADCENTERSTORAGECONVERTER_IMPL_HPP | ||
| 7 | #define MODEL_ELECTRICLOADCENTERSTORAGECONVERTER_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ParentObject_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Schedule; | ||
| 16 | class Curve; //UniVariateCurves; | ||
| 17 | class ThermalZone; | ||
| 18 | class ElectricLoadCenterDistribution; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | /** ElectricLoadCenterStorageConverter_Impl is a ParentObject_Impl that is the implementation class for ElectricLoadCenterStorageConverter.*/ | ||
| 23 | class MODEL_API ElectricLoadCenterStorageConverter_Impl : public ParentObject_Impl | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | ElectricLoadCenterStorageConverter_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | ElectricLoadCenterStorageConverter_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | ElectricLoadCenterStorageConverter_Impl(const ElectricLoadCenterStorageConverter_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | 1 | virtual ~ElectricLoadCenterStorageConverter_Impl() override = default; | |
| 36 | |||
| 37 | //@} | ||
| 38 | /** @name Virtual Methods */ | ||
| 39 | //@{ | ||
| 40 | |||
| 41 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 42 | |||
| 43 | virtual IddObjectType iddObjectType() const override; | ||
| 44 | |||
| 45 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 46 | |||
| 47 | //@} | ||
| 48 | /** @name Getters */ | ||
| 49 | //@{ | ||
| 50 | |||
| 51 | boost::optional<ElectricLoadCenterDistribution> electricLoadCenterDistribution() const; | ||
| 52 | |||
| 53 | Schedule availabilitySchedule() const; | ||
| 54 | bool isAvailabilityScheduleDefaulted() const; | ||
| 55 | |||
| 56 | std::string powerConversionEfficiencyMethod() const; | ||
| 57 | |||
| 58 | // Required if powerConversionEfficiencyMethod == "SimpleFixed" | ||
| 59 | boost::optional<double> simpleFixedEfficiency() const; | ||
| 60 | |||
| 61 | // Required if powerConversionEfficiencyMethod == "FunctionOfPower" | ||
| 62 | boost::optional<double> designMaximumContinuousInputPower() const; | ||
| 63 | |||
| 64 | // Required if powerConversionEfficiencyMethod == "FunctionOfPower" | ||
| 65 | // TODO: Later may need to add support for Tables. (UniVariateCurves, UniVariateTables.) | ||
| 66 | boost::optional<Curve> efficiencyFunctionofPowerCurve() const; | ||
| 67 | |||
| 68 | // Defaults to 0.0 | ||
| 69 | double ancillaryPowerConsumedInStandby() const; | ||
| 70 | |||
| 71 | bool isAncillaryPowerConsumedInStandbyDefaulted() const; | ||
| 72 | |||
| 73 | boost::optional<ThermalZone> thermalZone() const; | ||
| 74 | |||
| 75 | // Defualts to 0.0, because E+ doc says that if omitted, all heat gains are conductive | ||
| 76 | double radiativeFraction() const; | ||
| 77 | |||
| 78 | bool isRadiativeFractionDefaulted() const; | ||
| 79 | |||
| 80 | //@} | ||
| 81 | /** @name Setters */ | ||
| 82 | //@{ | ||
| 83 | |||
| 84 | // TODO: Check argument type. From object lists, some candidates are: Schedule. | ||
| 85 | // Note Schedules are passed by reference, not const reference. | ||
| 86 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 87 | void resetAvailabilitySchedule(); | ||
| 88 | |||
| 89 | // No Setter, will be done when calling one of the three following functions | ||
| 90 | //bool setPowerConversionEfficiencyMethod(const std::string& powerConversionEfficiencyMethod); | ||
| 91 | |||
| 92 | bool setSimpleFixedEfficiency(double simpleFixedEfficiency); | ||
| 93 | |||
| 94 | bool setDesignMaximumContinuousInputPower(double designMaximumContinuousInputPower); | ||
| 95 | |||
| 96 | bool setEfficiencyFunctionofPowerCurve(const Curve& efficiencyFunctionofPowerCurve); | ||
| 97 | |||
| 98 | bool setAncillaryPowerConsumedInStandby(double ancillaryPowerConsumedInStandby); | ||
| 99 | |||
| 100 | void resetAncillaryPowerConsumedInStandby(); | ||
| 101 | |||
| 102 | bool setThermalZone(const ThermalZone& thermalZone); | ||
| 103 | |||
| 104 | void resetThermalZone(); | ||
| 105 | |||
| 106 | bool setRadiativeFraction(double radiativeFraction); | ||
| 107 | |||
| 108 | void resetRadiativeFraction(); | ||
| 109 | |||
| 110 | //@} | ||
| 111 | /** @name Other */ | ||
| 112 | //@{ | ||
| 113 | |||
| 114 | //@} | ||
| 115 | protected: | ||
| 116 | private: | ||
| 117 | REGISTER_LOGGER("openstudio.model.ElectricLoadCenterStorageConverter"); | ||
| 118 | boost::optional<Schedule> optionalAvailabilitySchedule() const; | ||
| 119 | }; | ||
| 120 | |||
| 121 | } // namespace detail | ||
| 122 | |||
| 123 | } // namespace model | ||
| 124 | } // namespace openstudio | ||
| 125 | |||
| 126 | #endif // MODEL_ELECTRICLOADCENTERSTORAGECONVERTER_IMPL_HPP | ||
| 127 |