GCC Code Coverage Report


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

src/model/LuminaireDefinition.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_LUMINAIREDEFINITION_HPP
7 #define MODEL_LUMINAIREDEFINITION_HPP
8
9 #include "ModelAPI.hpp"
10 #include "SpaceLoadDefinition.hpp"
11
12 namespace openstudio {
13 namespace model {
14
15 namespace detail {
16
17 class LuminaireDefinition_Impl;
18
19 } // namespace detail
20
21 /** LuminaireDefinition is a SpaceLoadDefinition that wraps the OpenStudio IDD object
22 * 'OS_Luminaire_Definition'. \sa Luminaire */
23 class MODEL_API LuminaireDefinition : public SpaceLoadDefinition
24 {
25
26 public:
27 /** @name Constructors and Destructors */
28 //@{
29
30 explicit LuminaireDefinition(const Model& model);
31
32 6 virtual ~LuminaireDefinition() override = default;
33 // Default the copy and move operators because the virtual dtor is explicit
34 ✗ LuminaireDefinition(const LuminaireDefinition& other) = default;
35 2 LuminaireDefinition(LuminaireDefinition&& other) = default;
36 ✗ LuminaireDefinition& operator=(const LuminaireDefinition&) = default;
37 ✗ LuminaireDefinition& operator=(LuminaireDefinition&&) = default;
38
39 //@}
40 /** @name Static Methods */
41 //@{
42
43 static IddObjectType iddObjectType();
44
45 //@}
46 /** @name Getters */
47 //@{
48
49 // TODO: Handle Non-Extensible IddField IES File Path.
50
51 double lightingPower() const;
52 bool isLightingPowerDefaulted() const;
53
54 double fractionRadiant() const;
55 bool isFractionRadiantDefaulted() const;
56
57 double fractionVisible() const;
58 bool isFractionVisibleDefaulted() const;
59
60 double returnAirFraction() const;
61 bool isReturnAirFractionDefaulted() const;
62
63 bool returnAirFractionCalculatedfromPlenumTemperature() const;
64 bool isReturnAirFractionCalculatedfromPlenumTemperatureDefaulted() const;
65
66 double returnAirFractionFunctionofPlenumTemperatureCoefficient1() const;
67 bool isReturnAirFractionFunctionofPlenumTemperatureCoefficient1Defaulted() const;
68
69 double returnAirFractionFunctionofPlenumTemperatureCoefficient2() const;
70 bool isReturnAirFractionFunctionofPlenumTemperatureCoefficient2Defaulted() const;
71
72 //@}
73 /** @name Setters */
74 //@{
75
76 // TODO: Handle Non-Extensible IddField IES File Path.
77
78 bool setLightingPower(double lightingPower);
79 void resetLightingPower();
80
81 bool setFractionRadiant(double fractionRadiant);
82 void resetFractionRadiant();
83
84 bool setFractionVisible(double fractionVisible);
85 void resetFractionVisible();
86
87 bool setReturnAirFraction(double returnAirFraction);
88 void resetReturnAirFraction();
89
90 bool setReturnAirFractionCalculatedfromPlenumTemperature(bool returnAirFractionCalculatedfromPlenumTemperature);
91 void resetReturnAirFractionCalculatedfromPlenumTemperature();
92
93 bool setReturnAirFractionFunctionofPlenumTemperatureCoefficient1(double returnAirFractionFunctionofPlenumTemperatureCoefficient1);
94 void resetReturnAirFractionFunctionofPlenumTemperatureCoefficient1();
95
96 bool setReturnAirFractionFunctionofPlenumTemperatureCoefficient2(double returnAirFractionFunctionofPlenumTemperatureCoefficient2);
97 void resetReturnAirFractionFunctionofPlenumTemperatureCoefficient2();
98
99 //@}
100 protected:
101 /// @cond
102 using ImplType = detail::LuminaireDefinition_Impl;
103
104 friend class Model;
105 friend class openstudio::IdfObject;
106
107 explicit LuminaireDefinition(std::shared_ptr<detail::LuminaireDefinition_Impl> impl);
108
109 /// @endcond
110 private:
111 REGISTER_LOGGER("openstudio.model.LuminaireDefinition");
112 };
113
114 /** \relates LuminaireDefinition*/
115 using OptionalLuminaireDefinition = boost::optional<LuminaireDefinition>;
116
117 /** \relates LuminaireDefinition*/
118 using LuminaireDefinitionVector = std::vector<LuminaireDefinition>;
119
120 } // namespace model
121 } // namespace openstudio
122
123 #endif // MODEL_LUMINAIREDEFINITION_HPP
124