src/model/ExteriorLights_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_EXTERIORLIGHTS_IMPL_HPP | ||
| 7 | #define MODEL_EXTERIORLIGHTS_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ExteriorLoadInstance_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class ExteriorLightsDefinition; | ||
| 16 | class Schedule; | ||
| 17 | class Facility; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | /** ExteriorLights_Impl is a ExteriorLoadInstance_Impl that is the implementation class for ExteriorLights.*/ | ||
| 22 | class MODEL_API ExteriorLights_Impl : public ExteriorLoadInstance_Impl | ||
| 23 | { | ||
| 24 | |||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | ExteriorLights_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | ExteriorLights_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | ExteriorLights_Impl(const ExteriorLights_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | 32 | virtual ~ExteriorLights_Impl() override = default; | |
| 36 | |||
| 37 | //@} | ||
| 38 | /** @name Virtual Methods */ | ||
| 39 | //@{ | ||
| 40 | |||
| 41 | virtual boost::optional<ParentObject> parent() const override; | ||
| 42 | |||
| 43 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 44 | |||
| 45 | virtual IddObjectType iddObjectType() const override; | ||
| 46 | |||
| 47 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 48 | |||
| 49 | virtual double multiplier() const override; | ||
| 50 | |||
| 51 | virtual bool isMultiplierDefaulted() const override; | ||
| 52 | |||
| 53 | virtual bool setDefinition(const ExteriorLoadDefinition& definition) override; | ||
| 54 | |||
| 55 | virtual std::vector<EMSActuatorNames> emsActuatorNames() const override; | ||
| 56 | |||
| 57 | virtual std::vector<std::string> emsInternalVariableNames() const override; | ||
| 58 | |||
| 59 | //@} | ||
| 60 | /** @name Getters */ | ||
| 61 | //@{ | ||
| 62 | |||
| 63 | ExteriorLightsDefinition exteriorLightsDefinition() const; | ||
| 64 | |||
| 65 | boost::optional<Schedule> schedule() const; | ||
| 66 | |||
| 67 | std::string controlOption() const; | ||
| 68 | |||
| 69 | bool isControlOptionDefaulted() const; | ||
| 70 | |||
| 71 | std::string endUseSubcategory() const; | ||
| 72 | |||
| 73 | bool isEndUseSubcategoryDefaulted() const; | ||
| 74 | |||
| 75 | //@} | ||
| 76 | /** @name Setters */ | ||
| 77 | //@{ | ||
| 78 | |||
| 79 | bool setExteriorLightsDefinition(const ExteriorLightsDefinition& exteriorLightsDefinition); | ||
| 80 | |||
| 81 | bool setSchedule(Schedule& schedule); | ||
| 82 | |||
| 83 | void resetSchedule(); | ||
| 84 | bool setControlOption(const std::string& controlOption); | ||
| 85 | |||
| 86 | void resetControlOption(); | ||
| 87 | |||
| 88 | bool setMultiplier(double multiplier); | ||
| 89 | |||
| 90 | void resetMultiplier(); | ||
| 91 | |||
| 92 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 93 | |||
| 94 | void resetEndUseSubcategory(); | ||
| 95 | |||
| 96 | //@} | ||
| 97 | /** @name Other */ | ||
| 98 | //@{ | ||
| 99 | |||
| 100 | Facility facility() const; | ||
| 101 | |||
| 102 | //@} | ||
| 103 | protected: | ||
| 104 | // index of the definition name | ||
| 105 | virtual int definitionIndex() const override; | ||
| 106 | |||
| 107 | private: | ||
| 108 | REGISTER_LOGGER("openstudio.model.ExteriorLights"); | ||
| 109 | |||
| 110 | std::vector<std::string> controlOptionValues() const; | ||
| 111 | |||
| 112 | boost::optional<ModelObject> exteriorLightsDefinitionAsModelObject() const; | ||
| 113 | boost::optional<ModelObject> scheduleAsModelObject() const; | ||
| 114 | boost::optional<ModelObject> facilityAsModelObject() const; | ||
| 115 | |||
| 116 | bool setExteriorLightsDefinitionAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 117 | bool setScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 118 | }; | ||
| 119 | |||
| 120 | } // namespace detail | ||
| 121 | |||
| 122 | } // namespace model | ||
| 123 | } // namespace openstudio | ||
| 124 | |||
| 125 | #endif // MODEL_EXTERIORLIGHTS_IMPL_HPP | ||
| 126 |