src/model/AirTerminalSingleDuctConstantVolumeFourPipeBeam_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_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEFOURPIPEBEAM_IMPL_HPP | ||
| 7 | #define MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEFOURPIPEBEAM_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class HVACComponent; | ||
| 16 | class Schedule; | ||
| 17 | class Node; | ||
| 18 | class HVACComponent; | ||
| 19 | class PlantLoop; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | /** AirTerminalSingleDuctConstantVolumeFourPipeBeam_Impl is a StraightComponent_Impl that is the implementation class for AirTerminalSingleDuctConstantVolumeFourPipeBeam.*/ | ||
| 24 | class MODEL_API AirTerminalSingleDuctConstantVolumeFourPipeBeam_Impl : public StraightComponent_Impl | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | AirTerminalSingleDuctConstantVolumeFourPipeBeam_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | AirTerminalSingleDuctConstantVolumeFourPipeBeam_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | AirTerminalSingleDuctConstantVolumeFourPipeBeam_Impl(const AirTerminalSingleDuctConstantVolumeFourPipeBeam_Impl& other, Model_Impl* model, | ||
| 35 | bool keepHandle); | ||
| 36 | |||
| 37 | 11 | virtual ~AirTerminalSingleDuctConstantVolumeFourPipeBeam_Impl() override = default; | |
| 38 | |||
| 39 | //@} | ||
| 40 | /** @name Virtual Methods */ | ||
| 41 | //@{ | ||
| 42 | |||
| 43 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 44 | |||
| 45 | virtual IddObjectType iddObjectType() const override; | ||
| 46 | |||
| 47 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 48 | |||
| 49 | virtual std::vector<ModelObject> children() const override; | ||
| 50 | |||
| 51 | virtual bool addToNode(Node& node) override; | ||
| 52 | |||
| 53 | virtual unsigned inletPort() const override; | ||
| 54 | |||
| 55 | virtual unsigned outletPort() const override; | ||
| 56 | |||
| 57 | virtual ModelObject clone(Model model) const override; | ||
| 58 | |||
| 59 | virtual std::vector<IdfObject> remove() override; | ||
| 60 | |||
| 61 | virtual bool isRemovable() const override; | ||
| 62 | |||
| 63 | virtual ComponentType componentType() const override; | ||
| 64 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 65 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 66 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 67 | |||
| 68 | //@} | ||
| 69 | /** @name Getters */ | ||
| 70 | //@{ | ||
| 71 | |||
| 72 | /** Availability Schedules */ | ||
| 73 | |||
| 74 | Schedule primaryAirAvailabilitySchedule() const; | ||
| 75 | |||
| 76 | Schedule coolingAvailabilitySchedule() const; | ||
| 77 | |||
| 78 | Schedule heatingAvailabilitySchedule() const; | ||
| 79 | |||
| 80 | boost::optional<Node> primaryAirInletNode() const; | ||
| 81 | boost::optional<Node> primaryAirOutletNode() const; | ||
| 82 | |||
| 83 | boost::optional<HVACComponent> coolingCoil() const; | ||
| 84 | |||
| 85 | boost::optional<HVACComponent> heatingCoil() const; | ||
| 86 | |||
| 87 | /** Autosizable fields */ | ||
| 88 | |||
| 89 | boost::optional<double> designPrimaryAirVolumeFlowRate() const; | ||
| 90 | bool isDesignPrimaryAirVolumeFlowRateAutosized() const; | ||
| 91 | |||
| 92 | boost::optional<double> designChilledWaterVolumeFlowRate() const; | ||
| 93 | bool isDesignChilledWaterVolumeFlowRateAutosized() const; | ||
| 94 | |||
| 95 | boost::optional<double> designHotWaterVolumeFlowRate() const; | ||
| 96 | bool isDesignHotWaterVolumeFlowRateAutosized() const; | ||
| 97 | |||
| 98 | boost::optional<double> zoneTotalBeamLength() const; | ||
| 99 | bool isZoneTotalBeamLengthAutosized() const; | ||
| 100 | |||
| 101 | /* Double fields with defaults */ | ||
| 102 | double ratedPrimaryAirFlowRateperBeamLength() const; | ||
| 103 | bool isRatedPrimaryAirFlowRateperBeamLengthDefaulted() const; | ||
| 104 | |||
| 105 | //@} | ||
| 106 | /** @name Setters */ | ||
| 107 | //@{ | ||
| 108 | |||
| 109 | bool setPrimaryAirAvailabilitySchedule(Schedule& schedule); | ||
| 110 | |||
| 111 | bool setCoolingAvailabilitySchedule(Schedule& schedule); | ||
| 112 | |||
| 113 | bool setHeatingAvailabilitySchedule(Schedule& schedule); | ||
| 114 | |||
| 115 | /* Set Cooling and Heating Coil. */ | ||
| 116 | bool setCoolingCoil(const HVACComponent& coilCoolingFourPipeBeam); | ||
| 117 | bool setHeatingCoil(const HVACComponent& coilHeatingFourPipeBeam); | ||
| 118 | |||
| 119 | /* Autosizable fields */ | ||
| 120 | bool setDesignPrimaryAirVolumeFlowRate(double designPrimaryAirVolumeFlowRate); | ||
| 121 | void autosizeDesignPrimaryAirVolumeFlowRate(); | ||
| 122 | |||
| 123 | bool setDesignChilledWaterVolumeFlowRate(double designChilledWaterVolumeFlowRate); | ||
| 124 | void autosizeDesignChilledWaterVolumeFlowRate(); | ||
| 125 | |||
| 126 | bool setDesignHotWaterVolumeFlowRate(double designHotWaterVolumeFlowRate); | ||
| 127 | void autosizeDesignHotWaterVolumeFlowRate(); | ||
| 128 | |||
| 129 | bool setZoneTotalBeamLength(double zoneTotalBeamLength); | ||
| 130 | void autosizeZoneTotalBeamLength(); | ||
| 131 | |||
| 132 | bool setRatedPrimaryAirFlowRateperBeamLength(double ratedPrimaryAirFlowRateperBeamLength); | ||
| 133 | void resetRatedPrimaryAirFlowRateperBeamLength(); | ||
| 134 | |||
| 135 | //@} | ||
| 136 | /** @name Other */ | ||
| 137 | //@{ | ||
| 138 | |||
| 139 | /* Convenience method to return the chilled water PlantLoop */ | ||
| 140 | boost::optional<PlantLoop> chilledWaterPlantLoop() const; | ||
| 141 | boost::optional<Node> chilledWaterInletNode() const; | ||
| 142 | boost::optional<Node> chilledWaterOutletNode() const; | ||
| 143 | |||
| 144 | /* Convenience method to return the hot water PlantLoop */ | ||
| 145 | boost::optional<PlantLoop> hotWaterPlantLoop() const; | ||
| 146 | boost::optional<Node> hotWaterInletNode() const; | ||
| 147 | boost::optional<Node> hotWaterOutletNode() const; | ||
| 148 | |||
| 149 | /* Queries the SQL file after a successful sizing run */ | ||
| 150 | boost::optional<double> autosizedDesignPrimaryAirVolumeFlowRate(); | ||
| 151 | boost::optional<double> autosizedDesignChilledWaterVolumeFlowRate(); | ||
| 152 | boost::optional<double> autosizedDesignHotWaterVolumeFlowRate(); | ||
| 153 | boost::optional<double> autosizedZoneTotalBeamLength(); | ||
| 154 | |||
| 155 | virtual void autosize() override; | ||
| 156 | |||
| 157 | virtual void applySizingValues() override; | ||
| 158 | |||
| 159 | //@} | ||
| 160 | protected: | ||
| 161 | private: | ||
| 162 | − | REGISTER_LOGGER("openstudio.model.AirTerminalSingleDuctConstantVolumeFourPipeBeam"); | |
| 163 | |||
| 164 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 165 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 166 | // objects should be returned as boost::optionals | ||
| 167 | boost::optional<Node> optionalPrimaryAirInletNode() const; | ||
| 168 | boost::optional<Node> optionalPrimaryAirOutletNode() const; | ||
| 169 | }; | ||
| 170 | |||
| 171 | } // namespace detail | ||
| 172 | |||
| 173 | } // namespace model | ||
| 174 | } // namespace openstudio | ||
| 175 | |||
| 176 | #endif // MODEL_AIRTERMINALSINGLEDUCTCONSTANTVOLUMEFOURPIPEBEAM_IMPL_HPP | ||
| 177 |