src/model/FFactorGroundFloorConstruction.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_FFACTORGROUNDFLOORCONSTRUCTION_HPP | ||
| 7 | #define MODEL_FFACTORGROUNDFLOORCONSTRUCTION_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ConstructionBase.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | namespace detail { | ||
| 16 | class FFactorGroundFloorConstruction_Impl; | ||
| 17 | } | ||
| 18 | |||
| 19 | /** FFactorGroundFloorConstruction is a ConstructionBase that wraps EnergyPlus IDD object | ||
| 20 | * 'Construction:FfactorGroundFloor'. This is a simple, unlayered construction object that may | ||
| 21 | * be applied to a Surface (typically a ground floor). */ | ||
| 22 | class MODEL_API FFactorGroundFloorConstruction : public ConstructionBase | ||
| 23 | { | ||
| 24 | public: | ||
| 25 | /** @name Constructors and Destructors */ | ||
| 26 | //@{ | ||
| 27 | |||
| 28 | explicit FFactorGroundFloorConstruction(const Model& model, double fFactor = 0.1, double area = 0.1, double perimeterExposed = 0.1); | ||
| 29 | |||
| 30 | 16 | virtual ~FFactorGroundFloorConstruction() override = default; | |
| 31 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 32 | 2 | FFactorGroundFloorConstruction(const FFactorGroundFloorConstruction& other) = default; | |
| 33 | 5 | FFactorGroundFloorConstruction(FFactorGroundFloorConstruction&& other) = default; | |
| 34 | 1 | FFactorGroundFloorConstruction& operator=(const FFactorGroundFloorConstruction&) = default; | |
| 35 | ✗ | FFactorGroundFloorConstruction& operator=(FFactorGroundFloorConstruction&&) = default; | |
| 36 | |||
| 37 | double fFactor() const; | ||
| 38 | bool setFFactor(double fFactor); | ||
| 39 | |||
| 40 | double area() const; | ||
| 41 | bool setArea(double area); | ||
| 42 | |||
| 43 | double perimeterExposed() const; | ||
| 44 | bool setPerimeterExposed(double perimeterExposed); | ||
| 45 | |||
| 46 | //@} | ||
| 47 | /** @name Static Methods */ | ||
| 48 | //@{ | ||
| 49 | |||
| 50 | static IddObjectType iddObjectType(); | ||
| 51 | |||
| 52 | //@} | ||
| 53 | protected: | ||
| 54 | /// @cond | ||
| 55 | using ImplType = detail::FFactorGroundFloorConstruction_Impl; | ||
| 56 | |||
| 57 | friend class Model; | ||
| 58 | friend class openstudio::IdfObject; | ||
| 59 | friend class detail::FFactorGroundFloorConstruction_Impl; | ||
| 60 | |||
| 61 | explicit FFactorGroundFloorConstruction(std::shared_ptr<detail::FFactorGroundFloorConstruction_Impl> impl); | ||
| 62 | |||
| 63 | /// @endcond | ||
| 64 | private: | ||
| 65 | REGISTER_LOGGER("openstudio.model.FFactorGroundFloorConstruction"); | ||
| 66 | }; | ||
| 67 | |||
| 68 | /** \relates FFactorGroundFloorConstruction */ | ||
| 69 | using OptionalFFactorGroundFloorConstruction = boost::optional<FFactorGroundFloorConstruction>; | ||
| 70 | |||
| 71 | /** \relates FFactorGroundFloorConstruction */ | ||
| 72 | using FFactorGroundFloorConstructionVector = std::vector<FFactorGroundFloorConstruction>; | ||
| 73 | |||
| 74 | } // namespace model | ||
| 75 | } // namespace openstudio | ||
| 76 | |||
| 77 | #endif // MODEL_FFACTORGROUNDFLOORCONSTRUCTION_HPP | ||
| 78 |