src/model/BuildingStory_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_BUILDINGSTORY_IMPL_HPP | ||
| 7 | #define MODEL_BUILDINGSTORY_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelObject_Impl.hpp" | ||
| 10 | |||
| 11 | namespace openstudio { | ||
| 12 | |||
| 13 | class BoundingBox; | ||
| 14 | |||
| 15 | namespace model { | ||
| 16 | |||
| 17 | class SpaceType; | ||
| 18 | class DefaultConstructionSet; | ||
| 19 | class DefaultScheduleSet; | ||
| 20 | class DefaultScheduleType; | ||
| 21 | class Space; | ||
| 22 | class RenderingColor; | ||
| 23 | class BuildingStory; | ||
| 24 | |||
| 25 | namespace detail { | ||
| 26 | |||
| 27 | /** BuildingStory_Impl is a ModelObject_Impl that is the implementation class for BuildingStory.*/ | ||
| 28 | class MODEL_API BuildingStory_Impl : public ModelObject_Impl | ||
| 29 | { | ||
| 30 | |||
| 31 | public: | ||
| 32 | /** @name Constructors and Destructors */ | ||
| 33 | //@{ | ||
| 34 | |||
| 35 | BuildingStory_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 36 | |||
| 37 | BuildingStory_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 38 | |||
| 39 | BuildingStory_Impl(const BuildingStory_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 40 | |||
| 41 | 1007 | virtual ~BuildingStory_Impl() override = default; | |
| 42 | |||
| 43 | //@} | ||
| 44 | |||
| 45 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 46 | |||
| 47 | virtual IddObjectType iddObjectType() const override; | ||
| 48 | |||
| 49 | /** @name Getters */ | ||
| 50 | //@{ | ||
| 51 | |||
| 52 | boost::optional<double> nominalZCoordinate() const; | ||
| 53 | |||
| 54 | boost::optional<double> nominalFloortoFloorHeight() const; | ||
| 55 | |||
| 56 | boost::optional<double> nominalFloortoCeilingHeight() const; | ||
| 57 | |||
| 58 | openstudio::BoundingBox boundingBoxBuildingCoordinates() const; | ||
| 59 | |||
| 60 | openstudio::BoundingBox boundingBoxSiteCoordinates() const; | ||
| 61 | |||
| 62 | //@} | ||
| 63 | /** @name Setters */ | ||
| 64 | //@{ | ||
| 65 | |||
| 66 | bool setNominalZCoordinate(double nominalZCoordinate); | ||
| 67 | void resetNominalZCoordinate(); | ||
| 68 | |||
| 69 | bool setNominalFloortoFloorHeight(double nominalFloortoFloorHeight); | ||
| 70 | void resetNominalFloortoFloorHeight(); | ||
| 71 | |||
| 72 | bool setNominalFloortoCeilingHeight(double nominalFloortoCeilingHeight); | ||
| 73 | void resetNominalFloortoCeilingHeight(); | ||
| 74 | |||
| 75 | //@} | ||
| 76 | |||
| 77 | /// Gets all spaces on this building story. | ||
| 78 | std::vector<Space> spaces() const; | ||
| 79 | |||
| 80 | /// Returns the default construction set that this space references directly. | ||
| 81 | boost::optional<DefaultConstructionSet> defaultConstructionSet() const; | ||
| 82 | |||
| 83 | /// Sets the default construction set for this space directly. | ||
| 84 | bool setDefaultConstructionSet(const DefaultConstructionSet& defaultConstructionSet); | ||
| 85 | |||
| 86 | /// Resets the default construction set for this space. | ||
| 87 | void resetDefaultConstructionSet(); | ||
| 88 | |||
| 89 | /// Returns the default schedule set that this space references directly. | ||
| 90 | boost::optional<DefaultScheduleSet> defaultScheduleSet() const; | ||
| 91 | |||
| 92 | /// Sets the default schedule set for this space directly. | ||
| 93 | bool setDefaultScheduleSet(const DefaultScheduleSet& defaultScheduleSet); | ||
| 94 | |||
| 95 | /// Resets the default schedule set for this space. | ||
| 96 | void resetDefaultScheduleSet(); | ||
| 97 | |||
| 98 | boost::optional<Schedule> getDefaultSchedule(const DefaultScheduleType& defaultScheduleType) const; | ||
| 99 | |||
| 100 | /// Returns the rendering color. | ||
| 101 | boost::optional<RenderingColor> renderingColor() const; | ||
| 102 | |||
| 103 | /// Sets the rendering color. | ||
| 104 | bool setRenderingColor(const RenderingColor& renderingColor); | ||
| 105 | |||
| 106 | /// Resets the rendering color. | ||
| 107 | void resetRenderingColor(); | ||
| 108 | |||
| 109 | protected: | ||
| 110 | private: | ||
| 111 | REGISTER_LOGGER("openstudio.model.BuildingStory"); | ||
| 112 | |||
| 113 | boost::optional<ModelObject> defaultConstructionSetAsModelObject() const; | ||
| 114 | boost::optional<ModelObject> defaultScheduleSetAsModelObject() const; | ||
| 115 | boost::optional<ModelObject> renderingColorAsModelObject() const; | ||
| 116 | |||
| 117 | bool setDefaultConstructionSetAsModelObject(boost::optional<ModelObject> modelObject); | ||
| 118 | bool setDefaultScheduleSetAsModelObject(boost::optional<ModelObject> modelObject); | ||
| 119 | bool setRenderingColorAsModelObject(boost::optional<ModelObject> modelObject); | ||
| 120 | }; | ||
| 121 | |||
| 122 | } // namespace detail | ||
| 123 | |||
| 124 | } // namespace model | ||
| 125 | } // namespace openstudio | ||
| 126 | |||
| 127 | #endif // MODEL_BUILDINGSTORY_IMPL_HPP | ||
| 128 |