src/model/ElectricEquipmentITEAirCooled.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_ELECTRICEQUIPMENTITEAIRCOOLED_HPP | ||
| 7 | #define MODEL_ELECTRICEQUIPMENTITEAIRCOOLED_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "SpaceLoadInstance.hpp" | ||
| 11 | |||
| 12 | #include "../utilities/core/Deprecated.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class ElectricEquipmentITEAirCooledDefinition; | ||
| 19 | class Curve; | ||
| 20 | class Schedule; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | class ElectricEquipmentITEAirCooled_Impl; | ||
| 25 | |||
| 26 | } // namespace detail | ||
| 27 | |||
| 28 | /** ElectricEquipmentITEAirCooled is a SpaceLoadInstance that wraps the OpenStudio IDD object 'OS:ElectricEquipment:ITE:AirCooled'. */ | ||
| 29 | /* Its fields are derived from the EnergyPlus IDD object 'ElectricEquipmentITEAirCooled'. \sa ElectricEquipmentITEAirCooledDefinition */ | ||
| 30 | class MODEL_API ElectricEquipmentITEAirCooled : public SpaceLoadInstance | ||
| 31 | { | ||
| 32 | public: | ||
| 33 | /** @name Constructors and Destructors */ | ||
| 34 | //@{ | ||
| 35 | |||
| 36 | explicit ElectricEquipmentITEAirCooled(const ElectricEquipmentITEAirCooledDefinition& electricEquipmentITEAirCooledDefinition); | ||
| 37 | |||
| 38 | 582 | virtual ~ElectricEquipmentITEAirCooled() override = default; | |
| 39 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 40 | ✗ | ElectricEquipmentITEAirCooled(const ElectricEquipmentITEAirCooled& other) = default; | |
| 41 | 262 | ElectricEquipmentITEAirCooled(ElectricEquipmentITEAirCooled&& other) = default; | |
| 42 | ✗ | ElectricEquipmentITEAirCooled& operator=(const ElectricEquipmentITEAirCooled&) = default; | |
| 43 | 3 | ElectricEquipmentITEAirCooled& operator=(ElectricEquipmentITEAirCooled&&) = default; | |
| 44 | |||
| 45 | //@} | ||
| 46 | |||
| 47 | static IddObjectType iddObjectType(); | ||
| 48 | |||
| 49 | /** @name Getters */ | ||
| 50 | //@{ | ||
| 51 | |||
| 52 | ElectricEquipmentITEAirCooledDefinition electricEquipmentITEAirCooledDefinition() const; | ||
| 53 | |||
| 54 | // Return the Design Power Input Schedule. If not specified, default to always 1. | ||
| 55 | boost::optional<Schedule> designPowerInputSchedule() const; | ||
| 56 | |||
| 57 | bool isDesignPowerInputScheduleDefaulted() const; | ||
| 58 | |||
| 59 | // Return the CPU Loading Schedule. If not specified, default to always 1. | ||
| 60 | boost::optional<Schedule> cPULoadingSchedule() const; | ||
| 61 | |||
| 62 | bool isCPULoadingScheduleDefaulted() const; | ||
| 63 | |||
| 64 | std::string cPUEndUseSubcategory() const; | ||
| 65 | |||
| 66 | bool isCPUEndUseSubcategoryDefaulted() const; | ||
| 67 | |||
| 68 | std::string fanEndUseSubcategory() const; | ||
| 69 | |||
| 70 | bool isFanEndUseSubcategoryDefaulted() const; | ||
| 71 | |||
| 72 | std::string electricPowerSupplyEndUseSubcategory() const; | ||
| 73 | |||
| 74 | bool isElectricPowerSupplyEndUseSubcategoryDefaulted() const; | ||
| 75 | |||
| 76 | //@} | ||
| 77 | /** @name Setters */ | ||
| 78 | //@{ | ||
| 79 | |||
| 80 | bool setElectricEquipmentITEAirCooledDefinition(const ElectricEquipmentITEAirCooledDefinition& electricEquipmentITEAirCooledDefinition); | ||
| 81 | |||
| 82 | // Note Schedules are passed by reference, not const reference. | ||
| 83 | bool setDesignPowerInputSchedule(Schedule& schedule); | ||
| 84 | |||
| 85 | void resetDesignPowerInputSchedule(); | ||
| 86 | |||
| 87 | // Note Schedules are passed by reference, not const reference. | ||
| 88 | bool setCPULoadingSchedule(Schedule& schedule); | ||
| 89 | |||
| 90 | void resetCPULoadingSchedule(); | ||
| 91 | |||
| 92 | bool setMultiplier(double multiplier); | ||
| 93 | |||
| 94 | void resetMultiplier(); | ||
| 95 | |||
| 96 | bool setCPUEndUseSubcategory(const std::string& cPUEndUseSubcategory); | ||
| 97 | |||
| 98 | void resetCPUEndUseSubcategory(); | ||
| 99 | |||
| 100 | bool setFanEndUseSubcategory(const std::string& fanEndUseSubcategory); | ||
| 101 | |||
| 102 | void resetFanEndUseSubcategory(); | ||
| 103 | |||
| 104 | bool setElectricPowerSupplyEndUseSubcategory(const std::string& electricPowerSupplyEndUseSubcategory); | ||
| 105 | |||
| 106 | void resetElectricPowerSupplyEndUseSubcategory(); | ||
| 107 | |||
| 108 | //@} | ||
| 109 | /** @name Other */ | ||
| 110 | //@{ | ||
| 111 | |||
| 112 | /** Returns the designLevel if possible based on the underlying data of electricEquipmentITEAirCooledDefinition(). */ | ||
| 113 | boost::optional<double> designLevel() const; | ||
| 114 | OS_DEPRECATED(3, 8, 0) boost::optional<double> wattsperUnit() const; | ||
| 115 | |||
| 116 | /** Returns the powerPerFloorArea (Design Level) if possible based on the underlying data of electricEquipmentITEAirCooledDefinition(). */ | ||
| 117 | boost::optional<double> powerPerFloorArea() const; | ||
| 118 | OS_DEPRECATED(3, 8, 0) boost::optional<double> wattsperZoneFloorArea() const; | ||
| 119 | |||
| 120 | /** Returns the design level represented by this instance, assuming floorArea (m^2). */ | ||
| 121 | double getDesignLevel(double floorArea) const; | ||
| 122 | OS_DEPRECATED(3, 8, 0) double getWattsperUnit(double floorArea) const; | ||
| 123 | |||
| 124 | /** Returns the watts/m^2 represented by this definition, assuming floorArea (m^2). */ | ||
| 125 | double getPowerPerFloorArea(double floorArea) const; | ||
| 126 | OS_DEPRECATED(3, 8, 0) double getWattsperZoneFloorArea(double floorArea) const; | ||
| 127 | |||
| 128 | //@} | ||
| 129 | protected: | ||
| 130 | /// @cond | ||
| 131 | using ImplType = detail::ElectricEquipmentITEAirCooled_Impl; | ||
| 132 | |||
| 133 | friend class Model; | ||
| 134 | friend class openstudio::IdfObject; | ||
| 135 | |||
| 136 | explicit ElectricEquipmentITEAirCooled(std::shared_ptr<detail::ElectricEquipmentITEAirCooled_Impl> impl); | ||
| 137 | |||
| 138 | /// @endcond | ||
| 139 | private: | ||
| 140 | − | REGISTER_LOGGER("openstudio.model.ElectricEquipmentITEAirCooled"); | |
| 141 | }; | ||
| 142 | |||
| 143 | /** \relates ElectricEquipmentITEAirCooled*/ | ||
| 144 | using OptionalElectricEquipmentITEAirCooled = boost::optional<ElectricEquipmentITEAirCooled>; | ||
| 145 | |||
| 146 | /** \relates ElectricEquipmentITEAirCooled*/ | ||
| 147 | using ElectricEquipmentITEAirCooledVector = std::vector<ElectricEquipmentITEAirCooled>; | ||
| 148 | |||
| 149 | } // namespace model | ||
| 150 | } // namespace openstudio | ||
| 151 | |||
| 152 | #endif // MODEL_ELECTRICEQUIPMENTITEAIRCOOLED_HPP | ||
| 153 |