src/model/ZonePropertyUserViewFactorsBySurfaceName_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_ZONEPROPERTYUSERVIEWFACTORSBYSURFACENAME_IMPL_HPP | ||
| 7 | #define MODEL_ZONEPROPERTYUSERVIEWFACTORSBYSURFACENAME_IMPL_HPP | ||
| 8 | |||
| 9 | #include <vector> | ||
| 10 | #include "ModelAPI.hpp" | ||
| 11 | #include "ModelObject_Impl.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class ThermalZone; | ||
| 17 | class Surface; | ||
| 18 | class SubSurface; | ||
| 19 | class InternalMass; | ||
| 20 | class ViewFactor; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | /** ZonePropertyUserViewFactorsBySurfaceName_Impl is a ModelObject_Impl that is the implementation class for ZonePropertyUserViewFactorsBySurfaceName.*/ | ||
| 25 | class MODEL_API ZonePropertyUserViewFactorsBySurfaceName_Impl : public ModelObject_Impl | ||
| 26 | { | ||
| 27 | |||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | ZonePropertyUserViewFactorsBySurfaceName_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 33 | |||
| 34 | ZonePropertyUserViewFactorsBySurfaceName_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 35 | |||
| 36 | ZonePropertyUserViewFactorsBySurfaceName_Impl(const ZonePropertyUserViewFactorsBySurfaceName_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 37 | |||
| 38 | 9 | virtual ~ZonePropertyUserViewFactorsBySurfaceName_Impl() override = default; | |
| 39 | |||
| 40 | //@} | ||
| 41 | /** @name Virtual Methods */ | ||
| 42 | //@{ | ||
| 43 | |||
| 44 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 45 | |||
| 46 | virtual IddObjectType iddObjectType() const override; | ||
| 47 | |||
| 48 | // Disallow cloning | ||
| 49 | virtual ModelObject clone(Model model) const override; | ||
| 50 | |||
| 51 | //@} | ||
| 52 | /** @name Getters */ | ||
| 53 | //@{ | ||
| 54 | |||
| 55 | ThermalZone thermalZone() const; | ||
| 56 | |||
| 57 | std::vector<ViewFactor> viewFactors() const; | ||
| 58 | |||
| 59 | unsigned int numberofViewFactors() const; | ||
| 60 | |||
| 61 | boost::optional<unsigned> viewFactorIndex(const ViewFactor& viewFactor) const; | ||
| 62 | |||
| 63 | boost::optional<ViewFactor> getViewFactor(unsigned groupIndex) const; | ||
| 64 | |||
| 65 | //@} | ||
| 66 | /** @name Setters */ | ||
| 67 | //@{ | ||
| 68 | |||
| 69 | bool addViewFactor(const ViewFactor& viewFactor); | ||
| 70 | |||
| 71 | bool addViewFactor(const Surface& fromSurface, const Surface& toSurface, double viewFactor); | ||
| 72 | |||
| 73 | bool addViewFactor(const Surface& fromSurface, const SubSurface& toSubSurface, double viewFactor); | ||
| 74 | |||
| 75 | bool addViewFactor(const Surface& fromSurface, const InternalMass& toInternalMass, double viewFactor); | ||
| 76 | |||
| 77 | bool addViewFactor(const SubSurface& fromSubSurface, const SubSurface& toSubSurface, double viewFactor); | ||
| 78 | |||
| 79 | bool addViewFactor(const SubSurface& fromSubSurface, const Surface& toSurface, double viewFactor); | ||
| 80 | |||
| 81 | bool addViewFactor(const SubSurface& fromSubSurface, const InternalMass& toInternalMass, double viewFactor); | ||
| 82 | |||
| 83 | bool addViewFactor(const InternalMass& fromInternalMass, const InternalMass& toInernalMass, double viewFactor); | ||
| 84 | |||
| 85 | bool addViewFactor(const InternalMass& fromInternalMass, const Surface& toSurface, double viewFactor); | ||
| 86 | |||
| 87 | bool addViewFactor(const InternalMass& fromInternalMass, const SubSurface& toSubSurface, double viewFactor); | ||
| 88 | |||
| 89 | bool addViewFactors(const std::vector<ViewFactor>& viewFactors); | ||
| 90 | |||
| 91 | bool removeViewFactor(unsigned groupIndex); | ||
| 92 | |||
| 93 | void removeAllViewFactors(); | ||
| 94 | |||
| 95 | //@} | ||
| 96 | /** @name Other */ | ||
| 97 | //@{ | ||
| 98 | |||
| 99 | //@} | ||
| 100 | protected: | ||
| 101 | private: | ||
| 102 | − | REGISTER_LOGGER("openstudio.model.ZonePropertyUserViewFactorsBySurfaceName"); | |
| 103 | }; | ||
| 104 | |||
| 105 | } // namespace detail | ||
| 106 | |||
| 107 | } // namespace model | ||
| 108 | } // namespace openstudio | ||
| 109 | |||
| 110 | #endif // MODEL_ZONEPROPERTYUSERVIEWFACTORSBYSURFACENAME_IMPL_HPP | ||
| 111 |