src/model/CoilUserDefined_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_COILUSERDEFINED_IMPL_HPP | ||
| 7 | #define MODEL_COILUSERDEFINED_IMPL_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "WaterToAirComponent_Impl.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 | /** CoilUserDefined_Impl is a WaterToAirComponent_Impl that is the implementation class for CoilUserDefined.*/ | ||
| 23 | class MODEL_API CoilUserDefined_Impl : public WaterToAirComponent_Impl | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | CoilUserDefined_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | CoilUserDefined_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | CoilUserDefined_Impl(const CoilUserDefined_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | 22 | virtual ~CoilUserDefined_Impl() override = default; | |
| 36 | |||
| 37 | //@} | ||
| 38 | /** @name Virtual Methods */ | ||
| 39 | //@{ | ||
| 40 | |||
| 41 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 42 | |||
| 43 | virtual IddObjectType iddObjectType() const override; | ||
| 44 | |||
| 45 | virtual unsigned airInletPort() const override; | ||
| 46 | |||
| 47 | virtual unsigned airOutletPort() const override; | ||
| 48 | |||
| 49 | virtual unsigned waterInletPort() const override; | ||
| 50 | |||
| 51 | virtual unsigned waterOutletPort() const override; | ||
| 52 | |||
| 53 | // virtual std::vector<openstudio::IdfObject> remove() override; | ||
| 54 | |||
| 55 | // HVACComponent skips the ParentObject and goes straight to ModelObject so children aren't clone | ||
| 56 | virtual ModelObject clone(Model model) const override; | ||
| 57 | |||
| 58 | virtual std::vector<IddObjectType> allowableChildTypes() const override; | ||
| 59 | |||
| 60 | virtual std::vector<ModelObject> children() const override; | ||
| 61 | |||
| 62 | virtual boost::optional<HVACComponent> containingHVACComponent() const override; | ||
| 63 | |||
| 64 | virtual ComponentType componentType() const override; | ||
| 65 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 66 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 67 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 68 | |||
| 69 | //@} | ||
| 70 | /** @name Getters */ | ||
| 71 | //@{ | ||
| 72 | |||
| 73 | EnergyManagementSystemProgramCallingManager overallModelSimulationProgramCallingManager() const; | ||
| 74 | |||
| 75 | EnergyManagementSystemProgramCallingManager modelSetupandSizingProgramCallingManager() const; | ||
| 76 | |||
| 77 | boost::optional<ThermalZone> ambientZone() const; | ||
| 78 | |||
| 79 | EnergyManagementSystemProgram overallSimulationProgram() const; | ||
| 80 | |||
| 81 | EnergyManagementSystemProgram initializationSimulationProgram() const; | ||
| 82 | |||
| 83 | EnergyManagementSystemActuator airOutletTemperatureActuator() const; | ||
| 84 | |||
| 85 | EnergyManagementSystemActuator airOutletHumidityRatioActuator() const; | ||
| 86 | |||
| 87 | EnergyManagementSystemActuator airMassFlowRateActuator() const; | ||
| 88 | |||
| 89 | EnergyManagementSystemActuator plantMinimumMassFlowRateActuator() const; | ||
| 90 | |||
| 91 | EnergyManagementSystemActuator plantMaximumMassFlowRateActuator() const; | ||
| 92 | |||
| 93 | EnergyManagementSystemActuator plantDesignVolumeFlowRateActuator() const; | ||
| 94 | |||
| 95 | EnergyManagementSystemActuator plantOutletTemperatureActuator() const; | ||
| 96 | |||
| 97 | EnergyManagementSystemActuator plantMassFlowRateActuator() const; | ||
| 98 | |||
| 99 | //@} | ||
| 100 | /** @name Setters */ | ||
| 101 | //@{ | ||
| 102 | |||
| 103 | bool setOverallModelSimulationProgramCallingManager(const EnergyManagementSystemProgramCallingManager& emsProgramCallingManager); | ||
| 104 | |||
| 105 | bool setModelSetupandSizingProgramCallingManager(const EnergyManagementSystemProgramCallingManager& emsProgramCallingManager); | ||
| 106 | |||
| 107 | bool setAmbientZone(const ThermalZone& thermalZone); | ||
| 108 | |||
| 109 | void resetAmbientZone(); | ||
| 110 | |||
| 111 | bool setOverallSimulationProgram(const EnergyManagementSystemProgram& emsProgram); | ||
| 112 | |||
| 113 | bool setInitializationSimulationProgram(const EnergyManagementSystemProgram& emsProgram); | ||
| 114 | |||
| 115 | bool setAirOutletTemperatureActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 116 | |||
| 117 | bool setAirOutletHumidityRatioActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 118 | |||
| 119 | bool setAirMassFlowRateActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 120 | |||
| 121 | bool setPlantMinimumMassFlowRateActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 122 | |||
| 123 | bool setPlantMaximumMassFlowRateActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 124 | |||
| 125 | bool setPlantDesignVolumeFlowRateActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 126 | |||
| 127 | bool setPlantOutletTemperatureActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 128 | |||
| 129 | bool setPlantMassFlowRateActuator(const EnergyManagementSystemActuator& emsActuator); | ||
| 130 | |||
| 131 | //@} | ||
| 132 | /** @name Other */ | ||
| 133 | //@{ | ||
| 134 | |||
| 135 | int numberofAirConnections() const; | ||
| 136 | |||
| 137 | void renameEMSSubComponents(); | ||
| 138 | |||
| 139 | //@} | ||
| 140 | protected: | ||
| 141 | private: | ||
| 142 | − | REGISTER_LOGGER("openstudio.model.CoilUserDefined"); | |
| 143 | |||
| 144 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 145 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 146 | // objects should be returned as boost::optionals | ||
| 147 | boost::optional<EnergyManagementSystemProgramCallingManager> optionalOverallModelSimulationProgramCallingManager() const; | ||
| 148 | boost::optional<EnergyManagementSystemProgramCallingManager> optionalModelSetupandSizingProgramCallingManager() const; | ||
| 149 | boost::optional<EnergyManagementSystemProgram> optionalOverallSimulationProgram() const; | ||
| 150 | boost::optional<EnergyManagementSystemProgram> optionalInitializationSimulationProgram() const; | ||
| 151 | boost::optional<EnergyManagementSystemActuator> optionalAirOutletTemperatureActuator() const; | ||
| 152 | boost::optional<EnergyManagementSystemActuator> optionalAirOutletHumidityRatioActuator() const; | ||
| 153 | boost::optional<EnergyManagementSystemActuator> optionalAirMassFlowRateActuator() const; | ||
| 154 | boost::optional<EnergyManagementSystemActuator> optionalPlantMinimumMassFlowRateActuator() const; | ||
| 155 | boost::optional<EnergyManagementSystemActuator> optionalPlantMaximumMassFlowRateActuator() const; | ||
| 156 | boost::optional<EnergyManagementSystemActuator> optionalPlantDesignVolumeFlowRateActuator() const; | ||
| 157 | boost::optional<EnergyManagementSystemActuator> optionalPlantOutletTemperatureActuator() const; | ||
| 158 | boost::optional<EnergyManagementSystemActuator> optionalPlantMassFlowRateActuator() const; | ||
| 159 | }; | ||
| 160 | |||
| 161 | } // namespace detail | ||
| 162 | |||
| 163 | } // namespace model | ||
| 164 | } // namespace openstudio | ||
| 165 | |||
| 166 | #endif // MODEL_COILUSERDEFINED_IMPL_HPP | ||
| 167 |