src/model/SwimmingPoolIndoor_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_SWIMMINGPOOLINDOOR_IMPL_HPP | ||
| 7 | #define MODEL_SWIMMINGPOOLINDOOR_IMPL_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "StraightComponent_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Surface; | ||
| 16 | class Schedule; | ||
| 17 | class Node; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | /** SwimmingPoolIndoor_Impl is a StraightComponent_Impl that is the implementation class for SwimmingPoolIndoor.*/ | ||
| 22 | class MODEL_API SwimmingPoolIndoor_Impl : public StraightComponent_Impl | ||
| 23 | { | ||
| 24 | public: | ||
| 25 | /** @name Constructors and Destructors */ | ||
| 26 | //@{ | ||
| 27 | |||
| 28 | SwimmingPoolIndoor_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | SwimmingPoolIndoor_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | SwimmingPoolIndoor_Impl(const SwimmingPoolIndoor_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | 8 | virtual ~SwimmingPoolIndoor_Impl() override = default; | |
| 35 | |||
| 36 | //@} | ||
| 37 | /** @name Virtual Methods */ | ||
| 38 | //@{ | ||
| 39 | |||
| 40 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 41 | |||
| 42 | virtual IddObjectType iddObjectType() const override; | ||
| 43 | |||
| 44 | virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override; | ||
| 45 | |||
| 46 | virtual unsigned inletPort() const override; | ||
| 47 | |||
| 48 | virtual unsigned outletPort() const override; | ||
| 49 | |||
| 50 | virtual bool addToNode(Node& node) override; | ||
| 51 | |||
| 52 | virtual ComponentType componentType() const override; | ||
| 53 | virtual std::vector<FuelType> coolingFuelTypes() const override; | ||
| 54 | virtual std::vector<FuelType> heatingFuelTypes() const override; | ||
| 55 | virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override; | ||
| 56 | |||
| 57 | //@} | ||
| 58 | /** @name Getters */ | ||
| 59 | //@{ | ||
| 60 | |||
| 61 | Surface surface() const; | ||
| 62 | |||
| 63 | double averageDepth() const; | ||
| 64 | |||
| 65 | Schedule activityFactorSchedule() const; | ||
| 66 | |||
| 67 | Schedule makeupWaterSupplySchedule() const; | ||
| 68 | |||
| 69 | Schedule coverSchedule() const; | ||
| 70 | |||
| 71 | double coverEvaporationFactor() const; | ||
| 72 | |||
| 73 | double coverConvectionFactor() const; | ||
| 74 | |||
| 75 | double coverShortWavelengthRadiationFactor() const; | ||
| 76 | |||
| 77 | double coverLongWavelengthRadiationFactor() const; | ||
| 78 | |||
| 79 | double poolHeatingSystemMaximumWaterFlowRate() const; | ||
| 80 | |||
| 81 | double poolMiscellaneousEquipmentPower() const; | ||
| 82 | |||
| 83 | Schedule setpointTemperatureSchedule() const; | ||
| 84 | |||
| 85 | double maximumNumberofPeople() const; | ||
| 86 | |||
| 87 | Schedule peopleSchedule() const; | ||
| 88 | |||
| 89 | Schedule peopleHeatGainSchedule() const; | ||
| 90 | |||
| 91 | //@} | ||
| 92 | /** @name Setters */ | ||
| 93 | //@{ | ||
| 94 | |||
| 95 | bool setSurface(const Surface& floorSurface); | ||
| 96 | |||
| 97 | bool setAverageDepth(double averageDepth); | ||
| 98 | |||
| 99 | bool setActivityFactorSchedule(Schedule& schedule); | ||
| 100 | |||
| 101 | bool setMakeupWaterSupplySchedule(Schedule& schedule); | ||
| 102 | |||
| 103 | bool setCoverSchedule(Schedule& schedule); | ||
| 104 | |||
| 105 | bool setCoverEvaporationFactor(double coverEvaporationFactor); | ||
| 106 | |||
| 107 | bool setCoverConvectionFactor(double coverConvectionFactor); | ||
| 108 | |||
| 109 | bool setCoverShortWavelengthRadiationFactor(double coverShortWavelengthRadiationFactor); | ||
| 110 | |||
| 111 | bool setCoverLongWavelengthRadiationFactor(double coverLongWavelengthRadiationFactor); | ||
| 112 | |||
| 113 | bool setPoolWaterInletNode(const Connection& connection); | ||
| 114 | |||
| 115 | bool setPoolWaterOutletNode(const Connection& connection); | ||
| 116 | |||
| 117 | bool setPoolHeatingSystemMaximumWaterFlowRate(double poolHeatingSystemMaximumWaterFlowRate); | ||
| 118 | |||
| 119 | bool setPoolMiscellaneousEquipmentPower(double poolMiscellaneousEquipmentPower); | ||
| 120 | |||
| 121 | bool setSetpointTemperatureSchedule(Schedule& schedule); | ||
| 122 | |||
| 123 | bool setMaximumNumberofPeople(double maximumNumberofPeople); | ||
| 124 | |||
| 125 | bool setPeopleSchedule(Schedule& schedule); | ||
| 126 | |||
| 127 | bool setPeopleHeatGainSchedule(Schedule& schedule); | ||
| 128 | |||
| 129 | //@} | ||
| 130 | /** @name Other */ | ||
| 131 | //@{ | ||
| 132 | |||
| 133 | // Convenience function to return the inletNode of the Pool object | ||
| 134 | boost::optional<Node> poolWaterInletNode() const; | ||
| 135 | |||
| 136 | // Convenience function to return the Outlet Node of the Pool object | ||
| 137 | boost::optional<Node> poolWaterOutletNode() const; | ||
| 138 | |||
| 139 | //@} | ||
| 140 | protected: | ||
| 141 | private: | ||
| 142 | − | REGISTER_LOGGER("openstudio.model.SwimmingPoolIndoor"); | |
| 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<Surface> optionalSurface() const; | ||
| 148 | boost::optional<Schedule> optionalActivityFactorSchedule() const; | ||
| 149 | boost::optional<Schedule> optionalMakeupWaterSupplySchedule() const; | ||
| 150 | boost::optional<Schedule> optionalCoverSchedule() const; | ||
| 151 | boost::optional<Schedule> optionalSetpointTemperatureSchedule() const; | ||
| 152 | boost::optional<Schedule> optionalPeopleSchedule() const; | ||
| 153 | boost::optional<Schedule> optionalPeopleHeatGainSchedule() const; | ||
| 154 | }; | ||
| 155 | |||
| 156 | } // namespace detail | ||
| 157 | |||
| 158 | } // namespace model | ||
| 159 | } // namespace openstudio | ||
| 160 | |||
| 161 | #endif // MODEL_SWIMMINGPOOLINDOOR_IMPL_HPP | ||
| 162 |