src/model/CoilHeatingGas_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_COILHEATINGGAS_IMPL_HPP | ||
| 7 | #define MODEL_COILHEATINGGAS_IMPL_HPP | ||
| 8 | |||
| 9 | #include "StraightComponent_Impl.hpp" | ||
| 10 | |||
| 11 | namespace openstudio { | ||
| 12 | namespace model { | ||
| 13 | |||
| 14 | class Curve; | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | class MODEL_API CoilHeatingGas_Impl : public StraightComponent_Impl | ||
| 19 | { | ||
| 20 | public: | ||
| 21 | /** @name Constructors and Destructors */ | ||
| 22 | //2{ | ||
| 23 | |||
| 24 | // constructor | ||
| 25 | CoilHeatingGas_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 26 | |||
| 27 | // construct from workspace | ||
| 28 | CoilHeatingGas_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | // copy constructor | ||
| 31 | CoilHeatingGas_Impl(const CoilHeatingGas_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | // virtual destructor | ||
| 34 | 380 | virtual ~CoilHeatingGas_Impl() override = default; | |
| 35 | |||
| 36 | //@} | ||
| 37 | /** @name Virtual Methods */ | ||
| 38 | //@{ | ||
| 39 | |||
| 40 | // Get all output variable names that could be associated with this object. | ||
| 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 boost::optional<HVACComponent> containingHVACComponent() const override; | ||
| 52 | virtual boost::optional<ZoneHVACComponent> containingZoneHVACComponent() const override; | ||
| 53 | |||
| 54 | virtual ComponentType componentType() const override; | ||
| 55 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 56 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 57 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 58 | |||
| 59 | //@} | ||
| 60 | /** @name Getters and Setters */ | ||
| 61 | //@{ | ||
| 62 | |||
| 63 | Schedule availabilitySchedule() const; | ||
| 64 | |||
| 65 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 66 | |||
| 67 | std::string fuelType() const; | ||
| 68 | |||
| 69 | bool setFuelType(const std::string& fuelType); | ||
| 70 | |||
| 71 | void resetFuelType(); | ||
| 72 | |||
| 73 | // Get GasBurnerEfficiency | ||
| 74 | double gasBurnerEfficiency() const; | ||
| 75 | |||
| 76 | // Set GasBurnerEfficiency | ||
| 77 | bool setGasBurnerEfficiency(double val); | ||
| 78 | |||
| 79 | // Get ParasiticElectricLoad | ||
| 80 | double onCycleParasiticElectricLoad() const; | ||
| 81 | |||
| 82 | // Set OnCycleParasiticElectricLoad | ||
| 83 | bool setOnCycleParasiticElectricLoad(double val); | ||
| 84 | |||
| 85 | // Get OffCycleParasiticGasLoad | ||
| 86 | double offCycleParasiticGasLoad() const; | ||
| 87 | |||
| 88 | // Set OffCycleParasiticGasLoad | ||
| 89 | bool setOffCycleParasiticGasLoad(double val); | ||
| 90 | |||
| 91 | boost::optional<double> nominalCapacity() const; | ||
| 92 | |||
| 93 | bool isNominalCapacityAutosized() const; | ||
| 94 | |||
| 95 | bool setNominalCapacity(boost::optional<double> nominalCapacity); | ||
| 96 | |||
| 97 | void resetNominalCapacity(); | ||
| 98 | |||
| 99 | void autosizeNominalCapacity(); | ||
| 100 | |||
| 101 | boost::optional<Curve> partLoadFractionCorrelationCurve() const; | ||
| 102 | |||
| 103 | bool setPartLoadFractionCorrelationCurve(const Curve& curve); | ||
| 104 | |||
| 105 | void resetPartLoadFractionCorrelationCurve(); | ||
| 106 | |||
| 107 | std::vector<ModelObject> children() const override; | ||
| 108 | |||
| 109 | ModelObject clone(Model model) const override; | ||
| 110 | |||
| 111 | bool addToNode(Node& node) override; | ||
| 112 | |||
| 113 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 114 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 115 | |||
| 116 | boost::optional<double> autosizedNominalCapacity() const; | ||
| 117 | |||
| 118 | virtual void autosize() override; | ||
| 119 | |||
| 120 | virtual void applySizingValues() override; | ||
| 121 | |||
| 122 | //@} | ||
| 123 | private: | ||
| 124 | − | REGISTER_LOGGER("openstudio.model.CoilHeatingGas"); | |
| 125 | |||
| 126 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 127 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 128 | // objects should be returned as boost::optionals | ||
| 129 | boost::optional<Schedule> optionalAvailabilitySchedule() const; | ||
| 130 | |||
| 131 | boost::optional<ModelObject> availabilityScheduleAsModelObject() const; | ||
| 132 | |||
| 133 | bool setAvailabilityScheduleAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 134 | }; | ||
| 135 | |||
| 136 | } // namespace detail | ||
| 137 | |||
| 138 | } // namespace model | ||
| 139 | } // namespace openstudio | ||
| 140 | |||
| 141 | #endif // MODEL_COILHEATINGGAS_IMPL_HPP | ||
| 142 |