src/model/AirflowNetworkSurface_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_AIRFLOWNETWORKSURFACE_IMPL_HPP | ||
| 7 | #define MODEL_AIRFLOWNETWORKSURFACE_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "AirflowNetworkLinkage_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class PlanarSurface; | ||
| 16 | class AirflowNetworkComponent; | ||
| 17 | class AirflowNetworkExternalNode; | ||
| 18 | class Schedule; | ||
| 19 | class AirflowNetworkOccupantVentilationControl; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | /** AirflowNetworkSurface_Impl is a AirflowNetworkLinkage_Impl that is the implementation class for AirflowNetworkSurface.*/ | ||
| 24 | class MODEL_API AirflowNetworkSurface_Impl : public AirflowNetworkLinkage_Impl | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | AirflowNetworkSurface_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | AirflowNetworkSurface_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | AirflowNetworkSurface_Impl(const AirflowNetworkSurface_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 35 | |||
| 36 | 19 | virtual ~AirflowNetworkSurface_Impl() override = default; | |
| 37 | |||
| 38 | //@} | ||
| 39 | /** @name Virtual Methods */ | ||
| 40 | //@{ | ||
| 41 | |||
| 42 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 43 | |||
| 44 | virtual IddObjectType iddObjectType() const override; | ||
| 45 | |||
| 46 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 47 | |||
| 48 | virtual bool setParent(ParentObject& surfAndSubSurf) override; | ||
| 49 | |||
| 50 | //@} | ||
| 51 | /** @name Getters */ | ||
| 52 | //@{ | ||
| 53 | |||
| 54 | PlanarSurface surface() const; | ||
| 55 | |||
| 56 | boost::optional<AirflowNetworkComponent> leakageComponent() const; | ||
| 57 | |||
| 58 | boost::optional<AirflowNetworkExternalNode> externalNode() const; | ||
| 59 | |||
| 60 | double windowDoorOpeningFactorOrCrackFactor() const; | ||
| 61 | |||
| 62 | bool isWindowDoorOpeningFactorOrCrackFactorDefaulted() const; | ||
| 63 | |||
| 64 | std::string ventilationControlMode() const; | ||
| 65 | |||
| 66 | bool isVentilationControlModeDefaulted() const; | ||
| 67 | |||
| 68 | boost::optional<Schedule> ventilationControlZoneTemperatureSetpointSchedule() const; | ||
| 69 | |||
| 70 | double minimumVentingOpenFactor() const; | ||
| 71 | |||
| 72 | bool isMinimumVentingOpenFactorDefaulted() const; | ||
| 73 | |||
| 74 | double indoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor() const; | ||
| 75 | |||
| 76 | bool isIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactorDefaulted() const; | ||
| 77 | |||
| 78 | double indoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor() const; | ||
| 79 | |||
| 80 | bool isIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactorDefaulted() const; | ||
| 81 | |||
| 82 | double indoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor() const; | ||
| 83 | |||
| 84 | bool isIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactorDefaulted() const; | ||
| 85 | |||
| 86 | double indoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor() const; | ||
| 87 | |||
| 88 | bool isIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactorDefaulted() const; | ||
| 89 | |||
| 90 | boost::optional<Schedule> ventingAvailabilitySchedule() const; | ||
| 91 | |||
| 92 | boost::optional<AirflowNetworkOccupantVentilationControl> occupantVentilationControl() const; | ||
| 93 | |||
| 94 | //@} | ||
| 95 | /** @name Setters */ | ||
| 96 | //@{ | ||
| 97 | |||
| 98 | bool setSurface(const PlanarSurface& surfAndSubSurf); | ||
| 99 | |||
| 100 | void resetSurface(); | ||
| 101 | |||
| 102 | bool setLeakageComponent(const AirflowNetworkComponent& surfaceAirflowLeakage); | ||
| 103 | |||
| 104 | bool setExternalNode(const AirflowNetworkExternalNode& externalNode); | ||
| 105 | |||
| 106 | void resetExternalNode(); | ||
| 107 | |||
| 108 | bool setWindowDoorOpeningFactorOrCrackFactor(double windowDoorOpeningFactorOrCrackFactor); | ||
| 109 | |||
| 110 | void resetWindowDoorOpeningFactorOrCrackFactor(); | ||
| 111 | |||
| 112 | bool setVentilationControlMode(const std::string& ventilationControlMode); | ||
| 113 | |||
| 114 | void resetVentilationControlMode(); | ||
| 115 | |||
| 116 | bool setVentilationControlZoneTemperatureSetpointSchedule(Schedule& schedule); | ||
| 117 | |||
| 118 | void resetVentilationControlZoneTemperatureSetpointSchedule(); | ||
| 119 | |||
| 120 | bool setMinimumVentingOpenFactor(double minimumVentingOpenFactor); | ||
| 121 | |||
| 122 | void resetMinimumVentingOpenFactor(); | ||
| 123 | |||
| 124 | bool setIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor( | ||
| 125 | double indoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor); | ||
| 126 | |||
| 127 | void resetIndoorandOutdoorTemperatureDifferenceLowerLimitForMaximumVentingOpenFactor(); | ||
| 128 | |||
| 129 | bool setIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor( | ||
| 130 | double indoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor); | ||
| 131 | |||
| 132 | void resetIndoorandOutdoorTemperatureDifferenceUpperLimitforMinimumVentingOpenFactor(); | ||
| 133 | |||
| 134 | bool setIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor( | ||
| 135 | double indoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor); | ||
| 136 | |||
| 137 | void resetIndoorandOutdoorEnthalpyDifferenceLowerLimitForMaximumVentingOpenFactor(); | ||
| 138 | |||
| 139 | bool setIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor( | ||
| 140 | double indoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor); | ||
| 141 | |||
| 142 | void resetIndoorandOutdoorEnthalpyDifferenceUpperLimitforMinimumVentingOpenFactor(); | ||
| 143 | |||
| 144 | bool setVentingAvailabilitySchedule(Schedule& schedule); | ||
| 145 | |||
| 146 | void resetVentingAvailabilitySchedule(); | ||
| 147 | |||
| 148 | bool setOccupantVentilationControl(const AirflowNetworkOccupantVentilationControl& airflowNetworkOccupantVentilationControl); | ||
| 149 | |||
| 150 | void resetOccupantVentilationControl(); | ||
| 151 | |||
| 152 | //@} | ||
| 153 | /** @name Other */ | ||
| 154 | //@{ | ||
| 155 | |||
| 156 | //@} | ||
| 157 | protected: | ||
| 158 | private: | ||
| 159 | − | REGISTER_LOGGER("openstudio.model.AirflowNetworkSurface"); | |
| 160 | |||
| 161 | boost::optional<PlanarSurface> optionalSurface() const; | ||
| 162 | }; | ||
| 163 | |||
| 164 | } // namespace detail | ||
| 165 | |||
| 166 | } // namespace model | ||
| 167 | } // namespace openstudio | ||
| 168 | |||
| 169 | #endif // MODEL_AIRFLOWNETWORKSURFACE_IMPL_HPP | ||
| 170 |