src/model/ConvergenceLimits_Impl.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_IMPL_HPP | ||
| 7 | #define MODEL_CONVERGENCELIMITS_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelObject_Impl.hpp" | ||
| 10 | |||
| 11 | namespace openstudio { | ||
| 12 | namespace model { | ||
| 13 | |||
| 14 | namespace detail { | ||
| 15 | |||
| 16 | /** ConvergenceLimits_Impl is a ModelObject_Impl that is the implementation class for ConvergenceLimits.*/ | ||
| 17 | class MODEL_API ConvergenceLimits_Impl : public ModelObject_Impl | ||
| 18 | { | ||
| 19 | |||
| 20 | public: | ||
| 21 | /** @name Constructors and Destructors */ | ||
| 22 | //@{ | ||
| 23 | |||
| 24 | ConvergenceLimits_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 25 | |||
| 26 | ConvergenceLimits_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 27 | |||
| 28 | ConvergenceLimits_Impl(const ConvergenceLimits_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | 372 | virtual ~ConvergenceLimits_Impl() override = default; | |
| 31 | |||
| 32 | //@} | ||
| 33 | /** @name Virtual Methods */ | ||
| 34 | //@{ | ||
| 35 | |||
| 36 | // return the parent object in the hierarchy | ||
| 37 | virtual boost::optional<ParentObject> parent() const override; | ||
| 38 | |||
| 39 | // set the parent, child may have to call methods on the parent | ||
| 40 | virtual bool setParent(ParentObject& newParent) override; | ||
| 41 | |||
| 42 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 43 | |||
| 44 | virtual IddObjectType iddObjectType() const override; | ||
| 45 | |||
| 46 | //@} | ||
| 47 | /** @name Getters */ | ||
| 48 | //@{ | ||
| 49 | |||
| 50 | boost::optional<int> minimumSystemTimestep() const; | ||
| 51 | |||
| 52 | int maximumHVACIterations() const; | ||
| 53 | |||
| 54 | bool isMaximumHVACIterationsDefaulted() const; | ||
| 55 | |||
| 56 | int minimumPlantIterations() const; | ||
| 57 | |||
| 58 | bool isMinimumPlantIterationsDefaulted() const; | ||
| 59 | |||
| 60 | int maximumPlantIterations() const; | ||
| 61 | |||
| 62 | bool isMaximumPlantIterationsDefaulted() const; | ||
| 63 | |||
| 64 | //@} | ||
| 65 | /** @name Setters */ | ||
| 66 | //@{ | ||
| 67 | |||
| 68 | bool setMinimumSystemTimestep(boost::optional<int> minimumSystemTimestep); | ||
| 69 | |||
| 70 | void resetMinimumSystemTimestep(); | ||
| 71 | |||
| 72 | bool setMaximumHVACIterations(int maximumHVACIterations); | ||
| 73 | |||
| 74 | void resetMaximumHVACIterations(); | ||
| 75 | |||
| 76 | bool setMinimumPlantIterations(int minimumPlantIterations); | ||
| 77 | |||
| 78 | void resetMinimumPlantIterations(); | ||
| 79 | |||
| 80 | bool setMaximumPlantIterations(int maximumPlantIterations); | ||
| 81 | |||
| 82 | void resetMaximumPlantIterations(); | ||
| 83 | |||
| 84 | //@} | ||
| 85 | /** @name Other */ | ||
| 86 | //@{ | ||
| 87 | |||
| 88 | //@} | ||
| 89 | protected: | ||
| 90 | private: | ||
| 91 | REGISTER_LOGGER("openstudio.model.ConvergenceLimits"); | ||
| 92 | }; | ||
| 93 | |||
| 94 | } // namespace detail | ||
| 95 | |||
| 96 | } // namespace model | ||
| 97 | } // namespace openstudio | ||
| 98 | |||
| 99 | #endif // MODEL_CONVERGENCELIMITS_IMPL_HPP | ||
| 100 |