src/model/GeneratorFuelCellAuxiliaryHeater.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_GENERATORFUELCELLAUXILIARYHEATER_HPP | ||
| 7 | #define MODEL_GENERATORFUELCELLAUXILIARYHEATER_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class ThermalZone; | ||
| 17 | class GeneratorFuelCell; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class GeneratorFuelCellAuxiliaryHeater_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** GeneratorFuelCellAuxiliaryHeater is a ModelObject that wraps the OpenStudio IDD object 'OS:Generator:FuelCell:AuxiliaryHeater'. */ | ||
| 26 | class MODEL_API GeneratorFuelCellAuxiliaryHeater : public ModelObject | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit GeneratorFuelCellAuxiliaryHeater(const Model& model); | ||
| 33 | |||
| 34 | 66 | virtual ~GeneratorFuelCellAuxiliaryHeater() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | 12 | GeneratorFuelCellAuxiliaryHeater(const GeneratorFuelCellAuxiliaryHeater& other) = default; | |
| 37 | 30 | GeneratorFuelCellAuxiliaryHeater(GeneratorFuelCellAuxiliaryHeater&& other) = default; | |
| 38 | ✗ | GeneratorFuelCellAuxiliaryHeater& operator=(const GeneratorFuelCellAuxiliaryHeater&) = default; | |
| 39 | ✗ | GeneratorFuelCellAuxiliaryHeater& operator=(GeneratorFuelCellAuxiliaryHeater&&) = default; | |
| 40 | |||
| 41 | //@} | ||
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | static std::vector<std::string> skinLossDestinationValues(); | ||
| 46 | |||
| 47 | static std::vector<std::string> heatingCapacityUnitsValues(); | ||
| 48 | |||
| 49 | /** @name Getters */ | ||
| 50 | //@{ | ||
| 51 | |||
| 52 | double excessAirRatio() const; | ||
| 53 | |||
| 54 | double ancillaryPowerConstantTerm() const; | ||
| 55 | |||
| 56 | double ancillaryPowerLinearTerm() const; | ||
| 57 | |||
| 58 | double skinLossUFactorTimesAreaValue() const; | ||
| 59 | |||
| 60 | std::string skinLossDestination() const; | ||
| 61 | |||
| 62 | boost::optional<ThermalZone> zonetoReceiveSkinLosses() const; | ||
| 63 | |||
| 64 | std::string heatingCapacityUnits() const; | ||
| 65 | |||
| 66 | double maximumHeatingCapacityinWatts() const; | ||
| 67 | |||
| 68 | double minimumHeatingCapacityinWatts() const; | ||
| 69 | |||
| 70 | double maximumHeatingCapacityinKmolperSecond() const; | ||
| 71 | |||
| 72 | double minimumHeatingCapacityinKmolperSecond() const; | ||
| 73 | |||
| 74 | // Return optional parent generator | ||
| 75 | boost::optional<GeneratorFuelCell> fuelCell() const; | ||
| 76 | |||
| 77 | //@} | ||
| 78 | /** @name Setters */ | ||
| 79 | //@{ | ||
| 80 | |||
| 81 | bool setExcessAirRatio(double excessAirRatio); | ||
| 82 | |||
| 83 | void resetExcessAirRatio(); | ||
| 84 | |||
| 85 | bool setAncillaryPowerConstantTerm(double ancillaryPowerConstantTerm); | ||
| 86 | |||
| 87 | void resetAncillaryPowerConstantTerm(); | ||
| 88 | |||
| 89 | bool setAncillaryPowerLinearTerm(double ancillaryPowerLinearTerm); | ||
| 90 | |||
| 91 | void resetAncillaryPowerLinearTerm(); | ||
| 92 | |||
| 93 | bool setSkinLossUFactorTimesAreaValue(double skinLossUFactorTimesAreaValue); | ||
| 94 | |||
| 95 | void resetSkinLossUFactorTimesAreaValue(); | ||
| 96 | |||
| 97 | bool setSkinLossDestination(const std::string& skinLossDestination); | ||
| 98 | |||
| 99 | void resetSkinLossDestination(); | ||
| 100 | |||
| 101 | bool setZonetoReceiveSkinLosses(const ThermalZone& zone); | ||
| 102 | |||
| 103 | void resetZonetoReceiveSkinLosses(); | ||
| 104 | |||
| 105 | bool setHeatingCapacityUnits(const std::string& heatingCapacityUnits); | ||
| 106 | |||
| 107 | void resetHeatingCapacityUnits(); | ||
| 108 | |||
| 109 | bool setMaximumHeatingCapacityinWatts(double maximumHeatingCapacityinWatts); | ||
| 110 | |||
| 111 | void resetMaximumHeatingCapacityinWatts(); | ||
| 112 | |||
| 113 | bool setMinimumHeatingCapacityinWatts(double minimumHeatingCapacityinWatts); | ||
| 114 | |||
| 115 | void resetMinimumHeatingCapacityinWatts(); | ||
| 116 | |||
| 117 | bool setMaximumHeatingCapacityinKmolperSecond(double maximumHeatingCapacityinKmolperSecond); | ||
| 118 | |||
| 119 | void resetMaximumHeatingCapacityinKmolperSecond(); | ||
| 120 | |||
| 121 | bool setMinimumHeatingCapacityinKmolperSecond(double minimumHeatingCapacityinKmolperSecond); | ||
| 122 | |||
| 123 | void resetMinimumHeatingCapacityinKmolperSecond(); | ||
| 124 | |||
| 125 | //@} | ||
| 126 | /** @name Other */ | ||
| 127 | //@{ | ||
| 128 | |||
| 129 | //@} | ||
| 130 | protected: | ||
| 131 | /// @cond | ||
| 132 | using ImplType = detail::GeneratorFuelCellAuxiliaryHeater_Impl; | ||
| 133 | |||
| 134 | explicit GeneratorFuelCellAuxiliaryHeater(std::shared_ptr<detail::GeneratorFuelCellAuxiliaryHeater_Impl> impl); | ||
| 135 | |||
| 136 | friend class detail::GeneratorFuelCellAuxiliaryHeater_Impl; | ||
| 137 | friend class Model; | ||
| 138 | friend class IdfObject; | ||
| 139 | friend class openstudio::detail::IdfObject_Impl; | ||
| 140 | /// @endcond | ||
| 141 | private: | ||
| 142 | REGISTER_LOGGER("openstudio.model.GeneratorFuelCellAuxiliaryHeater"); | ||
| 143 | }; | ||
| 144 | |||
| 145 | /** \relates GeneratorFuelCellAuxiliaryHeater*/ | ||
| 146 | using OptionalGeneratorFuelCellAuxiliaryHeater = boost::optional<GeneratorFuelCellAuxiliaryHeater>; | ||
| 147 | |||
| 148 | /** \relates GeneratorFuelCellAuxiliaryHeater*/ | ||
| 149 | using GeneratorFuelCellAuxiliaryHeaterVector = std::vector<GeneratorFuelCellAuxiliaryHeater>; | ||
| 150 | |||
| 151 | } // namespace model | ||
| 152 | } // namespace openstudio | ||
| 153 | |||
| 154 | #endif // MODEL_GENERATORFUELCELLAUXILIARYHEATER_HPP | ||
| 155 |