src/model/InteriorPartitionSurface_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_INTERIORPARTITIONSURFACE_IMPL_HPP | ||
| 7 | #define MODEL_INTERIORPARTITIONSURFACE_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "PlanarSurface_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class InteriorPartitionSurfaceGroup; | ||
| 16 | class InteriorPartitionSurface; | ||
| 17 | class DaylightingDeviceShelf; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | /** InteriorPartitionSurface_Impl is a PlanarSurface_Impl that is the implementation class for InteriorPartitionSurface.*/ | ||
| 22 | class MODEL_API InteriorPartitionSurface_Impl : public PlanarSurface_Impl | ||
| 23 | { | ||
| 24 | |||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | InteriorPartitionSurface_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | InteriorPartitionSurface_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | InteriorPartitionSurface_Impl(const InteriorPartitionSurface_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | 314 | virtual ~InteriorPartitionSurface_Impl() override = default; | |
| 36 | |||
| 37 | //@} | ||
| 38 | |||
| 39 | // return the parent object in the hierarchy | ||
| 40 | virtual boost::optional<ParentObject> parent() const override; | ||
| 41 | |||
| 42 | // return any children objects in the hierarchy | ||
| 43 | virtual std::vector<ModelObject> children() const override; | ||
| 44 | |||
| 45 | /// set the parent, child may have to call methods on the parent | ||
| 46 | bool setParent(ParentObject& newParent) override; | ||
| 47 | |||
| 48 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 49 | |||
| 50 | virtual IddObjectType iddObjectType() const override; | ||
| 51 | |||
| 52 | /// should subtract this surface from parent's gross area for net area | ||
| 53 | virtual bool subtractFromGrossArea() const override; | ||
| 54 | |||
| 55 | /// get the construction object and search distance | ||
| 56 | virtual boost::optional<std::pair<ConstructionBase, int>> constructionWithSearchDistance() const override; | ||
| 57 | |||
| 58 | /// Returns true if the construction is not directly referenced by this surface . | ||
| 59 | virtual bool isConstructionDefaulted() const override; | ||
| 60 | |||
| 61 | /// set the construction object | ||
| 62 | virtual bool setConstruction(const ConstructionBase& construction) override; | ||
| 63 | |||
| 64 | /// Resets the construction object. | ||
| 65 | virtual void resetConstruction() override; | ||
| 66 | |||
| 67 | /// Returns the containing PlanarSurfaceGroup if available. | ||
| 68 | virtual boost::optional<PlanarSurfaceGroup> planarSurfaceGroup() const override; | ||
| 69 | |||
| 70 | /// Returns the containing Space if available. | ||
| 71 | virtual boost::optional<Space> space() const override; | ||
| 72 | |||
| 73 | /** @name Getters */ | ||
| 74 | //@{ | ||
| 75 | |||
| 76 | bool converttoInternalMass() const; | ||
| 77 | |||
| 78 | bool isConverttoInternalMassDefaulted() const; | ||
| 79 | |||
| 80 | boost::optional<double> surfaceArea() const; | ||
| 81 | |||
| 82 | boost::optional<double> numberofVertices() const; | ||
| 83 | |||
| 84 | bool isNumberofVerticesDefaulted() const; | ||
| 85 | |||
| 86 | bool isNumberofVerticesAutocalculated() const; | ||
| 87 | |||
| 88 | // TODO: Handle this object's extensible fields. | ||
| 89 | |||
| 90 | //@} | ||
| 91 | /** @name Setters */ | ||
| 92 | //@{ | ||
| 93 | |||
| 94 | bool setConverttoInternalMass(bool converttoInternalMass); | ||
| 95 | |||
| 96 | void resetConverttoInternalMass(); | ||
| 97 | |||
| 98 | bool setSurfaceArea(boost::optional<double> surfaceArea); | ||
| 99 | |||
| 100 | bool setSurfaceArea(double surfaceArea); | ||
| 101 | |||
| 102 | void resetSurfaceArea(); | ||
| 103 | |||
| 104 | bool setNumberofVertices(boost::optional<double> numberofVertices); | ||
| 105 | |||
| 106 | bool setNumberofVertices(double numberofVertices); | ||
| 107 | |||
| 108 | void resetNumberofVertices(); | ||
| 109 | |||
| 110 | void autocalculateNumberofVertices(); | ||
| 111 | |||
| 112 | // TODO: Handle this object's extensible fields. | ||
| 113 | |||
| 114 | //@} | ||
| 115 | |||
| 116 | /// get the interior partition surface group | ||
| 117 | boost::optional<InteriorPartitionSurfaceGroup> interiorPartitionSurfaceGroup() const; | ||
| 118 | |||
| 119 | /// set the interior partition surface group | ||
| 120 | bool setInteriorPartitionSurfaceGroup(const InteriorPartitionSurfaceGroup& interiorPartitionSurfaceGroup); | ||
| 121 | |||
| 122 | void resetInteriorPartitionSurfaceGroup(); | ||
| 123 | |||
| 124 | boost::optional<DaylightingDeviceShelf> daylightingDeviceShelf() const; | ||
| 125 | |||
| 126 | protected: | ||
| 127 | private: | ||
| 128 | − | REGISTER_LOGGER("openstudio.model.InteriorPartitionSurface"); | |
| 129 | |||
| 130 | boost::optional<ModelObject> interiorPartitionSurfaceGroupAsModelObject() const; | ||
| 131 | |||
| 132 | bool setInteriorPartitionSurfaceGroupAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 133 | }; | ||
| 134 | |||
| 135 | } // namespace detail | ||
| 136 | |||
| 137 | } // namespace model | ||
| 138 | } // namespace openstudio | ||
| 139 | |||
| 140 | #endif // MODEL_INTERIORPARTITIONSURFACE_IMPL_HPP | ||
| 141 |