src/model/CoilUserDefined.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_COILUSERDEFINED_HPP | ||
| 7 | #define MODEL_COILUSERDEFINED_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "WaterToAirComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class EnergyManagementSystemActuator; | ||
| 16 | class EnergyManagementSystemProgram; | ||
| 17 | class EnergyManagementSystemProgramCallingManager; | ||
| 18 | class ThermalZone; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class CoilUserDefined_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** CoilUserDefined is a WaterToAirComponent that wraps the OpenStudio IDD object 'OS:Coil:UserDefined'. */ | ||
| 27 | class MODEL_API CoilUserDefined : public WaterToAirComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit CoilUserDefined(const Model& model); | ||
| 34 | |||
| 35 | 30 | virtual ~CoilUserDefined() override = default; | |
| 36 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 37 | ✗ | CoilUserDefined(const CoilUserDefined& other) = default; | |
| 38 | 4 | CoilUserDefined(CoilUserDefined&& other) = default; | |
| 39 | ✗ | CoilUserDefined& operator=(const CoilUserDefined&) = default; | |
| 40 | ✗ | CoilUserDefined& operator=(CoilUserDefined&&) = default; | |
| 41 | |||
| 42 | //@} | ||
| 43 | |||
| 44 | static IddObjectType iddObjectType(); | ||
| 45 | |||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | EnergyManagementSystemProgramCallingManager overallModelSimulationProgramCallingManager() const; | ||
| 50 | |||
| 51 | EnergyManagementSystemProgramCallingManager modelSetupandSizingProgramCallingManager() const; | ||
| 52 | |||
| 53 | boost::optional<ThermalZone> ambientZone() const; | ||
| 54 | |||
| 55 | EnergyManagementSystemProgram overallSimulationProgram() const; | ||
| 56 | |||
| 57 | EnergyManagementSystemProgram initializationSimulationProgram() const; | ||
| 58 | |||
| 59 | EnergyManagementSystemActuator airOutletTemperatureActuator() const; | ||
| 60 | |||
| 61 | EnergyManagementSystemActuator airOutletHumidityRatioActuator() const; | ||
| 62 | |||
| 63 | EnergyManagementSystemActuator airMassFlowRateActuator() const; | ||
| 64 | |||
| 65 | EnergyManagementSystemActuator plantMinimumMassFlowRateActuator() const; | ||
| 66 | |||
| 67 | EnergyManagementSystemActuator plantMaximumMassFlowRateActuator() const; | ||
| 68 | |||
| 69 | EnergyManagementSystemActuator plantDesignVolumeFlowRateActuator() const; | ||
| 70 | |||
| 71 | EnergyManagementSystemActuator plantOutletTemperatureActuator() const; | ||
| 72 | |||
| 73 | EnergyManagementSystemActuator plantMassFlowRateActuator() const; | ||
| 74 | |||
| 75 | //@} | ||
| 76 | /** @name Setters */ | ||
| 77 | //@{ | ||
| 78 | |||
| 79 | bool setOverallModelSimulationProgramCallingManager(const EnergyManagementSystemProgramCallingManager& emsProgramCallingManager); | ||
| 80 | |||
| 81 | bool setModelSetupandSizingProgramCallingManager(const EnergyManagementSystemProgramCallingManager& emsProgramCallingManager); | ||
| 82 | |||
| 83 | bool setAmbientZone(const ThermalZone& thermalZone); | ||
| 84 | |||
| 85 | void resetAmbientZone(); | ||
| 86 | |||
| 87 | bool setOverallSimulationProgram(const EnergyManagementSystemProgram& emsProgram); | ||
| 88 | |||
| 89 | bool setInitializationSimulationProgram(const EnergyManagementSystemProgram& emsProgram); | ||
| 90 | |||
| 91 | bool setAirOutletTemperatureActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 92 | |||
| 93 | bool setAirOutletHumidityRatioActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 94 | |||
| 95 | bool setAirMassFlowRateActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 96 | |||
| 97 | bool setPlantMinimumMassFlowRateActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 98 | |||
| 99 | bool setPlantMaximumMassFlowRateActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 100 | |||
| 101 | bool setPlantDesignVolumeFlowRateActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 102 | |||
| 103 | bool setPlantOutletTemperatureActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 104 | |||
| 105 | bool setPlantMassFlowRateActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 106 | |||
| 107 | //@} | ||
| 108 | /** @name Other */ | ||
| 109 | //@{ | ||
| 110 | |||
| 111 | int numberofAirConnections() const; | ||
| 112 | |||
| 113 | // Will rename the EMS Program, Program Calling Manager, and Actuators to be nameString() + " xxx" | ||
| 114 | void renameEMSSubComponents(); | ||
| 115 | |||
| 116 | //@} | ||
| 117 | protected: | ||
| 118 | /// @cond | ||
| 119 | using ImplType = detail::CoilUserDefined_Impl; | ||
| 120 | |||
| 121 | explicit CoilUserDefined(std::shared_ptr<detail::CoilUserDefined_Impl> impl); | ||
| 122 | |||
| 123 | friend class detail::CoilUserDefined_Impl; | ||
| 124 | friend class Model; | ||
| 125 | friend class IdfObject; | ||
| 126 | friend class openstudio::detail::IdfObject_Impl; | ||
| 127 | /// @endcond | ||
| 128 | private: | ||
| 129 | REGISTER_LOGGER("openstudio.model.CoilUserDefined"); | ||
| 130 | }; | ||
| 131 | |||
| 132 | /** \relates CoilUserDefined*/ | ||
| 133 | using OptionalCoilUserDefined = boost::optional<CoilUserDefined>; | ||
| 134 | |||
| 135 | /** \relates CoilUserDefined*/ | ||
| 136 | using CoilUserDefinedVector = std::vector<CoilUserDefined>; | ||
| 137 | |||
| 138 | } // namespace model | ||
| 139 | } // namespace openstudio | ||
| 140 | |||
| 141 | #endif // MODEL_COILUSERDEFINED_HPP | ||
| 142 |