src/model/CurveQuintLinear.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_CURVEQUINTLINEAR_HPP | ||
| 7 | #define MODEL_CURVEQUINTLINEAR_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "Curve.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | class CurveQuintLinear_Impl; | ||
| 19 | |||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** CurveQuintLinear is a Curve that wraps the OpenStudio IDD object 'OS:Curve:QuintLinear'. | ||
| 23 | * The functional form is \f$f(v, w, x, y, z) = c_1 + c_2 \cdot v + c_3 \cdot w + c_4 \cdot x + c_5 \cdot y + c_6 \cdot z\f$ */ | ||
| 24 | class MODEL_API CurveQuintLinear : public Curve | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | explicit CurveQuintLinear(const Model& model); | ||
| 31 | |||
| 32 | 67 | virtual ~CurveQuintLinear() override = default; | |
| 33 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 34 | 1 | CurveQuintLinear(const CurveQuintLinear& other) = default; | |
| 35 | 16 | CurveQuintLinear(CurveQuintLinear&& other) = default; | |
| 36 | ✗ | CurveQuintLinear& operator=(const CurveQuintLinear&) = default; | |
| 37 | ✗ | CurveQuintLinear& operator=(CurveQuintLinear&&) = default; | |
| 38 | |||
| 39 | //@} | ||
| 40 | |||
| 41 | static IddObjectType iddObjectType(); | ||
| 42 | |||
| 43 | static std::vector<std::string> inputUnitTypeforvValues(); | ||
| 44 | |||
| 45 | static std::vector<std::string> inputUnitTypeforwValues(); | ||
| 46 | |||
| 47 | static std::vector<std::string> inputUnitTypeforxValues(); | ||
| 48 | |||
| 49 | static std::vector<std::string> inputUnitTypeforyValues(); | ||
| 50 | |||
| 51 | static std::vector<std::string> inputUnitTypeforzValues(); | ||
| 52 | |||
| 53 | /** @name Getters */ | ||
| 54 | //@{ | ||
| 55 | |||
| 56 | double coefficient1Constant() const; | ||
| 57 | |||
| 58 | double coefficient2v() const; | ||
| 59 | |||
| 60 | double coefficient3w() const; | ||
| 61 | |||
| 62 | double coefficient4x() const; | ||
| 63 | |||
| 64 | double coefficient5y() const; | ||
| 65 | |||
| 66 | double coefficient6z() const; | ||
| 67 | |||
| 68 | double minimumValueofv() const; | ||
| 69 | |||
| 70 | double maximumValueofv() const; | ||
| 71 | |||
| 72 | double minimumValueofw() const; | ||
| 73 | |||
| 74 | double maximumValueofw() const; | ||
| 75 | |||
| 76 | double minimumValueofx() const; | ||
| 77 | |||
| 78 | double maximumValueofx() const; | ||
| 79 | |||
| 80 | double minimumValueofy() const; | ||
| 81 | |||
| 82 | double maximumValueofy() const; | ||
| 83 | |||
| 84 | double minimumValueofz() const; | ||
| 85 | |||
| 86 | double maximumValueofz() const; | ||
| 87 | |||
| 88 | boost::optional<double> minimumCurveOutput() const; | ||
| 89 | |||
| 90 | boost::optional<double> maximumCurveOutput() const; | ||
| 91 | |||
| 92 | std::string inputUnitTypeforv() const; | ||
| 93 | |||
| 94 | bool isInputUnitTypeforvDefaulted() const; | ||
| 95 | |||
| 96 | std::string inputUnitTypeforw() const; | ||
| 97 | |||
| 98 | bool isInputUnitTypeforwDefaulted() const; | ||
| 99 | |||
| 100 | std::string inputUnitTypeforx() const; | ||
| 101 | |||
| 102 | bool isInputUnitTypeforxDefaulted() const; | ||
| 103 | |||
| 104 | std::string inputUnitTypefory() const; | ||
| 105 | |||
| 106 | bool isInputUnitTypeforyDefaulted() const; | ||
| 107 | |||
| 108 | std::string inputUnitTypeforz() const; | ||
| 109 | |||
| 110 | bool isInputUnitTypeforzDefaulted() const; | ||
| 111 | |||
| 112 | //@} | ||
| 113 | /** @name Setters */ | ||
| 114 | //@{ | ||
| 115 | |||
| 116 | bool setCoefficient1Constant(double coefficient1Constant); | ||
| 117 | |||
| 118 | bool setCoefficient2v(double coefficient2v); | ||
| 119 | |||
| 120 | bool setCoefficient3w(double coefficient3w); | ||
| 121 | |||
| 122 | bool setCoefficient4x(double coefficient4x); | ||
| 123 | |||
| 124 | bool setCoefficient5y(double coefficient5y); | ||
| 125 | |||
| 126 | bool setCoefficient6z(double coefficient6z); | ||
| 127 | |||
| 128 | bool setMinimumValueofv(double minimumValueofv); | ||
| 129 | |||
| 130 | bool setMaximumValueofv(double maximumValueofv); | ||
| 131 | |||
| 132 | bool setMinimumValueofw(double minimumValueofw); | ||
| 133 | |||
| 134 | bool setMaximumValueofw(double maximumValueofw); | ||
| 135 | |||
| 136 | bool setMinimumValueofx(double minimumValueofx); | ||
| 137 | |||
| 138 | bool setMaximumValueofx(double maximumValueofx); | ||
| 139 | |||
| 140 | bool setMinimumValueofy(double minimumValueofy); | ||
| 141 | |||
| 142 | bool setMaximumValueofy(double maximumValueofy); | ||
| 143 | |||
| 144 | bool setMinimumValueofz(double minimumValueofz); | ||
| 145 | |||
| 146 | bool setMaximumValueofz(double maximumValueofz); | ||
| 147 | |||
| 148 | bool setMinimumCurveOutput(double minimumCurveOutput); | ||
| 149 | |||
| 150 | void resetMinimumCurveOutput(); | ||
| 151 | |||
| 152 | bool setMaximumCurveOutput(double maximumCurveOutput); | ||
| 153 | |||
| 154 | void resetMaximumCurveOutput(); | ||
| 155 | |||
| 156 | bool setInputUnitTypeforv(const std::string& inputUnitTypeforv); | ||
| 157 | |||
| 158 | void resetInputUnitTypeforv(); | ||
| 159 | |||
| 160 | bool setInputUnitTypeforw(const std::string& inputUnitTypeforw); | ||
| 161 | |||
| 162 | void resetInputUnitTypeforw(); | ||
| 163 | |||
| 164 | bool setInputUnitTypeforx(const std::string& inputUnitTypeforx); | ||
| 165 | |||
| 166 | void resetInputUnitTypeforx(); | ||
| 167 | |||
| 168 | bool setInputUnitTypefory(const std::string& inputUnitTypefory); | ||
| 169 | |||
| 170 | void resetInputUnitTypefory(); | ||
| 171 | |||
| 172 | bool setInputUnitTypeforz(const std::string& inputUnitTypeforz); | ||
| 173 | |||
| 174 | void resetInputUnitTypeforz(); | ||
| 175 | |||
| 176 | //@} | ||
| 177 | /** @name Other */ | ||
| 178 | //@{ | ||
| 179 | |||
| 180 | //@} | ||
| 181 | protected: | ||
| 182 | /// @cond | ||
| 183 | using ImplType = detail::CurveQuintLinear_Impl; | ||
| 184 | |||
| 185 | explicit CurveQuintLinear(std::shared_ptr<detail::CurveQuintLinear_Impl> impl); | ||
| 186 | |||
| 187 | friend class detail::CurveQuintLinear_Impl; | ||
| 188 | friend class Model; | ||
| 189 | friend class IdfObject; | ||
| 190 | friend class openstudio::detail::IdfObject_Impl; | ||
| 191 | /// @endcond | ||
| 192 | private: | ||
| 193 | REGISTER_LOGGER("openstudio.model.CurveQuintLinear"); | ||
| 194 | }; | ||
| 195 | |||
| 196 | /** \relates CurveQuintLinear*/ | ||
| 197 | using OptionalCurveQuintLinear = boost::optional<CurveQuintLinear>; | ||
| 198 | |||
| 199 | /** \relates CurveQuintLinear*/ | ||
| 200 | using CurveQuintLinearVector = std::vector<CurveQuintLinear>; | ||
| 201 | |||
| 202 | } // namespace model | ||
| 203 | } // namespace openstudio | ||
| 204 | |||
| 205 | #endif // MODEL_CURVEQUINTLINEAR_HPP | ||
| 206 |