src/model/ConvergenceLimits.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_CONVERGENCELIMITS_HPP | ||
| 7 | #define MODEL_CONVERGENCELIMITS_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | namespace detail { | ||
| 16 | |||
| 17 | class ConvergenceLimits_Impl; | ||
| 18 | |||
| 19 | } // namespace detail | ||
| 20 | |||
| 21 | /** ConvergenceLimits is a ModelObject that wraps the OpenStudio IDD object 'OS:ConvergenceLimits'. */ | ||
| 22 | class MODEL_API ConvergenceLimits : public ModelObject | ||
| 23 | { | ||
| 24 | public: | ||
| 25 | /** @name Constructors and Destructors */ | ||
| 26 | //@{ | ||
| 27 | |||
| 28 | 366 | virtual ~ConvergenceLimits() override = default; | |
| 29 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 30 | ✗ | ConvergenceLimits(const ConvergenceLimits& other) = default; | |
| 31 | 72 | ConvergenceLimits(ConvergenceLimits&& other) = default; | |
| 32 | ✗ | ConvergenceLimits& operator=(const ConvergenceLimits&) = default; | |
| 33 | ✗ | ConvergenceLimits& operator=(ConvergenceLimits&&) = default; | |
| 34 | |||
| 35 | //@} | ||
| 36 | |||
| 37 | static IddObjectType iddObjectType(); | ||
| 38 | |||
| 39 | /** @name Getters */ | ||
| 40 | //@{ | ||
| 41 | |||
| 42 | boost::optional<int> minimumSystemTimestep() const; | ||
| 43 | |||
| 44 | int maximumHVACIterations() const; | ||
| 45 | |||
| 46 | bool isMaximumHVACIterationsDefaulted() const; | ||
| 47 | |||
| 48 | int minimumPlantIterations() const; | ||
| 49 | |||
| 50 | bool isMinimumPlantIterationsDefaulted() const; | ||
| 51 | |||
| 52 | int maximumPlantIterations() const; | ||
| 53 | |||
| 54 | bool isMaximumPlantIterationsDefaulted() const; | ||
| 55 | |||
| 56 | //@} | ||
| 57 | /** @name Setters */ | ||
| 58 | //@{ | ||
| 59 | |||
| 60 | bool setMinimumSystemTimestep(int minimumSystemTimestep); | ||
| 61 | |||
| 62 | void resetMinimumSystemTimestep(); | ||
| 63 | |||
| 64 | bool setMaximumHVACIterations(int maximumHVACIterations); | ||
| 65 | |||
| 66 | void resetMaximumHVACIterations(); | ||
| 67 | |||
| 68 | bool setMinimumPlantIterations(int minimumPlantIterations); | ||
| 69 | |||
| 70 | void resetMinimumPlantIterations(); | ||
| 71 | |||
| 72 | bool setMaximumPlantIterations(int maximumPlantIterations); | ||
| 73 | |||
| 74 | void resetMaximumPlantIterations(); | ||
| 75 | |||
| 76 | //@} | ||
| 77 | /** @name Other */ | ||
| 78 | //@{ | ||
| 79 | |||
| 80 | //@} | ||
| 81 | protected: | ||
| 82 | /// @cond | ||
| 83 | using ImplType = detail::ConvergenceLimits_Impl; | ||
| 84 | |||
| 85 | explicit ConvergenceLimits(std::shared_ptr<detail::ConvergenceLimits_Impl> impl); | ||
| 86 | |||
| 87 | friend class detail::ConvergenceLimits_Impl; | ||
| 88 | friend class Model; | ||
| 89 | friend class IdfObject; | ||
| 90 | friend class openstudio::detail::IdfObject_Impl; | ||
| 91 | |||
| 92 | explicit ConvergenceLimits(Model& model); | ||
| 93 | |||
| 94 | /// @endcond | ||
| 95 | private: | ||
| 96 | REGISTER_LOGGER("openstudio.model.ConvergenceLimits"); | ||
| 97 | }; | ||
| 98 | |||
| 99 | /** \relates ConvergenceLimits */ | ||
| 100 | using OptionalConvergenceLimits = boost::optional<ConvergenceLimits>; | ||
| 101 | |||
| 102 | /** \relates ConvergenceLimits*/ | ||
| 103 | using ConvergenceLimitsVector = std::vector<ConvergenceLimits>; | ||
| 104 | |||
| 105 | } // namespace model | ||
| 106 | } // namespace openstudio | ||
| 107 | |||
| 108 | #endif // MODEL_CONVERGENCELIMITS_HPP | ||
| 109 |