GCC Code Coverage Report


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

src/model/PythonPluginOutputVariable.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_PYTHONPLUGINOUTPUTVARIABLE_HPP
7 #define MODEL_PYTHONPLUGINOUTPUTVARIABLE_HPP
8
9 #include <model/ModelAPI.hpp>
10 #include "ModelObject.hpp"
11
12 namespace openstudio {
13 namespace model {
14
15 class PythonPluginVariable;
16
17 namespace detail {
18
19 class PythonPluginOutputVariable_Impl;
20
21 } // namespace detail
22
23 /** PythonPluginOutputVariable is a ModelObject that wraps the OpenStudio IDD object 'OS:PythonPlugin:OutputVariable'. */
24 class MODEL_API PythonPluginOutputVariable : public ModelObject
25 {
26 public:
27 /** @name Constructors and Destructors */
28 //@{
29
30 explicit PythonPluginOutputVariable(const PythonPluginVariable& pythonPluginVariable);
31
32 102 virtual ~PythonPluginOutputVariable() override = default;
33
34 //@}
35
36 static IddObjectType iddObjectType();
37
38 static std::vector<std::string> typeofDatainVariableValues();
39
40 static std::vector<std::string> updateFrequencyValues();
41
42 static std::vector<std::string> resourceTypeValues();
43
44 static std::vector<std::string> groupTypeValues();
45
46 static std::vector<std::string> endUseCategoryValues();
47
48 /** @name Getters */
49 //@{
50
51 PythonPluginVariable pythonPluginVariable() const;
52
53 std::string typeofDatainVariable() const;
54
55 std::string updateFrequency() const;
56
57 boost::optional<std::string> units() const;
58
59 boost::optional<std::string> resourceType() const;
60
61 boost::optional<std::string> groupType() const;
62
63 boost::optional<std::string> endUseCategory() const;
64
65 boost::optional<std::string> endUseSubcategory() const;
66
67 //@}
68 /** @name Setters */
69 //@{
70
71 bool setPythonPluginVariable(const PythonPluginVariable& pythonPluginVariable);
72
73 bool setTypeofDatainVariable(const std::string& typeofDatainVariable);
74
75 bool setUpdateFrequency(const std::string& updateFrequency);
76
77 bool setUnits(const std::string& units);
78
79 void resetUnits();
80
81 bool setResourceType(const std::string& resourceType);
82
83 void resetResourceType();
84
85 bool setGroupType(const std::string& groupType);
86
87 void resetGroupType();
88
89 bool setEndUseCategory(const std::string& endUseCategory);
90
91 void resetEndUseCategory();
92
93 bool setEndUseSubcategory(const std::string& endUseSubcategory);
94
95 void resetEndUseSubcategory();
96
97 //@}
98 /** @name Other */
99 //@{
100
101 //@}
102 protected:
103 /// @cond
104 using ImplType = detail::PythonPluginOutputVariable_Impl;
105
106 explicit PythonPluginOutputVariable(std::shared_ptr<detail::PythonPluginOutputVariable_Impl> impl);
107
108 friend class detail::PythonPluginOutputVariable_Impl;
109 friend class Model;
110 friend class IdfObject;
111 friend class openstudio::detail::IdfObject_Impl;
112 /// @endcond
113 private:
114 REGISTER_LOGGER("openstudio.model.PythonPluginOutputVariable");
115 };
116
117 /** \relates PythonPluginOutputVariable*/
118 using OptionalPythonPluginOutputVariable = boost::optional<PythonPluginOutputVariable>;
119
120 /** \relates PythonPluginOutputVariable*/
121 using PythonPluginOutputVariableVector = std::vector<PythonPluginOutputVariable>;
122
123 } // namespace model
124 } // namespace openstudio
125
126 #endif // MODEL_PYTHONPLUGINOUTPUTVARIABLE_HPP
127