src/model/CoilHeatingGasMultiStageStageData.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_COILHEATINGGASMULTISTAGESTAGEDATA_HPP | ||
| 7 | #define MODEL_COILHEATINGGASMULTISTAGESTAGEDATA_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | #include "../model/CoilHeatingGasMultiStage.hpp" | ||
| 12 | #include "../utilities/core/Deprecated.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | class CoilHeatingGasMultiStageStageData_Impl; | ||
| 21 | |||
| 22 | } // namespace detail | ||
| 23 | |||
| 24 | /** CoilHeatingGasMultiStageStageData is a ModelObject that wraps the OpenStudio IDD object 'OS:Coil:Heating:Gas:MultiStage:StageData'. */ | ||
| 25 | class MODEL_API CoilHeatingGasMultiStageStageData : public ModelObject | ||
| 26 | { | ||
| 27 | public: | ||
| 28 | /** @name Constructors and Destructors */ | ||
| 29 | //@{ | ||
| 30 | |||
| 31 | explicit CoilHeatingGasMultiStageStageData(const Model& model); | ||
| 32 | |||
| 33 | 373 | virtual ~CoilHeatingGasMultiStageStageData() override = default; | |
| 34 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 35 | 100 | CoilHeatingGasMultiStageStageData(const CoilHeatingGasMultiStageStageData& other) = default; | |
| 36 | 158 | CoilHeatingGasMultiStageStageData(CoilHeatingGasMultiStageStageData&& other) = default; | |
| 37 | ✗ | CoilHeatingGasMultiStageStageData& operator=(const CoilHeatingGasMultiStageStageData&) = default; | |
| 38 | 4 | CoilHeatingGasMultiStageStageData& operator=(CoilHeatingGasMultiStageStageData&&) = default; | |
| 39 | |||
| 40 | //@} | ||
| 41 | |||
| 42 | static IddObjectType iddObjectType(); | ||
| 43 | |||
| 44 | /** @name Getters */ | ||
| 45 | //@{ | ||
| 46 | |||
| 47 | double gasBurnerEfficiency() const; | ||
| 48 | |||
| 49 | boost::optional<double> nominalCapacity() const; | ||
| 50 | |||
| 51 | bool isNominalCapacityAutosized() const; | ||
| 52 | |||
| 53 | OS_DEPRECATED(3, 7, 0) double parasiticElectricLoad() const; | ||
| 54 | |||
| 55 | double onCycleParasiticElectricLoad() const; | ||
| 56 | |||
| 57 | //@} | ||
| 58 | /** @name Setters */ | ||
| 59 | //@{ | ||
| 60 | |||
| 61 | bool setGasBurnerEfficiency(double gasBurnerEfficiency); | ||
| 62 | |||
| 63 | bool setNominalCapacity(double stageNominalCapacity); | ||
| 64 | |||
| 65 | void autosizeNominalCapacity(); | ||
| 66 | |||
| 67 | OS_DEPRECATED(3, 7, 0) bool setParasiticElectricLoad(double stageParasiticElectricLoad); | ||
| 68 | |||
| 69 | bool setOnCycleParasiticElectricLoad(double stageOnCycleParasiticElectricLoad); | ||
| 70 | |||
| 71 | //@} | ||
| 72 | /** @name Other */ | ||
| 73 | //@{ | ||
| 74 | |||
| 75 | // Returns the CoilHeatingGasMultiStage that references it if any | ||
| 76 | boost::optional<CoilHeatingGasMultiStage> parentCoil() const; | ||
| 77 | |||
| 78 | boost::optional<double> autosizedNominalCapacity() const; | ||
| 79 | |||
| 80 | void autosize(); | ||
| 81 | |||
| 82 | void applySizingValues(); | ||
| 83 | |||
| 84 | //@} | ||
| 85 | protected: | ||
| 86 | /// @cond | ||
| 87 | using ImplType = detail::CoilHeatingGasMultiStageStageData_Impl; | ||
| 88 | |||
| 89 | explicit CoilHeatingGasMultiStageStageData(std::shared_ptr<detail::CoilHeatingGasMultiStageStageData_Impl> impl); | ||
| 90 | |||
| 91 | friend class detail::CoilHeatingGasMultiStageStageData_Impl; | ||
| 92 | friend class Model; | ||
| 93 | friend class IdfObject; | ||
| 94 | friend class openstudio::detail::IdfObject_Impl; | ||
| 95 | /// @endcond | ||
| 96 | private: | ||
| 97 | − | REGISTER_LOGGER("openstudio.model.CoilHeatingGasMultiStageStageData"); | |
| 98 | |||
| 99 | // Used to determine the index of this performance data in the | ||
| 100 | // list of stages in the parent object. | ||
| 101 | boost::optional<std::tuple<int, CoilHeatingGasMultiStage>> stageIndexAndParentCoil() const; | ||
| 102 | }; | ||
| 103 | |||
| 104 | /** \relates CoilHeatingGasMultiStageStageData*/ | ||
| 105 | using OptionalCoilHeatingGasMultiStageStageData = boost::optional<CoilHeatingGasMultiStageStageData>; | ||
| 106 | |||
| 107 | /** \relates CoilHeatingGasMultiStageStageData*/ | ||
| 108 | using CoilHeatingGasMultiStageStageDataVector = std::vector<CoilHeatingGasMultiStageStageData>; | ||
| 109 | |||
| 110 | } // namespace model | ||
| 111 | } // namespace openstudio | ||
| 112 | |||
| 113 | #endif // MODEL_COILHEATINGGASMULTISTAGESTAGEDATA_HPP | ||
| 114 |