src/model/AirTerminalSingleDuctConstantVolumeReheat_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_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEREHEAT_IMPL_HPP | ||
| 7 | #define MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEREHEAT_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent_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 | class HVACComponent; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | /** AirTerminalSingleDuctConstantVolumeReheat_Impl is a StraightComponent_Impl that is the implementation class for AirTerminalSingleDuctConstantVolumeReheat.*/ | ||
| 22 | class MODEL_API AirTerminalSingleDuctConstantVolumeReheat_Impl : public StraightComponent_Impl | ||
| 23 | { | ||
| 24 | |||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | AirTerminalSingleDuctConstantVolumeReheat_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | AirTerminalSingleDuctConstantVolumeReheat_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | AirTerminalSingleDuctConstantVolumeReheat_Impl(const AirTerminalSingleDuctConstantVolumeReheat_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | 33 | virtual ~AirTerminalSingleDuctConstantVolumeReheat_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 | virtual unsigned inletPort() const override; | ||
| 48 | |||
| 49 | virtual unsigned outletPort() const override; | ||
| 50 | |||
| 51 | virtual bool addToNode(Node& node) override; | ||
| 52 | |||
| 53 | virtual std::vector<ModelObject> children() const override; | ||
| 54 | |||
| 55 | virtual std::vector<openstudio::IdfObject> remove() override; | ||
| 56 | |||
| 57 | virtual bool isRemovable() const override; | ||
| 58 | |||
| 59 | virtual ModelObject clone(Model model) const override; | ||
| 60 | |||
| 61 | virtual ComponentType componentType() const override; | ||
| 62 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 63 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 64 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 65 | |||
| 66 | //@} | ||
| 67 | /** @name Getters */ | ||
| 68 | //@{ | ||
| 69 | |||
| 70 | // TODO: Check return type. From object lists, some candidates are: Schedule. | ||
| 71 | Schedule availabilitySchedule() const; | ||
| 72 | |||
| 73 | boost::optional<double> maximumAirFlowRate() const; | ||
| 74 | |||
| 75 | bool isMaximumAirFlowRateAutosized() const; | ||
| 76 | |||
| 77 | // TODO: Check return type. From object lists, some candidates are: HeatingCoilName. | ||
| 78 | HVACComponent reheatCoil() const; | ||
| 79 | |||
| 80 | boost::optional<double> maximumHotWaterorSteamFlowRate() const; | ||
| 81 | |||
| 82 | bool isMaximumHotWaterorSteamFlowRateAutosized() const; | ||
| 83 | |||
| 84 | double minimumHotWaterorSteamFlowRate() const; | ||
| 85 | |||
| 86 | bool isMinimumHotWaterorSteamFlowRateDefaulted() const; | ||
| 87 | |||
| 88 | double convergenceTolerance() const; | ||
| 89 | |||
| 90 | bool isConvergenceToleranceDefaulted() const; | ||
| 91 | |||
| 92 | double maximumReheatAirTemperature() const; | ||
| 93 | |||
| 94 | bool isMaximumReheatAirTemperatureDefaulted() const; | ||
| 95 | |||
| 96 | boost::optional<double> autosizedMaximumAirFlowRate() const; | ||
| 97 | |||
| 98 | boost::optional<double> autosizedMaximumHotWaterorSteamFlowRate() const; | ||
| 99 | |||
| 100 | virtual void autosize() override; | ||
| 101 | |||
| 102 | virtual void applySizingValues() override; | ||
| 103 | |||
| 104 | //@} | ||
| 105 | /** @name Setters */ | ||
| 106 | //@{ | ||
| 107 | |||
| 108 | // TODO: Check argument type. From object lists, some candidates are: Schedule. | ||
| 109 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 110 | |||
| 111 | bool setMaximumAirFlowRate(boost::optional<double> maximumAirFlowRate); | ||
| 112 | |||
| 113 | void resetMaximumAirFlowRate(); | ||
| 114 | |||
| 115 | void autosizeMaximumAirFlowRate(); | ||
| 116 | |||
| 117 | // TODO: Check argument type. From object lists, some candidates are: HeatingCoilName. | ||
| 118 | bool setReheatCoil(const HVACComponent& coil); | ||
| 119 | |||
| 120 | void resetReheatCoil(); | ||
| 121 | |||
| 122 | bool setMaximumHotWaterorSteamFlowRate(boost::optional<double> maximumHotWaterorSteamFlowRate); | ||
| 123 | |||
| 124 | void resetMaximumHotWaterorSteamFlowRate(); | ||
| 125 | |||
| 126 | void autosizeMaximumHotWaterorSteamFlowRate(); | ||
| 127 | |||
| 128 | bool setMinimumHotWaterorSteamFlowRate(double minimumHotWaterorSteamFlowRate); | ||
| 129 | |||
| 130 | void resetMinimumHotWaterorSteamFlowRate(); | ||
| 131 | |||
| 132 | bool setConvergenceTolerance(double convergenceTolerance); | ||
| 133 | |||
| 134 | void resetConvergenceTolerance(); | ||
| 135 | |||
| 136 | bool setMaximumReheatAirTemperature(double maximumReheatAirTemperature); | ||
| 137 | |||
| 138 | void resetMaximumReheatAirTemperature(); | ||
| 139 | |||
| 140 | //@} | ||
| 141 | /** @name Other */ | ||
| 142 | //@{ | ||
| 143 | |||
| 144 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 145 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 146 | |||
| 147 | //@} | ||
| 148 | protected: | ||
| 149 | private: | ||
| 150 | − | REGISTER_LOGGER("openstudio.model.AirTerminalSingleDuctConstantVolumeReheat"); | |
| 151 | |||
| 152 | // TODO: Check the return types of these methods. | ||
| 153 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 154 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 155 | // objects should be returned as boost::optionals | ||
| 156 | boost::optional<HVACComponent> optionalReheatCoil() const; | ||
| 157 | boost::optional<Schedule> optionalAvailabilitySchedule() const; | ||
| 158 | boost::optional<ModelObject> availabilityScheduleAsModelObject() const; | ||
| 159 | boost::optional<ModelObject> reheatCoilAsModelObject() const; | ||
| 160 | |||
| 161 | bool setAvailabilityScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 162 | bool setReheatCoilAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 163 | }; | ||
| 164 | |||
| 165 | } // namespace detail | ||
| 166 | |||
| 167 | } // namespace model | ||
| 168 | } // namespace openstudio | ||
| 169 | |||
| 170 | #endif // MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEREHEAT_IMPL_HPP | ||
| 171 |