GCC Code Coverage Report


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

src/model/EnergyManagementSystemMeteredOutputVariable.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_ENERGYMANAGEMENTSYSTEMMETEREDOUTPUTVARIABLE_HPP
7 #define MODEL_ENERGYMANAGEMENTSYSTEMMETEREDOUTPUTVARIABLE_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ModelObject.hpp"
11 #include "EnergyManagementSystemProgram.hpp"
12 #include "EnergyManagementSystemSubroutine.hpp"
13 #include "EnergyManagementSystemActuator.hpp"
14 #include "EnergyManagementSystemSensor.hpp"
15 #include "EnergyManagementSystemGlobalVariable.hpp"
16 #include "EnergyManagementSystemTrendVariable.hpp"
17 #include "EnergyManagementSystemInternalVariable.hpp"
18 #include "EnergyManagementSystemCurveOrTableIndexVariable.hpp"
19 #include "EnergyManagementSystemConstructionIndexVariable.hpp"
20
21 namespace openstudio {
22
23 class AppGFuelType;
24 class ComponentType;
25 class FuelType;
26
27 namespace energyplus {
28 class ReverseTranslator;
29 }
30
31 namespace model {
32
33 namespace detail {
34
35 class EnergyManagementSystemMeteredOutputVariable_Impl;
36
37 } // namespace detail
38
39 /** EnergyManagementSystemMeteredOutputVariable is a ModelObject that wraps the OpenStudio IDD object 'OS:EnergyManagementSystem:MeteredOutputVariable'. */
40 class MODEL_API EnergyManagementSystemMeteredOutputVariable : public ModelObject
41 {
42 public:
43 /** @name Constructors and Destructors */
44 //@{
45
46 explicit EnergyManagementSystemMeteredOutputVariable(const Model& model, const std::string eMSVariableName);
47
48 explicit EnergyManagementSystemMeteredOutputVariable(const Model& model, const EnergyManagementSystemActuator& object);
49
50 explicit EnergyManagementSystemMeteredOutputVariable(const Model& model, const EnergyManagementSystemSensor& object);
51
52 explicit EnergyManagementSystemMeteredOutputVariable(const Model& model, const EnergyManagementSystemGlobalVariable& object);
53
54 explicit EnergyManagementSystemMeteredOutputVariable(const Model& model, const EnergyManagementSystemTrendVariable& object);
55
56 explicit EnergyManagementSystemMeteredOutputVariable(const Model& model, const EnergyManagementSystemInternalVariable& object);
57
58 explicit EnergyManagementSystemMeteredOutputVariable(const Model& model, const EnergyManagementSystemCurveOrTableIndexVariable& object);
59
60 explicit EnergyManagementSystemMeteredOutputVariable(const Model& model, const EnergyManagementSystemConstructionIndexVariable& object);
61
62 201 virtual ~EnergyManagementSystemMeteredOutputVariable() override = default;
63 // Default the copy and move operators because the virtual dtor is explicit
64 ✗ EnergyManagementSystemMeteredOutputVariable(const EnergyManagementSystemMeteredOutputVariable& other) = default;
65 126 EnergyManagementSystemMeteredOutputVariable(EnergyManagementSystemMeteredOutputVariable&& other) = default;
66 ✗ EnergyManagementSystemMeteredOutputVariable& operator=(const EnergyManagementSystemMeteredOutputVariable&) = default;
67 ✗ EnergyManagementSystemMeteredOutputVariable& operator=(EnergyManagementSystemMeteredOutputVariable&&) = default;
68
69 //@}
70
71 static IddObjectType iddObjectType();
72
73 static std::vector<std::string> updateFrequencyValues();
74
75 static std::vector<std::string> resourceTypeValues();
76
77 static std::vector<std::string> groupTypeValues();
78
79 static std::vector<std::string> endUseCategoryValues();
80
81 /** @name Getters */
82 //@{
83
84 std::string emsVariableName() const;
85
86 std::string updateFrequency() const;
87
88 std::string emsProgramOrSubroutineName() const;
89
90 boost::optional<EnergyManagementSystemProgram> emsProgram() const;
91
92 boost::optional<EnergyManagementSystemSubroutine> emsSubroutine() const;
93
94 std::string resourceType() const;
95
96 std::string groupType() const;
97
98 std::string endUseCategory() const;
99
100 std::string endUseSubcategory() const;
101
102 std::string units() const;
103
104 boost::optional<ModelObject> emsVariableObject() const;
105
106 boost::optional<EnergyManagementSystemActuator> emsActuator() const;
107 boost::optional<EnergyManagementSystemSensor> emsSensor() const;
108 boost::optional<EnergyManagementSystemGlobalVariable> emsGlobalVariable() const;
109 boost::optional<EnergyManagementSystemTrendVariable> emsTrendVariable() const;
110 boost::optional<EnergyManagementSystemInternalVariable> emsInternalVariable() const;
111 boost::optional<EnergyManagementSystemCurveOrTableIndexVariable> emsCurveOrTableIndexVariable() const;
112 boost::optional<EnergyManagementSystemConstructionIndexVariable> emsConstructionIndexVariable() const;
113
114 //@}
115 /** @name Setters */
116 //@{
117
118 bool setEMSVariableName(const std::string& eMSVariableName);
119
120 bool setUpdateFrequency(const std::string& updateFrequency);
121
122 bool setEMSProgramOrSubroutineName(const EnergyManagementSystemProgram& program);
123
124 bool setEMSProgramOrSubroutineName(const EnergyManagementSystemSubroutine& subroutine);
125
126 void resetEMSProgramOrSubroutineName();
127
128 bool setResourceType(const std::string& resourceType);
129
130 bool setGroupType(const std::string& groupType);
131
132 bool setEndUseCategory(const std::string& endUseCategory);
133
134 bool setEndUseSubcategory(const std::string& endUseSubcategory);
135
136 void resetEndUseSubcategory();
137
138 bool setUnits(const std::string& units);
139
140 void resetUnits();
141
142 bool setEMSVariableName(const EnergyManagementSystemActuator& object);
143 bool setEMSVariableName(const EnergyManagementSystemSensor& object);
144 bool setEMSVariableName(const EnergyManagementSystemGlobalVariable& object);
145 bool setEMSVariableName(const EnergyManagementSystemTrendVariable& object);
146 bool setEMSVariableName(const EnergyManagementSystemInternalVariable& object);
147 bool setEMSVariableName(const EnergyManagementSystemCurveOrTableIndexVariable& object);
148 bool setEMSVariableName(const EnergyManagementSystemConstructionIndexVariable& object);
149
150 //@}
151 /** @name Other */
152 //@{
153
154 // This is not an HVACComponent but it will help in the determination of the PlantUserDefinedComponent, so implementation is here because it's
155 // more logical
156 ComponentType componentType() const;
157 std::vector<FuelType> coolingFuelTypes() const;
158 std::vector<FuelType> heatingFuelTypes() const;
159 std::vector<AppGFuelType> appGHeatingFuelTypes() const;
160
161 //@}
162 protected:
163 /// @cond
164 using ImplType = detail::EnergyManagementSystemMeteredOutputVariable_Impl;
165
166 explicit EnergyManagementSystemMeteredOutputVariable(std::shared_ptr<detail::EnergyManagementSystemMeteredOutputVariable_Impl> impl);
167
168 friend class detail::EnergyManagementSystemMeteredOutputVariable_Impl;
169 friend class Model;
170 friend class IdfObject;
171 friend class openstudio::detail::IdfObject_Impl;
172 friend class energyplus::ReverseTranslator;
173 /// @endcond
174 private:
175 − REGISTER_LOGGER("openstudio.model.EnergyManagementSystemMeteredOutputVariable");
176 explicit EnergyManagementSystemMeteredOutputVariable(const Model& model);
177 };
178
179 /** \relates EnergyManagementSystemMeteredOutputVariable*/
180 using OptionalEnergyManagementSystemMeteredOutputVariable = boost::optional<EnergyManagementSystemMeteredOutputVariable>;
181
182 /** \relates EnergyManagementSystemMeteredOutputVariable*/
183 using EnergyManagementSystemMeteredOutputVariableVector = std::vector<EnergyManagementSystemMeteredOutputVariable>;
184
185 } // namespace model
186 } // namespace openstudio
187
188 #endif // MODEL_ENERGYMANAGEMENTSYSTEMMETEREDOUTPUTVARIABLE_HPP
189