src/model/CoilHeatingElectricMultiStageStageData.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_COILHEATINGELECTRICMULTISTAGESTAGEDATA_HPP | ||
| 7 | #define MODEL_COILHEATINGELECTRICMULTISTAGESTAGEDATA_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | #include "../model/CoilHeatingElectricMultiStage.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | |||
| 15 | namespace model { | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | class CoilHeatingElectricMultiStageStageData_Impl; | ||
| 20 | |||
| 21 | } // namespace detail | ||
| 22 | |||
| 23 | /** CoilHeatingElectricMultiStageStageData is a ModelObject that wraps the OpenStudio IDD object 'OS:Coil:Heating:Electric:MultiStage:StageData'. */ | ||
| 24 | class MODEL_API CoilHeatingElectricMultiStageStageData : public ModelObject | ||
| 25 | { | ||
| 26 | public: | ||
| 27 | /** @name Constructors and Destructors */ | ||
| 28 | //@{ | ||
| 29 | |||
| 30 | explicit CoilHeatingElectricMultiStageStageData(const Model& model); | ||
| 31 | |||
| 32 | 417 | virtual ~CoilHeatingElectricMultiStageStageData() override = default; | |
| 33 | 109 | CoilHeatingElectricMultiStageStageData(const CoilHeatingElectricMultiStageStageData& other) = default; | |
| 34 | 173 | CoilHeatingElectricMultiStageStageData(CoilHeatingElectricMultiStageStageData&& other) = default; | |
| 35 | ✗ | CoilHeatingElectricMultiStageStageData& operator=(const CoilHeatingElectricMultiStageStageData&) = default; | |
| 36 | 4 | CoilHeatingElectricMultiStageStageData& operator=(CoilHeatingElectricMultiStageStageData&&) = default; | |
| 37 | |||
| 38 | //@} | ||
| 39 | |||
| 40 | static IddObjectType iddObjectType(); | ||
| 41 | |||
| 42 | /** @name Getters */ | ||
| 43 | //@{ | ||
| 44 | |||
| 45 | double efficiency() const; | ||
| 46 | |||
| 47 | boost::optional<double> nominalCapacity() const; | ||
| 48 | |||
| 49 | bool isNominalCapacityAutosized() const; | ||
| 50 | |||
| 51 | //@} | ||
| 52 | /** @name Setters */ | ||
| 53 | //@{ | ||
| 54 | |||
| 55 | bool setEfficiency(double StageEfficiency); | ||
| 56 | |||
| 57 | bool setNominalCapacity(double StageNominalCapacity); | ||
| 58 | |||
| 59 | void autosizeNominalCapacity(); | ||
| 60 | |||
| 61 | //@} | ||
| 62 | /** @name Other */ | ||
| 63 | //@{ | ||
| 64 | |||
| 65 | // Returns the CoilHeatingElectricMultiStage that references it if any | ||
| 66 | boost::optional<CoilHeatingElectricMultiStage> parentCoil() const; | ||
| 67 | |||
| 68 | boost::optional<double> autosizedNominalCapacity() const; | ||
| 69 | |||
| 70 | void autosize(); | ||
| 71 | |||
| 72 | void applySizingValues(); | ||
| 73 | |||
| 74 | //@} | ||
| 75 | protected: | ||
| 76 | /// @cond | ||
| 77 | using ImplType = detail::CoilHeatingElectricMultiStageStageData_Impl; | ||
| 78 | |||
| 79 | explicit CoilHeatingElectricMultiStageStageData(std::shared_ptr<detail::CoilHeatingElectricMultiStageStageData_Impl> impl); | ||
| 80 | |||
| 81 | friend class detail::CoilHeatingElectricMultiStageStageData_Impl; | ||
| 82 | friend class Model; | ||
| 83 | friend class IdfObject; | ||
| 84 | friend class openstudio::detail::IdfObject_Impl; | ||
| 85 | /// @endcond | ||
| 86 | private: | ||
| 87 | REGISTER_LOGGER("openstudio.model.CoilHeatingElectricMultiStageStageData"); | ||
| 88 | |||
| 89 | // Used to determine the index of this performance data in the | ||
| 90 | // list of stages in the parent object. | ||
| 91 | boost::optional<std::tuple<int, CoilHeatingElectricMultiStage>> stageIndexAndParentCoil() const; | ||
| 92 | }; | ||
| 93 | |||
| 94 | /** \relates CoilHeatingElectricMultiStageStageData*/ | ||
| 95 | using OptionalCoilHeatingElectricMultiStageStageData = boost::optional<CoilHeatingElectricMultiStageStageData>; | ||
| 96 | |||
| 97 | /** \relates CoilHeatingElectricMultiStageStageData*/ | ||
| 98 | using CoilHeatingElectricMultiStageStageDataVector = std::vector<CoilHeatingElectricMultiStageStageData>; | ||
| 99 | |||
| 100 | } // namespace model | ||
| 101 | } // namespace openstudio | ||
| 102 | |||
| 103 | #endif // MODEL_COILHEATINGELECTRICMULTISTAGESTAGEDATA_HPP | ||
| 104 |