src/model/SurfacePropertyGroundSurfaces_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_SURFACEPROPERTYGROUNDSURFACES_IMPL_HPP | ||
| 7 | #define MODEL_SURFACEPROPERTYGROUNDSURFACES_IMPL_HPP | ||
| 8 | |||
| 9 | #include <model/ModelAPI.hpp> | ||
| 10 | #include "ModelObject_Impl.hpp" | ||
| 11 | #include "Schedule.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class GroundSurfaceGroup; | ||
| 17 | class SurfacePropertyLocalEnvironment; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | /** SurfacePropertyGroundSurfaces_Impl is a ModelObject_Impl that is the implementation class for SurfacePropertyGroundSurfaces.*/ | ||
| 22 | class MODEL_API SurfacePropertyGroundSurfaces_Impl : public ModelObject_Impl | ||
| 23 | { | ||
| 24 | public: | ||
| 25 | /** @name Constructors and Destructors */ | ||
| 26 | //@{ | ||
| 27 | |||
| 28 | SurfacePropertyGroundSurfaces_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 29 | |||
| 30 | SurfacePropertyGroundSurfaces_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | SurfacePropertyGroundSurfaces_Impl(const SurfacePropertyGroundSurfaces_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | 6 | virtual ~SurfacePropertyGroundSurfaces_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 | //@} | ||
| 47 | /** @name Getters */ | ||
| 48 | //@{ | ||
| 49 | |||
| 50 | //@} | ||
| 51 | /** @name Setters */ | ||
| 52 | //@{ | ||
| 53 | |||
| 54 | //@} | ||
| 55 | /** @name Other */ | ||
| 56 | //@{ | ||
| 57 | |||
| 58 | boost::optional<SurfacePropertyLocalEnvironment> surfacePropertyLocalEnvironment() const; | ||
| 59 | |||
| 60 | std::vector<GroundSurfaceGroup> groundSurfaceGroups() const; | ||
| 61 | |||
| 62 | unsigned int numberofGroundSurfaceGroups() const; | ||
| 63 | |||
| 64 | /** Looks up by Surface Name (case-insensitive) */ | ||
| 65 | boost::optional<unsigned> groundSurfaceGroupIndex(const GroundSurfaceGroup& groundSurfaceGroup) const; | ||
| 66 | boost::optional<unsigned> groundSurfaceGroupIndex(const std::string& groundSurfaceName) const; | ||
| 67 | |||
| 68 | boost::optional<GroundSurfaceGroup> getGroundSurfaceGroup(unsigned groupIndex) const; | ||
| 69 | |||
| 70 | /** If a groundSurfaceGroup group is already present (cf `groundSurfaceGroupIndex()`), it will Warn and override the groundSurfaceGroup value */ | ||
| 71 | bool addGroundSurfaceGroup(const GroundSurfaceGroup& groundSurfaceGroup); | ||
| 72 | |||
| 73 | // Overloads, it creates a GroundSurfaceGroup wrapper, then call `addGroundSurfaceGroup(const GroundSurfaceGroup& groundSurfaceGroup)` | ||
| 74 | bool addGroundSurfaceGroup(const std::string& groundSurfaceName, double viewFactor, boost::optional<Schedule> temperatureSchedule = boost::none, | ||
| 75 | boost::optional<Schedule> reflectanceSchedule = boost::none); | ||
| 76 | |||
| 77 | bool addGroundSurfaceGroups(const std::vector<GroundSurfaceGroup>& groundSurfaceGroups); | ||
| 78 | |||
| 79 | bool removeGroundSurfaceGroup(unsigned groupIndex); | ||
| 80 | |||
| 81 | void removeAllGroundSurfaceGroups(); | ||
| 82 | |||
| 83 | //@} | ||
| 84 | protected: | ||
| 85 | private: | ||
| 86 | − | REGISTER_LOGGER("openstudio.model.SurfacePropertyGroundSurfaces"); | |
| 87 | }; | ||
| 88 | |||
| 89 | } // namespace detail | ||
| 90 | |||
| 91 | } // namespace model | ||
| 92 | } // namespace openstudio | ||
| 93 | |||
| 94 | #endif // MODEL_SURFACEPROPERTYGROUNDSURFACES_IMPL_HPP | ||
| 95 |