src/model/AirflowNetworkZone_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_AIRFLOWNETWORKZONE_IMPL_HPP | ||
| 7 | #define MODEL_AIRFLOWNETWORKZONE_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | |||
| 11 | #include "AirflowNetworkNode_Impl.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class ThermalZone; | ||
| 17 | class Schedule; | ||
| 18 | class AirflowNetworkOccupantVentilationControl; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | /** AirflowNetworkZone_Impl is a AirflowNetworkNode_Impl that is the implementation class for AirflowNetworkZone.*/ | ||
| 23 | class MODEL_API AirflowNetworkZone_Impl : public AirflowNetworkNode_Impl | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | AirflowNetworkZone_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | AirflowNetworkZone_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | AirflowNetworkZone_Impl(const AirflowNetworkZone_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | 4 | virtual ~AirflowNetworkZone_Impl() override = default; | |
| 36 | |||
| 37 | //@} | ||
| 38 | /** @name Virtual Methods */ | ||
| 39 | //@{ | ||
| 40 | |||
| 41 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 42 | |||
| 43 | virtual IddObjectType iddObjectType() const override; | ||
| 44 | |||
| 45 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 46 | |||
| 47 | //@} | ||
| 48 | /** @name Getters */ | ||
| 49 | //@{ | ||
| 50 | |||
| 51 | ThermalZone thermalZone() const; | ||
| 52 | |||
| 53 | std::string ventilationControlMode() const; | ||
| 54 | |||
| 55 | bool isVentilationControlModeDefaulted() const; | ||
| 56 | |||
| 57 | boost::optional<Schedule> ventilationControlZoneTemperatureSetpointSchedule() const; | ||
| 58 | |||
| 59 | double minimumVentingOpenFactor() const; | ||
| 60 | |||
| 61 | bool isMinimumVentingOpenFactorDefaulted() const; | ||
| 62 | |||
| 63 | double indoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor() const; | ||
| 64 | |||
| 65 | bool isIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactorDefaulted() const; | ||
| 66 | |||
| 67 | double indoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor() const; | ||
| 68 | |||
| 69 | bool isIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactorDefaulted() const; | ||
| 70 | |||
| 71 | double indoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor() const; | ||
| 72 | |||
| 73 | bool isIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactorDefaulted() const; | ||
| 74 | |||
| 75 | double indoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor() const; | ||
| 76 | |||
| 77 | bool isIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactorDefaulted() const; | ||
| 78 | |||
| 79 | boost::optional<Schedule> ventingAvailabilitySchedule() const; | ||
| 80 | |||
| 81 | std::string singleSidedWindPressureCoefficientAlgorithm() const; | ||
| 82 | |||
| 83 | bool isSingleSidedWindPressureCoefficientAlgorithmDefaulted() const; | ||
| 84 | |||
| 85 | double facadeWidth() const; | ||
| 86 | |||
| 87 | bool isFacadeWidthDefaulted() const; | ||
| 88 | |||
| 89 | boost::optional<AirflowNetworkOccupantVentilationControl> occupantVentilationControl() const; | ||
| 90 | |||
| 91 | //@} | ||
| 92 | /** @name Setters */ | ||
| 93 | //@{ | ||
| 94 | |||
| 95 | bool setThermalZone(const ThermalZone& thermalZone); | ||
| 96 | |||
| 97 | void resetThermalZone(); | ||
| 98 | |||
| 99 | bool setVentilationControlMode(const std::string& ventilationControlMode); | ||
| 100 | |||
| 101 | void resetVentilationControlMode(); | ||
| 102 | |||
| 103 | // Note Schedules are passed by reference, not const reference. | ||
| 104 | bool setVentilationControlZoneTemperatureSetpointSchedule(Schedule& schedule); | ||
| 105 | |||
| 106 | void resetVentilationControlZoneTemperatureSetpointSchedule(); | ||
| 107 | |||
| 108 | bool setMinimumVentingOpenFactor(double minimumVentingOpenFactor); | ||
| 109 | |||
| 110 | void resetMinimumVentingOpenFactor(); | ||
| 111 | |||
| 112 | bool setIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor( | ||
| 113 | double indoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor); | ||
| 114 | |||
| 115 | void resetIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor(); | ||
| 116 | |||
| 117 | bool setIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor( | ||
| 118 | double indoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor); | ||
| 119 | |||
| 120 | void resetIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor(); | ||
| 121 | |||
| 122 | bool setIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor( | ||
| 123 | double indoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor); | ||
| 124 | |||
| 125 | void resetIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor(); | ||
| 126 | |||
| 127 | bool setIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor( | ||
| 128 | double indoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor); | ||
| 129 | |||
| 130 | void resetIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor(); | ||
| 131 | |||
| 132 | // Note Schedules are passed by reference, not const reference. | ||
| 133 | bool setVentingAvailabilitySchedule(Schedule& schedule); | ||
| 134 | |||
| 135 | void resetVentingAvailabilitySchedule(); | ||
| 136 | |||
| 137 | bool setSingleSidedWindPressureCoefficientAlgorithm(const std::string& singleSidedWindPressureCoefficientAlgorithm); | ||
| 138 | |||
| 139 | void resetSingleSidedWindPressureCoefficientAlgorithm(); | ||
| 140 | |||
| 141 | bool setFacadeWidth(double facadeWidth); | ||
| 142 | |||
| 143 | void resetFacadeWidth(); | ||
| 144 | |||
| 145 | bool setOccupantVentilationControl(const AirflowNetworkOccupantVentilationControl& airflowNetworkOccupantVentilationControl); | ||
| 146 | |||
| 147 | void resetOccupantVentilationControl(); | ||
| 148 | |||
| 149 | //@} | ||
| 150 | /** @name Other */ | ||
| 151 | //@{ | ||
| 152 | |||
| 153 | //@} | ||
| 154 | protected: | ||
| 155 | private: | ||
| 156 | − | REGISTER_LOGGER("openstudio.model.AirflowNetworkZone"); | |
| 157 | |||
| 158 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 159 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 160 | // objects should be returned as boost::optionals | ||
| 161 | boost::optional<ThermalZone> optionalThermalZone() const; | ||
| 162 | }; | ||
| 163 | |||
| 164 | } // namespace detail | ||
| 165 | |||
| 166 | } // namespace model | ||
| 167 | } // namespace openstudio | ||
| 168 | |||
| 169 | #endif // MODEL_AIRFLOWNETWORKZONE_IMPL_HPP | ||
| 170 |