src/model/SurfacePropertyExposedFoundationPerimeter.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_SURFACEPROPERTYEXPOSEDFOUNDATIONPERIMETER_HPP | ||
| 7 | #define MODEL_SURFACEPROPERTYEXPOSEDFOUNDATIONPERIMETER_HPP | ||
| 8 | |||
| 9 | #include <vector> | ||
| 10 | #include "ModelAPI.hpp" | ||
| 11 | #include "ModelObject.hpp" | ||
| 12 | #include "../utilities/core/Deprecated.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | namespace model { | ||
| 16 | |||
| 17 | class Surface; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class SurfacePropertyExposedFoundationPerimeter_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** SurfacePropertyExposedFoundationPerimeter is a ModelObject that wraps the OpenStudio IDD object 'OS:SurfaceProperty:ExposedFoundationPerimeter'. */ | ||
| 26 | class MODEL_API SurfacePropertyExposedFoundationPerimeter : public ModelObject | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit SurfacePropertyExposedFoundationPerimeter(Surface& surface, std::string exposedPerimeterCalculationMethod, double exposedPerimeter); | ||
| 33 | |||
| 34 | 71 | virtual ~SurfacePropertyExposedFoundationPerimeter() override = default; | |
| 35 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 36 | 19 | SurfacePropertyExposedFoundationPerimeter(const SurfacePropertyExposedFoundationPerimeter& other) = default; | |
| 37 | 27 | SurfacePropertyExposedFoundationPerimeter(SurfacePropertyExposedFoundationPerimeter&& other) = default; | |
| 38 | ✗ | SurfacePropertyExposedFoundationPerimeter& operator=(const SurfacePropertyExposedFoundationPerimeter&) = default; | |
| 39 | ✗ | SurfacePropertyExposedFoundationPerimeter& operator=(SurfacePropertyExposedFoundationPerimeter&&) = default; | |
| 40 | |||
| 41 | //@} | ||
| 42 | |||
| 43 | static IddObjectType iddObjectType(); | ||
| 44 | |||
| 45 | /** @name Getters */ | ||
| 46 | //@{ | ||
| 47 | |||
| 48 | OS_DEPRECATED(3, 7, 0) std::string surfaceName() const; | ||
| 49 | |||
| 50 | Surface surface() const; | ||
| 51 | |||
| 52 | std::string exposedPerimeterCalculationMethod() const; | ||
| 53 | |||
| 54 | boost::optional<double> totalExposedPerimeter(); | ||
| 55 | |||
| 56 | double exposedPerimeterFraction() const; | ||
| 57 | |||
| 58 | bool isExposedPerimeterFractionDefaulted() const; | ||
| 59 | |||
| 60 | //@} | ||
| 61 | /** @name Setters */ | ||
| 62 | //@{ | ||
| 63 | |||
| 64 | bool setExposedPerimeterCalculationMethod(const std::string& exposedPerimeterCalculationMethod); | ||
| 65 | |||
| 66 | bool setTotalExposedPerimeter(double totalExposedPerimeter); | ||
| 67 | |||
| 68 | bool setExposedPerimeterFraction(double exposedPerimeterFraction); | ||
| 69 | |||
| 70 | void resetExposedPerimeterFraction(); | ||
| 71 | |||
| 72 | //@} | ||
| 73 | /** @name Other */ | ||
| 74 | //@{ | ||
| 75 | |||
| 76 | //@} | ||
| 77 | protected: | ||
| 78 | /// @cond | ||
| 79 | using ImplType = detail::SurfacePropertyExposedFoundationPerimeter_Impl; | ||
| 80 | |||
| 81 | explicit SurfacePropertyExposedFoundationPerimeter(std::shared_ptr<detail::SurfacePropertyExposedFoundationPerimeter_Impl> impl); | ||
| 82 | |||
| 83 | friend class detail::SurfacePropertyExposedFoundationPerimeter_Impl; | ||
| 84 | friend class Model; | ||
| 85 | friend class IdfObject; | ||
| 86 | friend class openstudio::detail::IdfObject_Impl; | ||
| 87 | /// @endcond | ||
| 88 | private: | ||
| 89 | − | REGISTER_LOGGER("openstudio.model.SurfacePropertyExposedFoundationPerimeter"); | |
| 90 | }; | ||
| 91 | |||
| 92 | /** \relates SurfacePropertyExposedFoundationPerimeter*/ | ||
| 93 | using OptionalSurfacePropertyExposedFoundationPerimeter = boost::optional<SurfacePropertyExposedFoundationPerimeter>; | ||
| 94 | |||
| 95 | /** \relates SurfacePropertyExposedFoundationPerimeter*/ | ||
| 96 | using SurfacePropertyExposedFoundationPerimeterVector = std::vector<SurfacePropertyExposedFoundationPerimeter>; | ||
| 97 | |||
| 98 | } // namespace model | ||
| 99 | } // namespace openstudio | ||
| 100 | |||
| 101 | #endif // MODEL_SURFACEPROPERTYEXPOSEDFOUNDATIONPERIMETER_HPP | ||
| 102 |