src/model/AvailabilityManagerNightCycle.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_AVAILABILITYMANAGERNIGHTCYCLE_HPP | ||
| 7 | #define MODEL_AVAILABILITYMANAGERNIGHTCYCLE_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "AvailabilityManager.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class ThermalZone; | ||
| 18 | class AirLoopHVAC; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class AvailabilityManagerNightCycle_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** AvailabilityManagerNightCycle is a ModelObject that wraps the OpenStudio IDD object 'OS:AvailabilityManager:NightCycle'. */ | ||
| 27 | class MODEL_API AvailabilityManagerNightCycle : public AvailabilityManager | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | explicit AvailabilityManagerNightCycle(const Model& model); | ||
| 31 | |||
| 32 | 58 | virtual ~AvailabilityManagerNightCycle() override = default; | |
| 33 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 34 | 10 | AvailabilityManagerNightCycle(const AvailabilityManagerNightCycle& other) = default; | |
| 35 | 11 | AvailabilityManagerNightCycle(AvailabilityManagerNightCycle&& other) = default; | |
| 36 | ✗ | AvailabilityManagerNightCycle& operator=(const AvailabilityManagerNightCycle&) = default; | |
| 37 | ✗ | AvailabilityManagerNightCycle& operator=(AvailabilityManagerNightCycle&&) = default; | |
| 38 | |||
| 39 | static IddObjectType iddObjectType(); | ||
| 40 | |||
| 41 | static std::vector<std::string> controlTypeValues(); | ||
| 42 | |||
| 43 | boost::optional<AirLoopHVAC> airLoopHVAC() const; | ||
| 44 | |||
| 45 | Schedule applicabilitySchedule() const; | ||
| 46 | bool setApplicabilitySchedule(Schedule& schedule); | ||
| 47 | |||
| 48 | /** Helper getter which will fetch the AirLoopHVAC::AvailabilitySchedule */ | ||
| 49 | boost::optional<Schedule> fanSchedule() const; | ||
| 50 | |||
| 51 | std::string controlType() const; | ||
| 52 | bool setControlType(const std::string& controlType); | ||
| 53 | void resetControlType(); | ||
| 54 | bool isControlTypeDefaulted() const; | ||
| 55 | |||
| 56 | double thermostatTolerance() const; | ||
| 57 | bool setThermostatTolerance(double thermostatTolerance); | ||
| 58 | bool isThermostatToleranceDefaulted() const; | ||
| 59 | void resetThermostatTolerance(); | ||
| 60 | |||
| 61 | double cyclingRunTime() const; | ||
| 62 | bool setCyclingRunTime(double cyclingRunTime); | ||
| 63 | void resetCyclingRunTime(); | ||
| 64 | bool isCyclingRunTimeDefaulted() const; | ||
| 65 | |||
| 66 | static std::vector<std::string> cyclingRunTimeControlTypeValues(); | ||
| 67 | std::string cyclingRunTimeControlType() const; | ||
| 68 | bool isCyclingRunTimeControlTypeDefaulted() const; | ||
| 69 | bool setCyclingRunTimeControlType(const std::string& cyclingRunTimeControlType); | ||
| 70 | void resetCyclingRunTimeControlType(); | ||
| 71 | |||
| 72 | std::vector<ThermalZone> controlThermalZones() const; | ||
| 73 | bool setControlThermalZones(const std::vector<ThermalZone>& thermalZones); | ||
| 74 | void resetControlThermalZones(); | ||
| 75 | |||
| 76 | std::vector<ThermalZone> coolingControlThermalZones() const; | ||
| 77 | bool setCoolingControlThermalZones(const std::vector<ThermalZone>& thermalZones); | ||
| 78 | void resetCoolingControlThermalZones(); | ||
| 79 | |||
| 80 | std::vector<ThermalZone> heatingControlThermalZones() const; | ||
| 81 | bool setHeatingControlThermalZones(const std::vector<ThermalZone>& thermalZones); | ||
| 82 | void resetHeatingControlThermalZones(); | ||
| 83 | |||
| 84 | std::vector<ThermalZone> heatingZoneFansOnlyThermalZones() const; | ||
| 85 | bool setHeatingZoneFansOnlyThermalZones(const std::vector<ThermalZone>& thermalZones); | ||
| 86 | void resetHeatingZoneFansOnlyThermalZones(); | ||
| 87 | |||
| 88 | protected: | ||
| 89 | /// @cond | ||
| 90 | using ImplType = detail::AvailabilityManagerNightCycle_Impl; | ||
| 91 | |||
| 92 | explicit AvailabilityManagerNightCycle(std::shared_ptr<detail::AvailabilityManagerNightCycle_Impl> impl); | ||
| 93 | |||
| 94 | friend class detail::AvailabilityManagerNightCycle_Impl; | ||
| 95 | friend class Model; | ||
| 96 | friend class IdfObject; | ||
| 97 | friend class openstudio::detail::IdfObject_Impl; | ||
| 98 | |||
| 99 | /// @endcond | ||
| 100 | |||
| 101 | private: | ||
| 102 | REGISTER_LOGGER("openstudio.model.AvailabilityManagerNightCycle"); | ||
| 103 | }; | ||
| 104 | |||
| 105 | /** \relates AvailabilityManagerNightCycle*/ | ||
| 106 | using OptionalAvailabilityManagerNightCycle = boost::optional<AvailabilityManagerNightCycle>; | ||
| 107 | |||
| 108 | /** \relates AvailabilityManagerNightCycle*/ | ||
| 109 | using AvailabilityManagerNightCycleVector = std::vector<AvailabilityManagerNightCycle>; | ||
| 110 | |||
| 111 | } // namespace model | ||
| 112 | } // namespace openstudio | ||
| 113 | |||
| 114 | #endif // MODEL_AVAILABILITYMANAGERNIGHTCYCLE_HPP | ||
| 115 |