src/model/ControllerWaterCoil_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_CONTROLLERWATERCOIL_IMPL_HPP | ||
| 7 | #define MODEL_CONTROLLERWATERCOIL_IMPL_HPP | ||
| 8 | |||
| 9 | #include "HVACComponent_Impl.hpp" | ||
| 10 | |||
| 11 | namespace openstudio { | ||
| 12 | namespace model { | ||
| 13 | |||
| 14 | class Node; | ||
| 15 | |||
| 16 | namespace detail { | ||
| 17 | |||
| 18 | /** ControllerWaterCoil_Impl is a HVACComponent_Impl that is the implementation class for ControllerWaterCoil.*/ | ||
| 19 | class MODEL_API ControllerWaterCoil_Impl : public HVACComponent_Impl | ||
| 20 | { | ||
| 21 | |||
| 22 | public: | ||
| 23 | /** @name Constructors and Destructors */ | ||
| 24 | //@{ | ||
| 25 | |||
| 26 | ControllerWaterCoil_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 27 | |||
| 28 | ControllerWaterCoil_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | ControllerWaterCoil_Impl(const ControllerWaterCoil_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | 97 | virtual ~ControllerWaterCoil_Impl() override = default; | |
| 33 | |||
| 34 | //@} | ||
| 35 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 36 | |||
| 37 | virtual IddObjectType iddObjectType() const override; | ||
| 38 | |||
| 39 | virtual void autosize() override; | ||
| 40 | |||
| 41 | virtual void applySizingValues() override; | ||
| 42 | |||
| 43 | virtual ComponentType componentType() const override; | ||
| 44 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 45 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 46 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 47 | |||
| 48 | //@} | ||
| 49 | /** @name Getters */ | ||
| 50 | //@{ | ||
| 51 | |||
| 52 | boost::optional<HVACComponent> waterCoil() const; | ||
| 53 | |||
| 54 | std::string controlVariable() const; | ||
| 55 | bool isControlVariableDefaulted() const; | ||
| 56 | |||
| 57 | boost::optional<std::string> action() const; | ||
| 58 | |||
| 59 | std::string actuatorVariable() const; | ||
| 60 | bool isActuatorVariableDefaulted() const; | ||
| 61 | |||
| 62 | boost::optional<Node> sensorNode() const; | ||
| 63 | |||
| 64 | boost::optional<Node> actuatorNode() const; | ||
| 65 | |||
| 66 | boost::optional<double> controllerConvergenceTolerance() const; | ||
| 67 | |||
| 68 | bool isControllerConvergenceToleranceDefaulted() const; | ||
| 69 | |||
| 70 | bool isControllerConvergenceToleranceAutosized() const; | ||
| 71 | |||
| 72 | boost::optional<double> maximumActuatedFlow() const; | ||
| 73 | |||
| 74 | bool isMaximumActuatedFlowAutosized() const; | ||
| 75 | |||
| 76 | double minimumActuatedFlow() const; | ||
| 77 | |||
| 78 | bool isMinimumActuatedFlowDefaulted() const; | ||
| 79 | |||
| 80 | //@} | ||
| 81 | /** @name Setters */ | ||
| 82 | //@{ | ||
| 83 | |||
| 84 | bool setWaterCoil(const HVACComponent& comp); | ||
| 85 | |||
| 86 | bool setControlVariable(const std::string& controlVariable); | ||
| 87 | |||
| 88 | void resetControlVariable(); | ||
| 89 | |||
| 90 | bool setAction(const std::string& action); | ||
| 91 | |||
| 92 | void resetAction(); | ||
| 93 | |||
| 94 | bool setActuatorVariable(const std::string& actuatorVariable); | ||
| 95 | |||
| 96 | void resetActuatorVariable(); | ||
| 97 | |||
| 98 | bool setSensorNode(const Node& node); | ||
| 99 | |||
| 100 | bool setActuatorNode(const Node& node); | ||
| 101 | |||
| 102 | bool setControllerConvergenceTolerance(double controllerConvergenceTolerance); | ||
| 103 | |||
| 104 | void resetControllerConvergenceTolerance(); | ||
| 105 | |||
| 106 | void autosizeControllerConvergenceTolerance(); | ||
| 107 | |||
| 108 | bool setMaximumActuatedFlow(double maximumActuatedFlow); | ||
| 109 | |||
| 110 | void resetMaximumActuatedFlow(); | ||
| 111 | |||
| 112 | void autosizeMaximumActuatedFlow(); | ||
| 113 | |||
| 114 | bool setMinimumActuatedFlow(double minimumActuatedFlow); | ||
| 115 | |||
| 116 | void resetMinimumActuatedFlow(); | ||
| 117 | |||
| 118 | //@} | ||
| 119 | /** @name Other */ | ||
| 120 | //@{ | ||
| 121 | |||
| 122 | boost::optional<double> autosizedControllerConvergenceTolerance() const; | ||
| 123 | |||
| 124 | boost::optional<double> autosizedMaximumActuatedFlow() const; | ||
| 125 | |||
| 126 | //@} | ||
| 127 | |||
| 128 | protected: | ||
| 129 | private: | ||
| 130 | REGISTER_LOGGER("openstudio.model.ControllerWaterCoil"); | ||
| 131 | }; | ||
| 132 | |||
| 133 | } // namespace detail | ||
| 134 | |||
| 135 | } // namespace model | ||
| 136 | |||
| 137 | } // namespace openstudio | ||
| 138 | |||
| 139 | #endif // MODEL_CONTROLLERWATERCOIL_IMPL_HPP | ||
| 140 |