src/model/AvailabilityManagerOptimumStart.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_AVAILABILITYMANAGEROPTIMUMSTART_HPP | ||
| 7 | #define MODEL_AVAILABILITYMANAGEROPTIMUMSTART_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 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class AvailabilityManagerOptimumStart_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** AvailabilityManagerOptimumStart is a AvailabilityManager that wraps the OpenStudio IDD object 'OS:AvailabilityManager:OptimumStart'. */ | ||
| 26 | class MODEL_API AvailabilityManagerOptimumStart : public AvailabilityManager | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit AvailabilityManagerOptimumStart(const Model& model); | ||
| 33 | |||
| 34 | 2 | virtual ~AvailabilityManagerOptimumStart() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | ✗ | AvailabilityManagerOptimumStart(const AvailabilityManagerOptimumStart& other) = default; | |
| 37 | ✗ | AvailabilityManagerOptimumStart(AvailabilityManagerOptimumStart&& other) = default; | |
| 38 | ✗ | AvailabilityManagerOptimumStart& operator=(const AvailabilityManagerOptimumStart&) = default; | |
| 39 | ✗ | AvailabilityManagerOptimumStart& operator=(AvailabilityManagerOptimumStart&&) = default; | |
| 40 | |||
| 41 | //@} | ||
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | static std::vector<std::string> controlTypeValues(); | ||
| 46 | |||
| 47 | static std::vector<std::string> controlAlgorithmValues(); | ||
| 48 | |||
| 49 | /** @name Getters */ | ||
| 50 | //@{ | ||
| 51 | |||
| 52 | Schedule applicabilitySchedule() const; | ||
| 53 | |||
| 54 | std::string controlType() const; | ||
| 55 | |||
| 56 | boost::optional<ThermalZone> controlZone() const; | ||
| 57 | |||
| 58 | double maximumValueforOptimumStartTime() const; | ||
| 59 | |||
| 60 | std::string controlAlgorithm() const; | ||
| 61 | |||
| 62 | double constantTemperatureGradientduringCooling() const; | ||
| 63 | |||
| 64 | double constantTemperatureGradientduringHeating() const; | ||
| 65 | |||
| 66 | double initialTemperatureGradientduringCooling() const; | ||
| 67 | |||
| 68 | double initialTemperatureGradientduringHeating() const; | ||
| 69 | |||
| 70 | double constantStartTime() const; | ||
| 71 | |||
| 72 | int numberofPreviousDays() const; | ||
| 73 | |||
| 74 | //@} | ||
| 75 | /** @name Setters */ | ||
| 76 | //@{ | ||
| 77 | |||
| 78 | bool setApplicabilitySchedule(Schedule& schedule); | ||
| 79 | |||
| 80 | bool setControlType(const std::string& controlType); | ||
| 81 | |||
| 82 | bool setControlZone(const ThermalZone& thermalZone); | ||
| 83 | |||
| 84 | void resetControlZone(); | ||
| 85 | |||
| 86 | bool setMaximumValueforOptimumStartTime(double maximumValueforOptimumStartTime); | ||
| 87 | |||
| 88 | bool setControlAlgorithm(const std::string& controlAlgorithm); | ||
| 89 | |||
| 90 | bool setConstantTemperatureGradientduringCooling(double constantTemperatureGradientduringCooling); | ||
| 91 | |||
| 92 | bool setConstantTemperatureGradientduringHeating(double constantTemperatureGradientduringHeating); | ||
| 93 | |||
| 94 | bool setInitialTemperatureGradientduringCooling(double initialTemperatureGradientduringCooling); | ||
| 95 | |||
| 96 | bool setInitialTemperatureGradientduringHeating(double initialTemperatureGradientduringHeating); | ||
| 97 | |||
| 98 | bool setConstantStartTime(double constantStartTime); | ||
| 99 | |||
| 100 | bool setNumberofPreviousDays(int numberofPreviousDays); | ||
| 101 | |||
| 102 | //@} | ||
| 103 | /** @name Other */ | ||
| 104 | //@{ | ||
| 105 | |||
| 106 | //@} | ||
| 107 | protected: | ||
| 108 | /// @cond | ||
| 109 | using ImplType = detail::AvailabilityManagerOptimumStart_Impl; | ||
| 110 | |||
| 111 | explicit AvailabilityManagerOptimumStart(std::shared_ptr<detail::AvailabilityManagerOptimumStart_Impl> impl); | ||
| 112 | |||
| 113 | friend class detail::AvailabilityManagerOptimumStart_Impl; | ||
| 114 | friend class Model; | ||
| 115 | friend class IdfObject; | ||
| 116 | friend class openstudio::detail::IdfObject_Impl; | ||
| 117 | /// @endcond | ||
| 118 | private: | ||
| 119 | REGISTER_LOGGER("openstudio.model.AvailabilityManagerOptimumStart"); | ||
| 120 | }; | ||
| 121 | |||
| 122 | /** \relates AvailabilityManagerOptimumStart*/ | ||
| 123 | using OptionalAvailabilityManagerOptimumStart = boost::optional<AvailabilityManagerOptimumStart>; | ||
| 124 | |||
| 125 | /** \relates AvailabilityManagerOptimumStart*/ | ||
| 126 | using AvailabilityManagerOptimumStartVector = std::vector<AvailabilityManagerOptimumStart>; | ||
| 127 | |||
| 128 | } // namespace model | ||
| 129 | } // namespace openstudio | ||
| 130 | |||
| 131 | #endif // MODEL_AVAILABILITYMANAGEROPTIMUMSTART_HPP | ||
| 132 |