src/model/FoundationKiva_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_FOUNDATIONKIVA_IMPL_HPP | ||
| 7 | #define MODEL_FOUNDATIONKIVA_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 Material; | ||
| 17 | class ConstructionBase; | ||
| 18 | class Surface; | ||
| 19 | class CustomBlock; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | /** FoundationKiva_Impl is a ModelObject_Impl that is the implementation class for FoundationKiva.*/ | ||
| 24 | class MODEL_API FoundationKiva_Impl : public ModelObject_Impl | ||
| 25 | { | ||
| 26 | |||
| 27 | public: | ||
| 28 | /** @name Constructors and Destructors */ | ||
| 29 | //@{ | ||
| 30 | |||
| 31 | FoundationKiva_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle); | ||
| 32 | |||
| 33 | FoundationKiva_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 34 | |||
| 35 | FoundationKiva_Impl(const FoundationKiva_Impl& other, Model_Impl* model, bool keepHandle); | ||
| 36 | |||
| 37 | 20 | virtual ~FoundationKiva_Impl() override = default; | |
| 38 | |||
| 39 | //@} | ||
| 40 | /** @name Virtual Methods */ | ||
| 41 | //@{ | ||
| 42 | |||
| 43 | virtual const std::vector<std::string>& outputVariableNames() const override; | ||
| 44 | |||
| 45 | virtual IddObjectType iddObjectType() const override; | ||
| 46 | |||
| 47 | //extensible fields | ||
| 48 | |||
| 49 | bool addCustomBlock(const CustomBlock& customBlock); | ||
| 50 | |||
| 51 | bool addCustomBlock(const Material& material, double depth, double xPosition, double zPosition); | ||
| 52 | |||
| 53 | bool removeCustomBlock(unsigned groupIndex); | ||
| 54 | |||
| 55 | void removeAllCustomBlocks(); | ||
| 56 | |||
| 57 | std::vector<CustomBlock> customBlocks() const; | ||
| 58 | |||
| 59 | bool addCustomBlocks(const std::vector<CustomBlock>& customBlocks); | ||
| 60 | |||
| 61 | //@} | ||
| 62 | /** @name Getters */ | ||
| 63 | //@{ | ||
| 64 | |||
| 65 | boost::optional<double> initialIndoorAirTemperature(); | ||
| 66 | |||
| 67 | boost::optional<Material> interiorHorizontalInsulationMaterial() const; | ||
| 68 | |||
| 69 | double interiorHorizontalInsulationDepth() const; | ||
| 70 | |||
| 71 | bool isInteriorHorizontalInsulationDepthDefaulted() const; | ||
| 72 | |||
| 73 | boost::optional<double> interiorHorizontalInsulationWidth(); | ||
| 74 | |||
| 75 | boost::optional<Material> interiorVerticalInsulationMaterial() const; | ||
| 76 | |||
| 77 | boost::optional<double> interiorVerticalInsulationDepth(); | ||
| 78 | |||
| 79 | boost::optional<Material> exteriorHorizontalInsulationMaterial() const; | ||
| 80 | |||
| 81 | boost::optional<double> exteriorHorizontalInsulationDepth(); | ||
| 82 | |||
| 83 | double exteriorHorizontalInsulationWidth() const; | ||
| 84 | |||
| 85 | bool isExteriorHorizontalInsulationWidthDefaulted() const; | ||
| 86 | |||
| 87 | boost::optional<Material> exteriorVerticalInsulationMaterial() const; | ||
| 88 | |||
| 89 | boost::optional<double> exteriorVerticalInsulationDepth(); | ||
| 90 | |||
| 91 | double wallHeightAboveGrade() const; | ||
| 92 | |||
| 93 | bool isWallHeightAboveGradeDefaulted() const; | ||
| 94 | |||
| 95 | double wallDepthBelowSlab() const; | ||
| 96 | |||
| 97 | bool isWallDepthBelowSlabDefaulted() const; | ||
| 98 | |||
| 99 | boost::optional<ConstructionBase> footingWallConstruction() const; | ||
| 100 | |||
| 101 | boost::optional<Material> footingMaterial() const; | ||
| 102 | |||
| 103 | double footingDepth() const; | ||
| 104 | |||
| 105 | bool isFootingDepthDefaulted() const; | ||
| 106 | |||
| 107 | std::vector<Surface> surfaces() const; | ||
| 108 | |||
| 109 | unsigned int numberofCustomBlocks() const; | ||
| 110 | |||
| 111 | //@} | ||
| 112 | /** @name Setters */ | ||
| 113 | //@{ | ||
| 114 | |||
| 115 | bool setInitialIndoorAirTemperature(double initialIndoorAirTemperature); | ||
| 116 | |||
| 117 | bool setInteriorHorizontalInsulationMaterial(const Material& material); | ||
| 118 | |||
| 119 | void resetInteriorHorizontalInsulationMaterial(); | ||
| 120 | |||
| 121 | bool setInteriorHorizontalInsulationDepth(double interiorHorizontalInsulationDepth); | ||
| 122 | |||
| 123 | void resetInteriorHorizontalInsulationDepth(); | ||
| 124 | |||
| 125 | bool setInteriorHorizontalInsulationWidth(double interiorHorizontalInsulationWidth); | ||
| 126 | |||
| 127 | bool setInteriorVerticalInsulationMaterial(const Material& material); | ||
| 128 | |||
| 129 | void resetInteriorVerticalInsulationMaterial(); | ||
| 130 | |||
| 131 | bool setInteriorVerticalInsulationDepth(double interiorVerticalInsulationDepth); | ||
| 132 | |||
| 133 | bool setExteriorHorizontalInsulationMaterial(const Material& material); | ||
| 134 | |||
| 135 | void resetExteriorHorizontalInsulationMaterial(); | ||
| 136 | |||
| 137 | bool setExteriorHorizontalInsulationDepth(double exteriorHorizontalInsulationDepth); | ||
| 138 | |||
| 139 | bool setExteriorHorizontalInsulationWidth(double exteriorHorizontalInsulationWidth); | ||
| 140 | |||
| 141 | void resetExteriorHorizontalInsulationWidth(); | ||
| 142 | |||
| 143 | bool setExteriorVerticalInsulationMaterial(const Material& material); | ||
| 144 | |||
| 145 | void resetExteriorVerticalInsulationMaterial(); | ||
| 146 | |||
| 147 | bool setExteriorVerticalInsulationDepth(double exteriorVerticalInsulationDepth); | ||
| 148 | |||
| 149 | bool setWallHeightAboveGrade(double wallHeightAboveGrade); | ||
| 150 | |||
| 151 | void resetWallHeightAboveGrade(); | ||
| 152 | |||
| 153 | bool setWallDepthBelowSlab(double wallDepthBelowSlab); | ||
| 154 | |||
| 155 | void resetWallDepthBelowSlab(); | ||
| 156 | |||
| 157 | bool setFootingWallConstruction(const ConstructionBase& construction); | ||
| 158 | |||
| 159 | void resetFootingWallConstruction(); | ||
| 160 | |||
| 161 | bool setFootingMaterial(const Material& material); | ||
| 162 | |||
| 163 | void resetFootingMaterial(); | ||
| 164 | |||
| 165 | bool setFootingDepth(double footingDepth); | ||
| 166 | |||
| 167 | void resetFootingDepth(); | ||
| 168 | |||
| 169 | //@} | ||
| 170 | /** @name Other */ | ||
| 171 | //@{ | ||
| 172 | |||
| 173 | virtual ModelObject clone(Model model) const override; | ||
| 174 | |||
| 175 | //@} | ||
| 176 | protected: | ||
| 177 | private: | ||
| 178 | − | REGISTER_LOGGER("openstudio.model.FoundationKiva"); | |
| 179 | }; | ||
| 180 | |||
| 181 | } // namespace detail | ||
| 182 | |||
| 183 | } // namespace model | ||
| 184 | } // namespace openstudio | ||
| 185 | |||
| 186 | #endif // MODEL_FOUNDATIONKIVA_IMPL_HPP | ||
| 187 |