src/model/ExteriorWaterEquipment.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_EXTERIORWATEREQUIPMENT_HPP | ||
| 7 | #define MODEL_EXTERIORWATEREQUIPMENT_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ExteriorLoadInstance.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class ExteriorWaterEquipmentDefinition; | ||
| 16 | class Schedule; | ||
| 17 | class Facility; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class ExteriorWaterEquipment_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** ExteriorWaterEquipment is a ExteriorLoadInstance that wraps the OpenStudio IDD object | ||
| 26 | * 'OS:Exterior:WaterEquipment'. ExteriorWaterEquipment is a child of Facility and instances | ||
| 27 | * ExteriorWaterEquipmentDefinition. */ | ||
| 28 | class MODEL_API ExteriorWaterEquipment : public ExteriorLoadInstance | ||
| 29 | { | ||
| 30 | public: | ||
| 31 | /** @name Constructors and Destructors */ | ||
| 32 | //@{ | ||
| 33 | |||
| 34 | /** This constructor sets schedule to always on */ | ||
| 35 | ExteriorWaterEquipment(const ExteriorWaterEquipmentDefinition& definition); | ||
| 36 | |||
| 37 | /** This constructor requires a user-specified schedule. */ | ||
| 38 | ExteriorWaterEquipment(const ExteriorWaterEquipmentDefinition& definition, Schedule& schedule); | ||
| 39 | |||
| 40 | 32 | virtual ~ExteriorWaterEquipment() override = default; | |
| 41 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 42 | 1 | ExteriorWaterEquipment(const ExteriorWaterEquipment& other) = default; | |
| 43 | 10 | ExteriorWaterEquipment(ExteriorWaterEquipment&& other) = default; | |
| 44 | ✗ | ExteriorWaterEquipment& operator=(const ExteriorWaterEquipment&) = default; | |
| 45 | ✗ | ExteriorWaterEquipment& operator=(ExteriorWaterEquipment&&) = default; | |
| 46 | |||
| 47 | //@} | ||
| 48 | |||
| 49 | static IddObjectType iddObjectType(); | ||
| 50 | |||
| 51 | /** @name Getters */ | ||
| 52 | //@{ | ||
| 53 | |||
| 54 | ExteriorWaterEquipmentDefinition exteriorWaterEquipmentDefinition() const; | ||
| 55 | |||
| 56 | Schedule schedule() const; | ||
| 57 | |||
| 58 | double multiplier() const; | ||
| 59 | |||
| 60 | bool isMultiplierDefaulted() const; | ||
| 61 | |||
| 62 | std::string endUseSubcategory() const; | ||
| 63 | |||
| 64 | bool isEndUseSubcategoryDefaulted() const; | ||
| 65 | |||
| 66 | //@} | ||
| 67 | /** @name Setters */ | ||
| 68 | //@{ | ||
| 69 | |||
| 70 | bool setExteriorWaterEquipmentDefinition(const ExteriorWaterEquipmentDefinition& exteriorWaterEquipmentDefinition); | ||
| 71 | |||
| 72 | bool setSchedule(Schedule& schedule); | ||
| 73 | |||
| 74 | void resetSchedule(); | ||
| 75 | |||
| 76 | bool setMultiplier(double multiplier); | ||
| 77 | |||
| 78 | void resetMultiplier(); | ||
| 79 | |||
| 80 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 81 | |||
| 82 | void resetEndUseSubcategory(); | ||
| 83 | |||
| 84 | //@} | ||
| 85 | /** @name Other */ | ||
| 86 | //@{ | ||
| 87 | |||
| 88 | Facility facility() const; | ||
| 89 | |||
| 90 | //@} | ||
| 91 | protected: | ||
| 92 | /// @cond | ||
| 93 | using ImplType = detail::ExteriorWaterEquipment_Impl; | ||
| 94 | |||
| 95 | explicit ExteriorWaterEquipment(std::shared_ptr<detail::ExteriorWaterEquipment_Impl> impl); | ||
| 96 | |||
| 97 | friend class detail::ExteriorWaterEquipment_Impl; | ||
| 98 | friend class Model; | ||
| 99 | friend class IdfObject; | ||
| 100 | friend class openstudio::detail::IdfObject_Impl; | ||
| 101 | /// @endcond | ||
| 102 | private: | ||
| 103 | − | REGISTER_LOGGER("openstudio.model.ExteriorWaterEquipment"); | |
| 104 | }; | ||
| 105 | |||
| 106 | /** \relates ExteriorWaterEquipment*/ | ||
| 107 | using OptionalExteriorWaterEquipment = boost::optional<ExteriorWaterEquipment>; | ||
| 108 | |||
| 109 | /** \relates ExteriorWaterEquipment*/ | ||
| 110 | using ExteriorWaterEquipmentVector = std::vector<ExteriorWaterEquipment>; | ||
| 111 | |||
| 112 | } // namespace model | ||
| 113 | } // namespace openstudio | ||
| 114 | |||
| 115 | #endif // MODEL_EXTERIORWATEREQUIPMENT_HPP | ||
| 116 |