src/model/ZoneAirContaminantBalance_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_ZONEAIRCONTAMINANTBALANCE_IMPL_HPP | ||
| 7 | #define MODEL_ZONEAIRCONTAMINANTBALANCE_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Schedule; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | /** ZoneAirContaminantBalance_Impl is a ModelObject_Impl that is the implementation class for ZoneAirContaminantBalance.*/ | ||
| 20 | class MODEL_API ZoneAirContaminantBalance_Impl : public ModelObject_Impl | ||
| 21 | { | ||
| 22 | |||
| 23 | public: | ||
| 24 | /** @name Constructors and Destructors */ | ||
| 25 | //@{ | ||
| 26 | |||
| 27 | // constructor | ||
| 28 | ZoneAirContaminantBalance_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | // construct from workspace | ||
| 31 | ZoneAirContaminantBalance_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | // clone copy constructor | ||
| 34 | ZoneAirContaminantBalance_Impl(const ZoneAirContaminantBalance_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 35 | |||
| 36 | // virtual destructor | ||
| 37 | 78 | virtual ~ZoneAirContaminantBalance_Impl() override = default; | |
| 38 | |||
| 39 | // return the parent object in the hierarchy | ||
| 40 | virtual boost::optional<ParentObject> parent() const override; | ||
| 41 | |||
| 42 | // set the parent, child may have to call methods on the parent | ||
| 43 | virtual bool setParent(ParentObject& newParent) override; | ||
| 44 | |||
| 45 | //@} | ||
| 46 | |||
| 47 | /** @name Virtual Methods */ | ||
| 48 | //@{ | ||
| 49 | |||
| 50 | // Get all output variable names that could be associated with this object. | ||
| 51 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 52 | |||
| 53 | virtual IddObjectType iddObjectType() const override; | ||
| 54 | |||
| 55 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 56 | |||
| 57 | //@} | ||
| 58 | /** @name Getters */ | ||
| 59 | //@{ | ||
| 60 | |||
| 61 | bool carbonDioxideConcentration() const; | ||
| 62 | |||
| 63 | bool isCarbonDioxideConcentrationDefaulted() const; | ||
| 64 | |||
| 65 | boost::optional<Schedule> outdoorCarbonDioxideSchedule() const; | ||
| 66 | |||
| 67 | //@} | ||
| 68 | /** @name Setters */ | ||
| 69 | //@{ | ||
| 70 | |||
| 71 | bool setCarbonDioxideConcentration(bool carbonDioxideConcentration); | ||
| 72 | |||
| 73 | void resetCarbonDioxideConcentration(); | ||
| 74 | |||
| 75 | bool setOutdoorCarbonDioxideSchedule(Schedule& schedule); | ||
| 76 | |||
| 77 | void resetOutdoorCarbonDioxideSchedule(); | ||
| 78 | |||
| 79 | //@} | ||
| 80 | /** @name Other */ | ||
| 81 | //@{ | ||
| 82 | |||
| 83 | //@} | ||
| 84 | protected: | ||
| 85 | private: | ||
| 86 | REGISTER_LOGGER("openstudio.model.ZoneAirContaminantBalance"); | ||
| 87 | |||
| 88 | boost::optional<ModelObject> outdoorCarbonDioxideScheduleAsModelObject() const; | ||
| 89 | |||
| 90 | bool setOutdoorCarbonDioxideScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 91 | }; | ||
| 92 | |||
| 93 | } // namespace detail | ||
| 94 | |||
| 95 | } // namespace model | ||
| 96 | } // namespace openstudio | ||
| 97 | |||
| 98 | #endif // MODEL_ZONEAIRCONTAMINANTBALANCE_IMPL_HPP | ||
| 99 |