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/PythonPluginTrendVariable.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_PYTHONPLUGINTRENDVARIABLE_HPP
7 #define MODEL_PYTHONPLUGINTRENDVARIABLE_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 PythonPluginTrendVariable_Impl;
20
21 } // namespace detail
22
23 /** PythonPluginTrendVariable is a ModelObject that wraps the OpenStudio IDD object 'OS:PythonPlugin:TrendVariable'.
24 * While this object is fully functional, it is not the recommended way to do trending:
25 * just use a storage variable (eg: a list) in the python script */
26 class MODEL_API PythonPluginTrendVariable : public ModelObject
27 {
28 public:
29 /** @name Constructors and Destructors */
30 //@{
31
32 explicit PythonPluginTrendVariable(const PythonPluginVariable& pythonPluginVariable);
33
34 62 virtual ~PythonPluginTrendVariable() override = default;
35
36 //@}
37
38 static IddObjectType iddObjectType();
39
40 /** @name Getters */
41 //@{
42
43 PythonPluginVariable pythonPluginVariable() const;
44
45 int numberofTimestepstobeLogged() const;
46
47 //@}
48 /** @name Setters */
49 //@{
50
51 bool setPythonPluginVariable(const PythonPluginVariable& pythonPluginVariable);
52
53 bool setNumberofTimestepstobeLogged(int numberofTimestepstobeLogged);
54
55 //@}
56 /** @name Other */
57 //@{
58
59 //@}
60 protected:
61 /// @cond
62 using ImplType = detail::PythonPluginTrendVariable_Impl;
63
64 explicit PythonPluginTrendVariable(std::shared_ptr<detail::PythonPluginTrendVariable_Impl> impl);
65
66 friend class detail::PythonPluginTrendVariable_Impl;
67 friend class Model;
68 friend class IdfObject;
69 friend class openstudio::detail::IdfObject_Impl;
70 /// @endcond
71 private:
72 REGISTER_LOGGER("openstudio.model.PythonPluginTrendVariable");
73 };
74
75 /** \relates PythonPluginTrendVariable*/
76 using OptionalPythonPluginTrendVariable = boost::optional<PythonPluginTrendVariable>;
77
78 /** \relates PythonPluginTrendVariable*/
79 using PythonPluginTrendVariableVector = std::vector<PythonPluginTrendVariable>;
80
81 } // namespace model
82 } // namespace openstudio
83
84 #endif // MODEL_PYTHONPLUGINTRENDVARIABLE_HPP
85