src/model/LuminaireDefinition_Impl.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_IMPL_HPP | ||
| 7 | #define MODEL_LUMINAIREDEFINITION_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "SpaceLoadDefinition_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class LuminaireDefinition; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | /** LuminaireDefinition_Impl is a SpaceLoadDefinition_Impl that is the implementation class for LuminaireDefinition.*/ | ||
| 20 | class MODEL_API LuminaireDefinition_Impl : public SpaceLoadDefinition_Impl | ||
| 21 | { | ||
| 22 | |||
| 23 | public: | ||
| 24 | /** @name Constructors and Destructors */ | ||
| 25 | //@{ | ||
| 26 | |||
| 27 | LuminaireDefinition_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | LuminaireDefinition_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | LuminaireDefinition_Impl(const LuminaireDefinition_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | 2 | virtual ~LuminaireDefinition_Impl() override = default; | |
| 34 | |||
| 35 | //@} | ||
| 36 | |||
| 37 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 38 | |||
| 39 | virtual IddObjectType iddObjectType() const override; | ||
| 40 | |||
| 41 | /** @name Getters */ | ||
| 42 | //@{ | ||
| 43 | |||
| 44 | // TODO: Handle Non-Extensible IddField IES File Path. | ||
| 45 | |||
| 46 | double lightingPower() const; | ||
| 47 | bool isLightingPowerDefaulted() const; | ||
| 48 | |||
| 49 | double fractionRadiant() const; | ||
| 50 | bool isFractionRadiantDefaulted() const; | ||
| 51 | |||
| 52 | double fractionVisible() const; | ||
| 53 | bool isFractionVisibleDefaulted() const; | ||
| 54 | |||
| 55 | double returnAirFraction() const; | ||
| 56 | bool isReturnAirFractionDefaulted() const; | ||
| 57 | |||
| 58 | bool returnAirFractionCalculatedfromPlenumTemperature() const; | ||
| 59 | bool isReturnAirFractionCalculatedfromPlenumTemperatureDefaulted() const; | ||
| 60 | |||
| 61 | double returnAirFractionFunctionofPlenumTemperatureCoefficient1() const; | ||
| 62 | bool isReturnAirFractionFunctionofPlenumTemperatureCoefficient1Defaulted() const; | ||
| 63 | |||
| 64 | double returnAirFractionFunctionofPlenumTemperatureCoefficient2() const; | ||
| 65 | bool isReturnAirFractionFunctionofPlenumTemperatureCoefficient2Defaulted() const; | ||
| 66 | |||
| 67 | //@} | ||
| 68 | /** @name Setters */ | ||
| 69 | //@{ | ||
| 70 | |||
| 71 | // TODO: Handle Non-Extensible IddField IES File Path. | ||
| 72 | |||
| 73 | bool setLightingPower(double lightingPower); | ||
| 74 | void resetLightingPower(); | ||
| 75 | |||
| 76 | bool setFractionRadiant(double fractionRadiant); | ||
| 77 | void resetFractionRadiant(); | ||
| 78 | |||
| 79 | bool setFractionVisible(double fractionVisible); | ||
| 80 | void resetFractionVisible(); | ||
| 81 | |||
| 82 | bool setReturnAirFraction(double returnAirFraction); | ||
| 83 | void resetReturnAirFraction(); | ||
| 84 | |||
| 85 | bool setReturnAirFractionCalculatedfromPlenumTemperature(bool returnAirFractionCalculatedfromPlenumTemperature); | ||
| 86 | void resetReturnAirFractionCalculatedfromPlenumTemperature(); | ||
| 87 | |||
| 88 | bool setReturnAirFractionFunctionofPlenumTemperatureCoefficient1(double returnAirFractionFunctionofPlenumTemperatureCoefficient1); | ||
| 89 | void resetReturnAirFractionFunctionofPlenumTemperatureCoefficient1(); | ||
| 90 | |||
| 91 | bool setReturnAirFractionFunctionofPlenumTemperatureCoefficient2(double returnAirFractionFunctionofPlenumTemperatureCoefficient2); | ||
| 92 | void resetReturnAirFractionFunctionofPlenumTemperatureCoefficient2(); | ||
| 93 | |||
| 94 | //@} | ||
| 95 | protected: | ||
| 96 | private: | ||
| 97 | REGISTER_LOGGER("openstudio.model.LuminaireDefinition"); | ||
| 98 | }; | ||
| 99 | |||
| 100 | } // namespace detail | ||
| 101 | |||
| 102 | } // namespace model | ||
| 103 | } // namespace openstudio | ||
| 104 | |||
| 105 | #endif // MODEL_LUMINAIREDEFINITION_IMPL_HPP | ||
| 106 |