src/model/PlantComponentUserDefined_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_PLANTCOMPONENTUSERDEFINED_IMPL_HPP | ||
| 7 | #define MODEL_PLANTCOMPONENTUSERDEFINED_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject_Impl.hpp" | ||
| 11 | #include "EnergyManagementSystemProgramCallingManager_Impl.hpp" | ||
| 12 | #include "EnergyManagementSystemProgram_Impl.hpp" | ||
| 13 | #include "EnergyManagementSystemActuator_Impl.hpp" | ||
| 14 | #include "StraightComponent_Impl.hpp" | ||
| 15 | #include "ThermalZone_Impl.hpp" | ||
| 16 | |||
| 17 | namespace openstudio { | ||
| 18 | |||
| 19 | namespace model { | ||
| 20 | |||
| 21 | // TODO: Check the following class names against object getters and setters. | ||
| 22 | class EnergyManagementSystemProgramCallingManager; | ||
| 23 | class EnergyManagementSystemProgram; | ||
| 24 | class EnergyManagementSystemActuator; | ||
| 25 | class EnergyManagementSystemMeteredOutputVariable; | ||
| 26 | class Connection; | ||
| 27 | class Node; | ||
| 28 | class ThermalZone; | ||
| 29 | |||
| 30 | namespace detail { | ||
| 31 | |||
| 32 | /** PlantComponentUserDefined_Impl is a StraightComponent_Impl that is the implementation class for PlantComponentUserDefined.*/ | ||
| 33 | class MODEL_API PlantComponentUserDefined_Impl : public StraightComponent_Impl | ||
| 34 | { | ||
| 35 | public: | ||
| 36 | /** @name Constructors and Destructors */ | ||
| 37 | //@{ | ||
| 38 | |||
| 39 | PlantComponentUserDefined_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 40 | |||
| 41 | PlantComponentUserDefined_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 42 | |||
| 43 | PlantComponentUserDefined_Impl(const PlantComponentUserDefined_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 44 | |||
| 45 | 13 | virtual ~PlantComponentUserDefined_Impl() override = default; | |
| 46 | |||
| 47 | //@} | ||
| 48 | /** @name Virtual Methods */ | ||
| 49 | //@{ | ||
| 50 | |||
| 51 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 52 | |||
| 53 | virtual IddObjectType iddObjectType() const override; | ||
| 54 | |||
| 55 | virtual unsigned inletPort() const override; | ||
| 56 | |||
| 57 | virtual unsigned outletPort() const override; | ||
| 58 | |||
| 59 | virtual bool addToNode(Node& node) override; | ||
| 60 | |||
| 61 | virtual ModelObject clone(Model model) const override; | ||
| 62 | |||
| 63 | virtual std::vector<IddObjectType> allowableChildTypes() const override; | ||
| 64 | |||
| 65 | virtual std::vector<ModelObject> children() const override; | ||
| 66 | |||
| 67 | virtual ComponentType componentType() const override; | ||
| 68 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 69 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 70 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 71 | |||
| 72 | //@} | ||
| 73 | /** @name Getters */ | ||
| 74 | //@{ | ||
| 75 | |||
| 76 | std::string plantLoadingMode() const; | ||
| 77 | |||
| 78 | std::string plantLoopFlowRequestMode() const; | ||
| 79 | |||
| 80 | boost::optional<EnergyManagementSystemProgramCallingManager> mainModelProgramCallingManager() const; | ||
| 81 | |||
| 82 | boost::optional<EnergyManagementSystemProgramCallingManager> plantInitializationProgramCallingManager() const; | ||
| 83 | |||
| 84 | boost::optional<EnergyManagementSystemProgramCallingManager> plantSimulationProgramCallingManager() const; | ||
| 85 | |||
| 86 | boost::optional<EnergyManagementSystemProgram> mainModelProgram() const; | ||
| 87 | |||
| 88 | boost::optional<EnergyManagementSystemProgram> plantInitializationProgram() const; | ||
| 89 | |||
| 90 | boost::optional<EnergyManagementSystemProgram> plantSimulationProgram() const; | ||
| 91 | |||
| 92 | boost::optional<ThermalZone> ambientZone() const; | ||
| 93 | |||
| 94 | boost::optional<EnergyManagementSystemActuator> designVolumeFlowRateActuator() const; | ||
| 95 | |||
| 96 | boost::optional<EnergyManagementSystemActuator> minimumMassFlowRateActuator() const; | ||
| 97 | |||
| 98 | boost::optional<EnergyManagementSystemActuator> maximumMassFlowRateActuator() const; | ||
| 99 | |||
| 100 | boost::optional<EnergyManagementSystemActuator> minimumLoadingCapacityActuator() const; | ||
| 101 | |||
| 102 | boost::optional<EnergyManagementSystemActuator> maximumLoadingCapacityActuator() const; | ||
| 103 | |||
| 104 | boost::optional<EnergyManagementSystemActuator> optimalLoadingCapacityActuator() const; | ||
| 105 | |||
| 106 | boost::optional<EnergyManagementSystemActuator> outletTemperatureActuator() const; | ||
| 107 | |||
| 108 | boost::optional<EnergyManagementSystemActuator> massFlowRateActuator() const; | ||
| 109 | |||
| 110 | //@} | ||
| 111 | /** @name Setters */ | ||
| 112 | //@{ | ||
| 113 | |||
| 114 | bool setPlantLoadingMode(const std::string& plantLoadingMode); | ||
| 115 | |||
| 116 | bool setPlantLoopFlowRequestMode(const std::string& plantLoopFlowRequestMode); | ||
| 117 | |||
| 118 | bool setMainModelProgramCallingManager(const EnergyManagementSystemProgramCallingManager& energyManagementSystemProgramCallingManager); | ||
| 119 | |||
| 120 | void resetMainModelProgramCallingManager(); | ||
| 121 | |||
| 122 | bool | ||
| 123 | setPlantInitializationProgramCallingManager(const EnergyManagementSystemProgramCallingManager& energyManagementSystemProgramCallingManager); | ||
| 124 | |||
| 125 | void resetPlantInitializationProgramCallingManager(); | ||
| 126 | |||
| 127 | bool setPlantSimulationProgramCallingManager(const EnergyManagementSystemProgramCallingManager& energyManagementSystemProgramCallingManager); | ||
| 128 | |||
| 129 | void resetPlantSimulationProgramCallingManager(); | ||
| 130 | |||
| 131 | bool setMainModelProgram(const EnergyManagementSystemProgram& energyManagementSystemProgram); | ||
| 132 | |||
| 133 | void resetMainModelProgram(); | ||
| 134 | |||
| 135 | bool setPlantInitializationProgram(const EnergyManagementSystemProgram& energyManagementSystemProgram); | ||
| 136 | |||
| 137 | void resetPlantInitializationProgram(); | ||
| 138 | |||
| 139 | bool setPlantSimulationProgram(const EnergyManagementSystemProgram& energyManagementSystemProgram); | ||
| 140 | |||
| 141 | void resetPlantSimulationProgram(); | ||
| 142 | |||
| 143 | bool setAmbientZone(const ThermalZone& thermalZone); | ||
| 144 | |||
| 145 | void resetAmbientZone(); | ||
| 146 | |||
| 147 | bool setDesignVolumeFlowRateActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator); | ||
| 148 | |||
| 149 | bool setMinimumMassFlowRateActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator); | ||
| 150 | |||
| 151 | bool setMaximumMassFlowRateActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator); | ||
| 152 | |||
| 153 | bool setMinimumLoadingCapacityActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator); | ||
| 154 | |||
| 155 | bool setMaximumLoadingCapacityActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator); | ||
| 156 | |||
| 157 | bool setOptimalLoadingCapacityActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator); | ||
| 158 | |||
| 159 | bool setOutletTemperatureActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator); | ||
| 160 | |||
| 161 | bool setMassFlowRateActuator(const EnergyManagementSystemActuator& energyManagementSystemActuator); | ||
| 162 | |||
| 163 | EnergyManagementSystemProgram | ||
| 164 | createInitProgram(const EnergyManagementSystemActuator& dvfrActuator, const EnergyManagementSystemActuator& mmfrActuator, | ||
| 165 | const EnergyManagementSystemActuator& mxfrActuator, const EnergyManagementSystemActuator& mlcActuator, | ||
| 166 | const EnergyManagementSystemActuator& mxlcActuator, const EnergyManagementSystemActuator& olcActuator, const Model& model); | ||
| 167 | |||
| 168 | EnergyManagementSystemProgram createSimProgram(const EnergyManagementSystemActuator& otActuator, | ||
| 169 | const EnergyManagementSystemActuator& mfrActuator, const Model& model); | ||
| 170 | |||
| 171 | //@} | ||
| 172 | /** @name Other */ | ||
| 173 | //@{ | ||
| 174 | |||
| 175 | // Will look into the MainModelProgram and the PlantSimulationProgram 's linked EMS Metered Output Variables | ||
| 176 | std::vector<EnergyManagementSystemMeteredOutputVariable> energyManagementSystemMeteredOutputVariables() const; | ||
| 177 | |||
| 178 | //@} | ||
| 179 | protected: | ||
| 180 | private: | ||
| 181 | REGISTER_LOGGER("openstudio.model.PlantComponentUserDefined"); | ||
| 182 | |||
| 183 | boost::optional<Connection> optionalInletNode() const; | ||
| 184 | boost::optional<Connection> optionalOutletNode() const; | ||
| 185 | }; | ||
| 186 | |||
| 187 | } // namespace detail | ||
| 188 | |||
| 189 | } // namespace model | ||
| 190 | } // namespace openstudio | ||
| 191 | |||
| 192 | #endif // MODEL_PLANTCOMPONENTUSERDEFINED_IMPL_HPP | ||
| 193 |