src/model/ConstructionAirBoundary_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_CONSTRUCTIONAIRBOUNDARY_IMPL_HPP | ||
| 7 | #define MODEL_CONSTRUCTIONAIRBOUNDARY_IMPL_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "ConstructionBase_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | // TODO: Check the following class names against object getters and setters. | ||
| 16 | class Schedule; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | /** ConstructionAirBoundary_Impl is a ConstructionBase_Impl that is the implementation class for ConstructionAirBoundary.*/ | ||
| 21 | class MODEL_API ConstructionAirBoundary_Impl : public ConstructionBase_Impl | ||
| 22 | { | ||
| 23 | public: | ||
| 24 | /** @name Constructors and Destructors */ | ||
| 25 | //@{ | ||
| 26 | |||
| 27 | ConstructionAirBoundary_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | ConstructionAirBoundary_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | ConstructionAirBoundary_Impl(const ConstructionAirBoundary_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | 447 | virtual ~ConstructionAirBoundary_Impl() override = default; | |
| 34 | |||
| 35 | //@} | ||
| 36 | /** @name Virtual Methods */ | ||
| 37 | //@{ | ||
| 38 | |||
| 39 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 40 | |||
| 41 | virtual IddObjectType iddObjectType() const override; | ||
| 42 | |||
| 43 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 44 | |||
| 45 | virtual bool isOpaque() const override; | ||
| 46 | |||
| 47 | virtual bool isFenestration() const override; | ||
| 48 | |||
| 49 | virtual bool isSolarDiffusing() const override; | ||
| 50 | |||
| 51 | virtual bool isModelPartition() const override; | ||
| 52 | |||
| 53 | virtual int renderingColorIndex() const override; | ||
| 54 | |||
| 55 | //@} | ||
| 56 | /** @name Getters */ | ||
| 57 | //@{ | ||
| 58 | |||
| 59 | std::string airExchangeMethod() const; | ||
| 60 | |||
| 61 | bool isAirExchangeMethodDefaulted() const; | ||
| 62 | |||
| 63 | double simpleMixingAirChangesPerHour() const; | ||
| 64 | |||
| 65 | bool isSimpleMixingAirChangesPerHourDefaulted() const; | ||
| 66 | |||
| 67 | // TODO: Check return type. From object lists, some candidates are: Schedule. | ||
| 68 | boost::optional<Schedule> simpleMixingSchedule() const; | ||
| 69 | |||
| 70 | //@} | ||
| 71 | /** @name Setters */ | ||
| 72 | //@{ | ||
| 73 | |||
| 74 | bool setAirExchangeMethod(const std::string& airExchangeMethod); | ||
| 75 | |||
| 76 | void resetAirExchangeMethod(); | ||
| 77 | |||
| 78 | bool setSimpleMixingAirChangesPerHour(double simpleMixingAirChangesPerHour); | ||
| 79 | |||
| 80 | void resetSimpleMixingAirChangesPerHour(); | ||
| 81 | |||
| 82 | // TODO: Check argument type. From object lists, some candidates are: Schedule. | ||
| 83 | // Note Schedules are passed by reference, not const reference. | ||
| 84 | bool setSimpleMixingSchedule(Schedule& schedule); | ||
| 85 | |||
| 86 | void resetSimpleMixingSchedule(); | ||
| 87 | |||
| 88 | //@} | ||
| 89 | /** @name Other */ | ||
| 90 | //@{ | ||
| 91 | |||
| 92 | //@} | ||
| 93 | protected: | ||
| 94 | private: | ||
| 95 | REGISTER_LOGGER("openstudio.model.ConstructionAirBoundary"); | ||
| 96 | }; | ||
| 97 | |||
| 98 | } // namespace detail | ||
| 99 | |||
| 100 | } // namespace model | ||
| 101 | } // namespace openstudio | ||
| 102 | |||
| 103 | #endif // MODEL_CONSTRUCTIONAIRBOUNDARY_IMPL_HPP | ||
| 104 |