src/model/WaterUseEquipmentDefinition.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_WATERUSEEQUIPMENTDEFINITION_HPP | ||
| 7 | #define MODEL_WATERUSEEQUIPMENTDEFINITION_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "SpaceLoadDefinition.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | class WaterUseEquipmentDefinition_Impl; | ||
| 21 | |||
| 22 | } // namespace detail | ||
| 23 | |||
| 24 | /** WaterUseEquipmentDefinition is a SpaceLoadDefinition that wraps the OpenStudio IDD object 'OS:WaterUse:Equipment:Definition'. */ | ||
| 25 | class MODEL_API WaterUseEquipmentDefinition : public SpaceLoadDefinition | ||
| 26 | { | ||
| 27 | public: | ||
| 28 | explicit WaterUseEquipmentDefinition(const Model& model); | ||
| 29 | |||
| 30 | 47 | virtual ~WaterUseEquipmentDefinition() override = default; | |
| 31 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 32 | ✗ | WaterUseEquipmentDefinition(const WaterUseEquipmentDefinition& other) = default; | |
| 33 | ✗ | WaterUseEquipmentDefinition(WaterUseEquipmentDefinition&& other) = default; | |
| 34 | ✗ | WaterUseEquipmentDefinition& operator=(const WaterUseEquipmentDefinition&) = default; | |
| 35 | ✗ | WaterUseEquipmentDefinition& operator=(WaterUseEquipmentDefinition&&) = default; | |
| 36 | |||
| 37 | static IddObjectType iddObjectType(); | ||
| 38 | |||
| 39 | std::string endUseSubcategory() const; | ||
| 40 | bool isEndUseSubcategoryDefaulted() const; | ||
| 41 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 42 | void resetEndUseSubcategory(); | ||
| 43 | |||
| 44 | double peakFlowRate() const; | ||
| 45 | bool setPeakFlowRate(double peakFlowRate); | ||
| 46 | boost::optional<Schedule> targetTemperatureSchedule() const; | ||
| 47 | bool setTargetTemperatureSchedule(const Schedule& targetTemperatureSchedule); | ||
| 48 | void resetTargetTemperatureSchedule(); | ||
| 49 | |||
| 50 | boost::optional<Schedule> sensibleFractionSchedule() const; | ||
| 51 | bool setSensibleFractionSchedule(const Schedule& sensibleFractionSchedule); | ||
| 52 | void resetSensibleFractionSchedule(); | ||
| 53 | |||
| 54 | boost::optional<Schedule> latentFractionSchedule() const; | ||
| 55 | bool setLatentFractionSchedule(const Schedule& latentFractionSchedule); | ||
| 56 | void resetLatentFractionSchedule(); | ||
| 57 | |||
| 58 | protected: | ||
| 59 | using ImplType = detail::WaterUseEquipmentDefinition_Impl; | ||
| 60 | |||
| 61 | explicit WaterUseEquipmentDefinition(std::shared_ptr<detail::WaterUseEquipmentDefinition_Impl> impl); | ||
| 62 | |||
| 63 | friend class detail::WaterUseEquipmentDefinition_Impl; | ||
| 64 | friend class Model; | ||
| 65 | friend class IdfObject; | ||
| 66 | friend class openstudio::detail::IdfObject_Impl; | ||
| 67 | |||
| 68 | private: | ||
| 69 | REGISTER_LOGGER("openstudio.model.WaterUseEquipmentDefinition"); | ||
| 70 | }; | ||
| 71 | |||
| 72 | using OptionalWaterUseEquipmentDefinition = boost::optional<WaterUseEquipmentDefinition>; | ||
| 73 | |||
| 74 | using WaterUseEquipmentDefinitionVector = std::vector<WaterUseEquipmentDefinition>; | ||
| 75 | |||
| 76 | } // namespace model | ||
| 77 | } // namespace openstudio | ||
| 78 | |||
| 79 | #endif // MODEL_WATERUSEEQUIPMENTDEFINITION_HPP | ||
| 80 |