src/model/ScheduleFixedInterval_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_SCHEDULEFIXEDINTERVAL_IMPL_HPP | ||
| 7 | #define MODEL_SCHEDULEFIXEDINTERVAL_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ScheduleInterval_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | namespace detail { | ||
| 16 | |||
| 17 | /** ScheduleFixedInterval_Impl is a ScheduleInterval_Impl that is the implementation class for ScheduleFixedInterval.*/ | ||
| 18 | class MODEL_API ScheduleFixedInterval_Impl : public ScheduleInterval_Impl | ||
| 19 | { | ||
| 20 | |||
| 21 | public: | ||
| 22 | /** @name Constructors and Destructors */ | ||
| 23 | //@{ | ||
| 24 | |||
| 25 | ScheduleFixedInterval_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 26 | |||
| 27 | ScheduleFixedInterval_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | ScheduleFixedInterval_Impl(const ScheduleFixedInterval_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | 21 | virtual ~ScheduleFixedInterval_Impl() override = default; | |
| 32 | |||
| 33 | //@} | ||
| 34 | /** @name Virtual Methods */ | ||
| 35 | //@{ | ||
| 36 | |||
| 37 | virtual IddObjectType iddObjectType() const override; | ||
| 38 | |||
| 39 | virtual boost::optional<ScheduleTypeLimits> scheduleTypeLimits() const override; | ||
| 40 | |||
| 41 | virtual bool setScheduleTypeLimits(const ScheduleTypeLimits& scheduleTypeLimits) override; | ||
| 42 | |||
| 43 | virtual bool resetScheduleTypeLimits() override; | ||
| 44 | |||
| 45 | virtual openstudio::TimeSeries timeSeries() const override; | ||
| 46 | |||
| 47 | virtual bool setTimeSeries(const openstudio::TimeSeries& timeSeries) override; | ||
| 48 | |||
| 49 | //@} | ||
| 50 | /** @name Getters */ | ||
| 51 | //@{ | ||
| 52 | |||
| 53 | bool interpolatetoTimestep() const; | ||
| 54 | |||
| 55 | bool isInterpolatetoTimestepDefaulted() const; | ||
| 56 | |||
| 57 | bool translatetoScheduleFile() const; | ||
| 58 | |||
| 59 | bool isTranslatetoScheduleFileDefaulted() const; | ||
| 60 | |||
| 61 | int intervalLength() const; | ||
| 62 | |||
| 63 | double outOfRangeValue() const; | ||
| 64 | |||
| 65 | bool isOutOfRangeValueDefaulted() const; | ||
| 66 | |||
| 67 | int startMonth() const; | ||
| 68 | |||
| 69 | int startDay() const; | ||
| 70 | |||
| 71 | //@} | ||
| 72 | /** @name Setters */ | ||
| 73 | //@{ | ||
| 74 | |||
| 75 | bool setInterpolatetoTimestep(bool interpolatetoTimestep, bool driverMethod = true); | ||
| 76 | |||
| 77 | void resetInterpolatetoTimestep(bool driverMethod = true); | ||
| 78 | |||
| 79 | bool setTranslatetoScheduleFile(bool translatetoScheduleFile, bool driverMethod = true); | ||
| 80 | |||
| 81 | void resetTranslatetoScheduleFile(bool driverMethod = true); | ||
| 82 | |||
| 83 | bool setIntervalLength(int intervalLength, bool driverMethod = true); | ||
| 84 | |||
| 85 | bool setOutOfRangeValue(double outOfRangeValue, bool driverMethod = true); | ||
| 86 | |||
| 87 | void resetOutOfRangeValue(bool driverMethod = true); | ||
| 88 | |||
| 89 | bool setStartMonth(int startMonth, bool driverMethod = true); | ||
| 90 | |||
| 91 | bool setStartDay(int startDay, bool driverMethod = true); | ||
| 92 | |||
| 93 | // ensure that this object does not contain the date 2/29 | ||
| 94 | virtual void ensureNoLeapDays() override; | ||
| 95 | |||
| 96 | //@} | ||
| 97 | protected: | ||
| 98 | private: | ||
| 99 | − | REGISTER_LOGGER("openstudio.model.ScheduleFixedInterval"); | |
| 100 | }; | ||
| 101 | |||
| 102 | } // namespace detail | ||
| 103 | |||
| 104 | } // namespace model | ||
| 105 | } // namespace openstudio | ||
| 106 | |||
| 107 | #endif // MODEL_SCHEDULEFIXEDINTERVAL_IMPL_HPP | ||
| 108 |