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