src/model/InteriorPartitionSurfaceGroup_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_INTERIORPARTITIONSURFACEGROUP_IMPL_HPP | ||
| 7 | #define MODEL_INTERIORPARTITIONSURFACEGROUP_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "PlanarSurfaceGroup_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | class Transformation; | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class Space; | ||
| 19 | class InteriorPartitionSurface; | ||
| 20 | class InteriorPartitionSurfaceGroup; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | /** InteriorPartitionSurfaceGroup_Impl is a PlanarSurfaceGroup_Impl that is the implementation class for InteriorPartitionSurfaceGroup.*/ | ||
| 25 | class MODEL_API InteriorPartitionSurfaceGroup_Impl : public PlanarSurfaceGroup_Impl | ||
| 26 | { | ||
| 27 | |||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | InteriorPartitionSurfaceGroup_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | InteriorPartitionSurfaceGroup_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 35 | |||
| 36 | InteriorPartitionSurfaceGroup_Impl(const InteriorPartitionSurfaceGroup_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 37 | |||
| 38 | 302 | virtual ~InteriorPartitionSurfaceGroup_Impl() override = default; | |
| 39 | |||
| 40 | //@} | ||
| 41 | |||
| 42 | // return the parent object in the hierarchy | ||
| 43 | virtual boost::optional<ParentObject> parent() const override; | ||
| 44 | |||
| 45 | // set the parent, child may have to call methods on the parent | ||
| 46 | virtual bool setParent(ParentObject& newParent) override; | ||
| 47 | |||
| 48 | // return any children objects in the hierarchy | ||
| 49 | virtual std::vector<ModelObject> children() const override; | ||
| 50 | |||
| 51 | /// get a vector of allowable children types | ||
| 52 | virtual std::vector<IddObjectType> allowableChildTypes() const override; | ||
| 53 | |||
| 54 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 55 | |||
| 56 | virtual IddObjectType iddObjectType() const override; | ||
| 57 | |||
| 58 | virtual openstudio::Transformation buildingTransformation() const override; | ||
| 59 | |||
| 60 | virtual bool changeTransformation(const openstudio::Transformation& transformation) override; | ||
| 61 | |||
| 62 | virtual openstudio::BoundingBox boundingBox() const override; | ||
| 63 | |||
| 64 | /** @name Getters */ | ||
| 65 | //@{ | ||
| 66 | |||
| 67 | // TODO: Handle Non-Extensible IddField Space Name. | ||
| 68 | |||
| 69 | virtual double directionofRelativeNorth() const override; | ||
| 70 | |||
| 71 | virtual bool isDirectionofRelativeNorthDefaulted() const override; | ||
| 72 | |||
| 73 | virtual double xOrigin() const override; | ||
| 74 | |||
| 75 | virtual bool isXOriginDefaulted() const override; | ||
| 76 | |||
| 77 | virtual double yOrigin() const override; | ||
| 78 | |||
| 79 | virtual bool isYOriginDefaulted() const override; | ||
| 80 | |||
| 81 | virtual double zOrigin() const override; | ||
| 82 | |||
| 83 | virtual bool isZOriginDefaulted() const override; | ||
| 84 | |||
| 85 | int multiplier() const; | ||
| 86 | |||
| 87 | bool isMultiplierDefaulted() const; | ||
| 88 | |||
| 89 | //@} | ||
| 90 | /** @name Setters */ | ||
| 91 | //@{ | ||
| 92 | |||
| 93 | virtual bool setDirectionofRelativeNorth(double directionofRelativeNorth, bool driverMethod = true) override; | ||
| 94 | |||
| 95 | virtual void resetDirectionofRelativeNorth() override; | ||
| 96 | |||
| 97 | virtual bool setXOrigin(double xOrigin, bool driverMethod = true) override; | ||
| 98 | |||
| 99 | virtual void resetXOrigin() override; | ||
| 100 | |||
| 101 | virtual bool setYOrigin(double yOrigin, bool driverMethod = true) override; | ||
| 102 | |||
| 103 | virtual void resetYOrigin() override; | ||
| 104 | |||
| 105 | virtual bool setZOrigin(double zOrigin, bool driverMethod = true) override; | ||
| 106 | |||
| 107 | virtual void resetZOrigin() override; | ||
| 108 | |||
| 109 | bool setMultiplier(int multiplier); | ||
| 110 | |||
| 111 | void resetMultiplier(); | ||
| 112 | |||
| 113 | //@} | ||
| 114 | |||
| 115 | /// Returns the parent Space. | ||
| 116 | boost::optional<Space> space() const; | ||
| 117 | |||
| 118 | /// Sets the parent Space. | ||
| 119 | bool setSpace(const Space& space); | ||
| 120 | |||
| 121 | void resetSpace(); | ||
| 122 | |||
| 123 | /// Returns all \link InteriorPartitionSurface InteriorPartitionSurfaces \endlink in this group. | ||
| 124 | std::vector<InteriorPartitionSurface> interiorPartitionSurfaces() const; | ||
| 125 | |||
| 126 | protected: | ||
| 127 | private: | ||
| 128 | − | REGISTER_LOGGER("openstudio.model.InteriorPartitionSurfaceGroup"); | |
| 129 | |||
| 130 | boost::optional<ModelObject> spaceAsModelObject() const; | ||
| 131 | std::vector<ModelObject> interiorPartitionSurfacesAsModelObjects() const; | ||
| 132 | |||
| 133 | bool setSpaceAsModelObject(const boost::optional<ModelObject>& modelObject); | ||
| 134 | }; | ||
| 135 | |||
| 136 | } // namespace detail | ||
| 137 | |||
| 138 | } // namespace model | ||
| 139 | } // namespace openstudio | ||
| 140 | |||
| 141 | #endif // MODEL_INTERIORPARTITIONSURFACEGROUP_IMPL_HPP | ||
| 142 |