GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 40.0% 2 / 0 / 5
Functions: 40.0% 2 / 0 / 5
Branches: -% 0 / 0 / 0

src/model/ElectricLoadCenterStorageConverter.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_HPP
7 #define MODEL_ELECTRICLOADCENTERSTORAGECONVERTER_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ParentObject.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class Schedule;
17 class Curve;
18 class ThermalZone;
19 class ElectricLoadCenterDistribution;
20
21 namespace detail {
22
23 class ElectricLoadCenterStorageConverter_Impl;
24
25 } // namespace detail
26
27 /** ElectricLoadCenterStorageConverter is a ParentObject that wraps the OpenStudio IDD object 'OS:ElectricLoadCenter:Storage:Converter'. */
28 class MODEL_API ElectricLoadCenterStorageConverter : public ParentObject
29 {
30 public:
31 /** @name Constructors and Destructors */
32 //@{
33
34 explicit ElectricLoadCenterStorageConverter(const Model& model);
35
36 4 virtual ~ElectricLoadCenterStorageConverter() override = default;
37 // Default the copy and move operators because the virtual dtor is explicit
38 ✗ ElectricLoadCenterStorageConverter(const ElectricLoadCenterStorageConverter& other) = default;
39 2 ElectricLoadCenterStorageConverter(ElectricLoadCenterStorageConverter&& other) = default;
40 ✗ ElectricLoadCenterStorageConverter& operator=(const ElectricLoadCenterStorageConverter&) = default;
41 ✗ ElectricLoadCenterStorageConverter& operator=(ElectricLoadCenterStorageConverter&&) = default;
42
43 //@}
44
45 static IddObjectType iddObjectType();
46
47 static std::vector<std::string> powerConversionEfficiencyMethodValues();
48
49 /** @name Getters */
50 //@{
51
52 boost::optional<ElectricLoadCenterDistribution> electricLoadCenterDistribution() const;
53
54 Schedule availabilitySchedule() const;
55 bool isAvailabilityScheduleDefaulted() const;
56
57 std::string powerConversionEfficiencyMethod() const;
58
59 // Required if powerConversionEfficiencyMethod == "SimpleFixed"
60 boost::optional<double> simpleFixedEfficiency() const;
61
62 // Required if powerConversionEfficiencyMethod == "FunctionOfPower"
63 boost::optional<double> designMaximumContinuousInputPower() const;
64
65 // Required if powerConversionEfficiencyMethod == "FunctionOfPower"
66 // TODO: Later may need to add support for Tables. (UniVariateCurves, UniVariateTables.)
67 boost::optional<Curve> efficiencyFunctionofPowerCurve() const;
68
69 // Defaults to 0.0
70 double ancillaryPowerConsumedInStandby() const;
71
72 bool isAncillaryPowerConsumedInStandbyDefaulted() const;
73
74 // TODO: Check return type. From object lists, some candidates are: ThermalZone.
75 boost::optional<ThermalZone> thermalZone() const;
76
77 double radiativeFraction() const;
78
79 bool isRadiativeFractionDefaulted() const;
80
81 //@}
82 /** @name Setters */
83 //@{
84
85 // TODO: Check argument type. From object lists, some candidates are: Schedule.
86 // Note Schedules are passed by reference, not const reference.
87 bool setAvailabilitySchedule(Schedule& schedule);
88
89 void resetAvailabilitySchedule();
90
91 // No Setter, will be done when calling one of the three following functions
92 //bool setPowerConversionEfficiencyMethod(const std::string& powerConversionEfficiencyMethod);
93
94 bool setSimpleFixedEfficiency(double simpleFixedEfficiency);
95
96 bool setDesignMaximumContinuousInputPower(double designMaximumContinuousInputPower);
97
98 bool setEfficiencyFunctionofPowerCurve(const Curve& efficiencyFunctionofPowerCurve);
99
100 bool setAncillaryPowerConsumedInStandby(double ancillaryPowerConsumedInStandby);
101
102 void resetAncillaryPowerConsumedInStandby();
103
104 // TODO: Check argument type. From object lists, some candidates are: ThermalZone.
105 bool setThermalZone(const ThermalZone& thermalZone);
106
107 void resetThermalZone();
108
109 bool setRadiativeFraction(double radiativeFraction);
110
111 void resetRadiativeFraction();
112
113 //@}
114 /** @name Other */
115 //@{
116
117 //@}
118 protected:
119 /// @cond
120 using ImplType = detail::ElectricLoadCenterStorageConverter_Impl;
121
122 explicit ElectricLoadCenterStorageConverter(std::shared_ptr<detail::ElectricLoadCenterStorageConverter_Impl> impl);
123
124 friend class detail::ElectricLoadCenterStorageConverter_Impl;
125 friend class Model;
126 friend class IdfObject;
127 friend class openstudio::detail::IdfObject_Impl;
128 /// @endcond
129 private:
130 REGISTER_LOGGER("openstudio.model.ElectricLoadCenterStorageConverter");
131 };
132
133 /** \relates ElectricLoadCenterStorageConverter */
134 using OptionalElectricLoadCenterStorageConverter = boost::optional<ElectricLoadCenterStorageConverter>;
135
136 /** \relates ElectricLoadCenterStorageConverter */
137 using ElectricLoadCenterStorageConverterVector = std::vector<ElectricLoadCenterStorageConverter>;
138
139 } // namespace model
140 } // namespace openstudio
141
142 #endif // MODEL_ELECTRICLOADCENTERSTORAGECONVERTER_HPP
143