GCC Code Coverage Report


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

src/model/CurveDoubleExponentialDecay.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_CURVEDOUBLEEXPONENTIALDECAY_HPP
7 #define MODEL_CURVEDOUBLEEXPONENTIALDECAY_HPP
8
9 #include "ModelAPI.hpp"
10 #include "Curve.hpp"
11 #include "../utilities/core/Deprecated.hpp"
12
13 namespace openstudio {
14 namespace model {
15
16 namespace detail {
17
18 class CurveDoubleExponentialDecay_Impl;
19
20 } // namespace detail
21
22 /** CurveDoubleExponentialDecay is a Curve that wraps the OpenStudio IDD object
23 * 'OS:Curve:DoubleExponentialDecay'. The functional form is \f$f(x) = ?\f$ */
24 class MODEL_API CurveDoubleExponentialDecay : public Curve
25 {
26 public:
27 /** @name Constructors and Destructors */
28 //@{
29
30 /** Sets all coefficients to 0.0 and sets the range for x to [0.0,1.0]. */
31 explicit CurveDoubleExponentialDecay(const Model& model);
32
33 1 virtual ~CurveDoubleExponentialDecay() override = default;
34 // Default the copy and move operators because the virtual dtor is explicit
35 ✗ CurveDoubleExponentialDecay(const CurveDoubleExponentialDecay& other) = default;
36 ✗ CurveDoubleExponentialDecay(CurveDoubleExponentialDecay&& other) = default;
37 ✗ CurveDoubleExponentialDecay& operator=(const CurveDoubleExponentialDecay&) = default;
38 ✗ CurveDoubleExponentialDecay& operator=(CurveDoubleExponentialDecay&&) = default;
39
40 //@}
41
42 static IddObjectType iddObjectType();
43
44 static std::vector<std::string> validInputUnitTypeforxValues();
45
46 static std::vector<std::string> validOutputUnitTypeValues();
47
48 /** @name Getters */
49 //@{
50
51 double coefficient1C1() const;
52
53 double coefficient2C2() const;
54
55 double coefficient3C3() const;
56
57 double coefficient4C4() const;
58 OS_DEPRECATED(3, 1, 0) double coefficient3C4() const; // TODO: ill-named, should be coefficient4C4
59
60 double coefficient5C5() const;
61 OS_DEPRECATED(3, 1, 0) double coefficient3C5() const; // TODO: ill-named, should be coefficient5C5
62
63 double minimumValueofx() const;
64
65 double maximumValueofx() const;
66
67 boost::optional<double> minimumCurveOutput() const;
68
69 boost::optional<double> maximumCurveOutput() const;
70
71 std::string inputUnitTypeforx() const;
72
73 bool isInputUnitTypeforxDefaulted() const;
74
75 std::string outputUnitType() const;
76
77 bool isOutputUnitTypeDefaulted() const;
78
79 //@}
80 /** @name Setters */
81 //@{
82
83 bool setCoefficient1C1(double coefficient1C1);
84
85 bool setCoefficient2C2(double coefficient2C2);
86
87 bool setCoefficient3C3(double coefficient3C3);
88
89 bool setCoefficient4C4(double coefficient4C4);
90 OS_DEPRECATED(3, 1, 0) bool setCoefficient3C4(double coefficient4C4);
91
92 bool setCoefficient5C5(double coefficient5C5);
93 OS_DEPRECATED(3, 1, 0) bool setCoefficient3C5(double coefficient5C5);
94
95 bool setMinimumValueofx(double minimumValueofx);
96
97 bool setMaximumValueofx(double maximumValueofx);
98
99 bool setMinimumCurveOutput(double minimumCurveOutput);
100
101 void resetMinimumCurveOutput();
102
103 bool setMaximumCurveOutput(double maximumCurveOutput);
104
105 void resetMaximumCurveOutput();
106
107 bool setInputUnitTypeforx(const std::string& inputUnitTypeforx);
108
109 void resetInputUnitTypeforx();
110
111 bool setOutputUnitType(const std::string& outputUnitType);
112
113 void resetOutputUnitType();
114
115 //@}
116 /** @name Other */
117 //@{
118
119 //@}
120 protected:
121 /// @cond
122 using ImplType = detail::CurveDoubleExponentialDecay_Impl;
123
124 explicit CurveDoubleExponentialDecay(std::shared_ptr<detail::CurveDoubleExponentialDecay_Impl> impl);
125
126 friend class detail::CurveDoubleExponentialDecay_Impl;
127 friend class Model;
128 friend class IdfObject;
129 friend class openstudio::detail::IdfObject_Impl;
130
131 /// @endcond
132 private:
133 − REGISTER_LOGGER("openstudio.model.CurveDoubleExponentialDecay");
134 };
135
136 /** \relates CurveDoubleExponentialDecay*/
137 using OptionalCurveDoubleExponentialDecay = boost::optional<CurveDoubleExponentialDecay>;
138
139 /** \relates CurveDoubleExponentialDecay*/
140 using CurveDoubleExponentialDecayVector = std::vector<CurveDoubleExponentialDecay>;
141
142 } // namespace model
143 } // namespace openstudio
144
145 #endif // MODEL_CURVEDOUBLEEXPONENTIALDECAY_HPP
146