src/model/AirflowNetworkDuctViewFactors_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_AIRFLOWNETWORKDUCTVIEWFACTORS_IMPL_HPP | ||
| 7 | #define MODEL_AIRFLOWNETWORKDUCTVIEWFACTORS_IMPL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject_Impl.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | // Foward declaration | ||
| 16 | class AirflowNetworkLinkage; | ||
| 17 | class PlanarSurface; | ||
| 18 | class ViewFactorData; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | /** AirflowNetworkDuctViewFactors_Impl is a ModelObject_Impl that is the implementation class for AirflowNetworkDuctViewFactors.*/ | ||
| 23 | class MODEL_API AirflowNetworkDuctViewFactors_Impl : public ModelObject_Impl | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | AirflowNetworkDuctViewFactors_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 30 | |||
| 31 | AirflowNetworkDuctViewFactors_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | AirflowNetworkDuctViewFactors_Impl(const AirflowNetworkDuctViewFactors_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | 1 | virtual ~AirflowNetworkDuctViewFactors_Impl() override = default; | |
| 36 | |||
| 37 | //@} | ||
| 38 | /** @name Virtual Methods */ | ||
| 39 | //@{ | ||
| 40 | |||
| 41 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 42 | |||
| 43 | virtual IddObjectType iddObjectType() const override; | ||
| 44 | |||
| 45 | //@} | ||
| 46 | /** @name Getters */ | ||
| 47 | //@{ | ||
| 48 | |||
| 49 | AirflowNetworkLinkage linkage() const; | ||
| 50 | |||
| 51 | double ductSurfaceExposureFraction() const; | ||
| 52 | |||
| 53 | bool isDuctSurfaceExposureFractionDefaulted() const; | ||
| 54 | |||
| 55 | double ductSurfaceEmittance() const; | ||
| 56 | |||
| 57 | bool isDuctSurfaceEmittanceDefaulted() const; | ||
| 58 | |||
| 59 | boost::optional<double> getViewFactor(const PlanarSurface& surf) const; | ||
| 60 | |||
| 61 | std::vector<ViewFactorData> viewFactors() const; | ||
| 62 | |||
| 63 | //@} | ||
| 64 | /** @name Setters */ | ||
| 65 | //@{ | ||
| 66 | |||
| 67 | bool setLinkage(const AirflowNetworkLinkage& linkage); | ||
| 68 | |||
| 69 | bool setDuctSurfaceExposureFraction(double ductSurfaceExposureFraction); | ||
| 70 | |||
| 71 | void resetDuctSurfaceExposureFraction(); | ||
| 72 | |||
| 73 | bool setDuctSurfaceEmittance(double ductSurfaceEmittance); | ||
| 74 | |||
| 75 | void resetDuctSurfaceEmittance(); | ||
| 76 | |||
| 77 | bool setViewFactor(const PlanarSurface& surf, double F); | ||
| 78 | bool removeViewFactor(const PlanarSurface& surf); | ||
| 79 | void resetViewFactors(); | ||
| 80 | |||
| 81 | //@} | ||
| 82 | /** @name Other */ | ||
| 83 | //@{ | ||
| 84 | |||
| 85 | //@} | ||
| 86 | protected: | ||
| 87 | private: | ||
| 88 | − | REGISTER_LOGGER("openstudio.model.AirflowNetworkDuctViewFactors"); | |
| 89 | |||
| 90 | // Optional getters for use by methods like children() so can remove() if the constructor fails. | ||
| 91 | // There are other ways for the public versions of these getters to fail--perhaps all required | ||
| 92 | // objects should be returned as boost::optionals | ||
| 93 | boost::optional<AirflowNetworkLinkage> optionalLinkage() const; | ||
| 94 | }; | ||
| 95 | |||
| 96 | } // namespace detail | ||
| 97 | |||
| 98 | } // namespace model | ||
| 99 | } // namespace openstudio | ||
| 100 | |||
| 101 | #endif // MODEL_AIRFLOWNETWORKDUCTVIEWFACTORS_IMPL_HPP | ||
| 102 |