src/model/LightingDesignDay.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_LIGHTINGDESIGNDAY_HPP | ||
| 7 | #define MODEL_LIGHTINGDESIGNDAY_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | class DateTime; | ||
| 15 | class Date; | ||
| 16 | class Time; | ||
| 17 | |||
| 18 | namespace model { | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class LightingDesignDay_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** LightingDesignDay is a ModelObject that wraps the OpenStudio IDD object 'OS_LightingDesignDay'. */ | ||
| 27 | class MODEL_API LightingDesignDay : public ModelObject | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | LightingDesignDay(const std::string& cieSkyModel, const openstudio::Date& date, const Model& model); | ||
| 34 | |||
| 35 | 1 | virtual ~LightingDesignDay() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | ✗ | LightingDesignDay(const LightingDesignDay& other) = default; | |
| 38 | ✗ | LightingDesignDay(LightingDesignDay&& other) = default; | |
| 39 | ✗ | LightingDesignDay& operator=(const LightingDesignDay&) = default; | |
| 40 | ✗ | LightingDesignDay& operator=(LightingDesignDay&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | /** @name Static Methods */ | ||
| 44 | //@{ | ||
| 45 | |||
| 46 | static IddObjectType iddObjectType(); | ||
| 47 | |||
| 48 | static std::vector<std::string> validCIESkyModelValues(); | ||
| 49 | |||
| 50 | //@} | ||
| 51 | /** @name Getters */ | ||
| 52 | //@{ | ||
| 53 | |||
| 54 | std::string cieSkyModel() const; | ||
| 55 | |||
| 56 | int snowIndicator() const; | ||
| 57 | |||
| 58 | bool isSnowIndicatorDefaulted() const; | ||
| 59 | |||
| 60 | //@} | ||
| 61 | /** @name Setters */ | ||
| 62 | //@{ | ||
| 63 | |||
| 64 | bool setCIESkyModel(const std::string& cIESkyModel); | ||
| 65 | |||
| 66 | bool setSnowIndicator(int snowIndicator); | ||
| 67 | |||
| 68 | void resetSnowIndicator(); | ||
| 69 | |||
| 70 | //@} | ||
| 71 | |||
| 72 | openstudio::Date date() const; | ||
| 73 | |||
| 74 | bool setDate(const openstudio::Date& date); | ||
| 75 | |||
| 76 | std::vector<openstudio::Time> simulationTimes() const; | ||
| 77 | |||
| 78 | std::vector<openstudio::DateTime> simulationDateTimes() const; | ||
| 79 | |||
| 80 | bool addSimulationTime(const openstudio::Time& time); | ||
| 81 | |||
| 82 | void clearSimulationTimes(); | ||
| 83 | |||
| 84 | // ensure that this object does not contain the date 2/29 | ||
| 85 | void ensureNoLeapDays(); | ||
| 86 | |||
| 87 | protected: | ||
| 88 | /// @cond | ||
| 89 | using ImplType = detail::LightingDesignDay_Impl; | ||
| 90 | |||
| 91 | friend class detail::LightingDesignDay_Impl; | ||
| 92 | friend class Model; | ||
| 93 | friend class IdfObject; | ||
| 94 | |||
| 95 | explicit LightingDesignDay(std::shared_ptr<detail::LightingDesignDay_Impl> impl); | ||
| 96 | |||
| 97 | /// @endcond | ||
| 98 | private: | ||
| 99 | REGISTER_LOGGER("openstudio.model.LightingDesignDay"); | ||
| 100 | }; | ||
| 101 | |||
| 102 | /** \relates LightingDesignDay*/ | ||
| 103 | using OptionalLightingDesignDay = boost::optional<LightingDesignDay>; | ||
| 104 | |||
| 105 | /** \relates LightingDesignDay*/ | ||
| 106 | using LightingDesignDayVector = std::vector<LightingDesignDay>; | ||
| 107 | |||
| 108 | } // namespace model | ||
| 109 | } // namespace openstudio | ||
| 110 | |||
| 111 | #endif // MODEL_LIGHTINGDESIGNDAY_HPP | ||
| 112 |