src/model/ShadowCalculation_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_SHADOWCALCULATION_IMPL_HPP | ||
| 7 | #define MODEL_SHADOWCALCULATION_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelObject_Impl.hpp" | ||
| 10 | |||
| 11 | namespace openstudio { | ||
| 12 | namespace model { | ||
| 13 | |||
| 14 | class ThermalZone; | ||
| 15 | class ModelObjectList; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | |||
| 19 | class MODEL_API ShadowCalculation_Impl : public ModelObject_Impl | ||
| 20 | { | ||
| 21 | |||
| 22 | public: | ||
| 23 | // constructor | ||
| 24 | ShadowCalculation_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 25 | |||
| 26 | // construct from workspace | ||
| 27 | ShadowCalculation_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 28 | |||
| 29 | // clone copy constructor | ||
| 30 | ShadowCalculation_Impl(const ShadowCalculation_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 31 | |||
| 32 | // virtual destructor | ||
| 33 | 510 | virtual ~ShadowCalculation_Impl() override = default; | |
| 34 | |||
| 35 | // return the parent object in the hierarchy | ||
| 36 | virtual boost::optional<ParentObject> parent() const override; | ||
| 37 | |||
| 38 | // set the parent, child may have to call methods on the parent | ||
| 39 | virtual bool setParent(ParentObject& newParent) override; | ||
| 40 | |||
| 41 | // Get all output variable names that could be associated with this object. | ||
| 42 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 43 | |||
| 44 | virtual IddObjectType iddObjectType() const override; | ||
| 45 | |||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | std::string shadingCalculationMethod() const; | ||
| 50 | |||
| 51 | std::string shadingCalculationUpdateFrequencyMethod() const; | ||
| 52 | bool isShadingCalculationUpdateFrequencyMethodDefaulted() const; | ||
| 53 | |||
| 54 | int shadingCalculationUpdateFrequency() const; | ||
| 55 | bool isShadingCalculationUpdateFrequencyDefaulted() const; | ||
| 56 | |||
| 57 | int maximumFiguresInShadowOverlapCalculations() const; | ||
| 58 | bool isMaximumFiguresInShadowOverlapCalculationsDefaulted() const; | ||
| 59 | |||
| 60 | std::string polygonClippingAlgorithm() const; | ||
| 61 | |||
| 62 | int pixelCountingResolution() const; | ||
| 63 | |||
| 64 | std::string skyDiffuseModelingAlgorithm() const; | ||
| 65 | |||
| 66 | bool outputExternalShadingCalculationResults() const; | ||
| 67 | |||
| 68 | bool disableSelfShadingWithinShadingZoneGroups() const; | ||
| 69 | |||
| 70 | bool disableSelfShadingFromShadingZoneGroupstoOtherZones() const; | ||
| 71 | |||
| 72 | unsigned int numberofShadingZoneGroups() const; | ||
| 73 | std::vector<ThermalZone> getShadingZoneGroup(unsigned groupIndex) const; | ||
| 74 | |||
| 75 | //@} | ||
| 76 | /** @name Setters */ | ||
| 77 | //@{ | ||
| 78 | |||
| 79 | bool setShadingCalculationMethod(const std::string& shadingCalculationMethod); | ||
| 80 | |||
| 81 | bool setShadingCalculationUpdateFrequencyMethod(const std::string& shadingCalculationUpdateFrequencyMethod); | ||
| 82 | void resetShadingCalculationUpdateFrequencyMethod(); | ||
| 83 | |||
| 84 | bool setShadingCalculationUpdateFrequency(int shadingCalculationUpdateFrequency); | ||
| 85 | void resetShadingCalculationUpdateFrequency(); | ||
| 86 | |||
| 87 | bool setMaximumFiguresInShadowOverlapCalculations(int maximumFiguresInShadowOverlapCalculations); | ||
| 88 | void resetMaximumFiguresInShadowOverlapCalculations(); | ||
| 89 | |||
| 90 | bool setPolygonClippingAlgorithm(const std::string& polygonClippingAlgorithm); | ||
| 91 | void resetPolygonClippingAlgorithm(); | ||
| 92 | |||
| 93 | bool setPixelCountingResolution(int pixelCountingResolution); | ||
| 94 | |||
| 95 | bool setSkyDiffuseModelingAlgorithm(const std::string& skyDiffuseModelingAlgorithm); | ||
| 96 | void resetSkyDiffuseModelingAlgorithm(); | ||
| 97 | |||
| 98 | bool setOutputExternalShadingCalculationResults(bool outputExternalShadingCalculationResults); | ||
| 99 | |||
| 100 | bool setDisableSelfShadingWithinShadingZoneGroups(bool disableSelfShadingWithinShadingZoneGroups); | ||
| 101 | |||
| 102 | bool setDisableSelfShadingFromShadingZoneGroupstoOtherZones(bool disableSelfShadingFromShadingZoneGroupstoOtherZones); | ||
| 103 | |||
| 104 | bool addShadingZoneGroup(const std::vector<ThermalZone>& thermalZones); | ||
| 105 | bool removeShadingZoneGroup(unsigned groupIndex); | ||
| 106 | void removeAllShadingZoneGroups(); | ||
| 107 | |||
| 108 | //@} | ||
| 109 | |||
| 110 | private: | ||
| 111 | − | REGISTER_LOGGER("openstudio.model.ShadowCalculation"); | |
| 112 | |||
| 113 | boost::optional<ModelObjectList> getShadingZoneGroupModelObjectList(unsigned groupIndex) const; | ||
| 114 | }; | ||
| 115 | |||
| 116 | } // namespace detail | ||
| 117 | |||
| 118 | } // namespace model | ||
| 119 | } // namespace openstudio | ||
| 120 | |||
| 121 | #endif // MODEL_SHADOWCALCULATION_IMPL_HPP | ||
| 122 |