src/model/StandardsInformationMaterial.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_STANDARDSINFORMATIONMATERIAL_HPP | ||
| 7 | #define MODEL_STANDARDSINFORMATIONMATERIAL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ModelObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | |||
| 15 | class Material; | ||
| 16 | |||
| 17 | namespace detail { | ||
| 18 | class StandardsInformationMaterial_Impl; | ||
| 19 | class Material_Impl; | ||
| 20 | } // namespace detail | ||
| 21 | |||
| 22 | /** StandardsInformationMaterial is a ModelObject that wraps the OpenStudio IDD object 'OS:StandardsInformation:Material'. */ | ||
| 23 | class MODEL_API StandardsInformationMaterial : public ModelObject | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** @name Constructors and Destructors */ | ||
| 27 | //@{ | ||
| 28 | |||
| 29 | 92 | virtual ~StandardsInformationMaterial() override = default; | |
| 30 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 31 | 5 | StandardsInformationMaterial(const StandardsInformationMaterial& other) = default; | |
| 32 | 33 | StandardsInformationMaterial(StandardsInformationMaterial&& other) = default; | |
| 33 | ✗ | StandardsInformationMaterial& operator=(const StandardsInformationMaterial&) = default; | |
| 34 | ✗ | StandardsInformationMaterial& operator=(StandardsInformationMaterial&&) = default; | |
| 35 | |||
| 36 | //@} | ||
| 37 | |||
| 38 | static IddObjectType iddObjectType(); | ||
| 39 | |||
| 40 | /** @name Getters */ | ||
| 41 | //@{ | ||
| 42 | |||
| 43 | /** Returns the material that this standards information object refers to. */ | ||
| 44 | Material material() const; | ||
| 45 | |||
| 46 | /** Returns the standard that specifies this material, e.g. 'CEC Title24-2013'. */ | ||
| 47 | boost::optional<std::string> materialStandard() const; | ||
| 48 | |||
| 49 | /** Returns a list of suggested material standards. */ | ||
| 50 | std::vector<std::string> suggestedMaterialStandards() const; | ||
| 51 | |||
| 52 | /** Identifies the table or section in the standard which specifies this material. */ | ||
| 53 | boost::optional<std::string> materialStandardSource() const; | ||
| 54 | |||
| 55 | /** Returns a list of suggestions for material standard source based on material standard. */ | ||
| 56 | std::vector<std::string> suggestedMaterialStandardSources() const; | ||
| 57 | |||
| 58 | /** Returns the category of this material, e.g. 'Plastering Materials' 'Wood Framed Wall', or 'Roofing'. */ | ||
| 59 | boost::optional<std::string> standardsCategory() const; | ||
| 60 | |||
| 61 | /** Returns a list of suggestions for standards category, filters list by material standard if it is set. */ | ||
| 62 | std::vector<std::string> suggestedStandardsCategories() const; | ||
| 63 | |||
| 64 | /** Returns true if this standards category represents a composite layer (such as framing with cavity insulation). */ | ||
| 65 | bool isCompositeMaterial() const; | ||
| 66 | |||
| 67 | /** Returns the id of this material within a standard, e.g. 'Wood siding - 1/2 in.'.*/ | ||
| 68 | boost::optional<std::string> standardsIdentifier() const; | ||
| 69 | |||
| 70 | /** Returns a list of suggestions for standards identifier, filters list by material standard and standards category if set. */ | ||
| 71 | std::vector<std::string> suggestedStandardsIdentifiers() const; | ||
| 72 | |||
| 73 | /** Returns the framing material for a composite layer, e.g. 'Wood' or 'Metal'. */ | ||
| 74 | boost::optional<std::string> compositeFramingMaterial() const; | ||
| 75 | |||
| 76 | /** Returns a list of suggestions for composite framing material, filters list by material standard and standards category if set. */ | ||
| 77 | std::vector<std::string> suggestedCompositeFramingMaterials() const; | ||
| 78 | |||
| 79 | /** Returns the framing configuration for a composite layer, e.g. 'Wall16inOC'. */ | ||
| 80 | boost::optional<std::string> compositeFramingConfiguration() const; | ||
| 81 | |||
| 82 | /** Returns a list of suggestions for composite framing configurations, filters list by material standard and standards category if set. */ | ||
| 83 | std::vector<std::string> suggestedCompositeFramingConfigurations() const; | ||
| 84 | |||
| 85 | /** Returns the framing depth for a composite layer, e.g. '3_5In'. */ | ||
| 86 | boost::optional<std::string> compositeFramingDepth() const; | ||
| 87 | |||
| 88 | /** Returns a list of suggestions for composite framing depths, filters list by material standard and standards category if set. */ | ||
| 89 | std::vector<std::string> suggestedCompositeFramingDepths() const; | ||
| 90 | |||
| 91 | /** Returns the framing size for a composite layer, e.g. '2x4'. */ | ||
| 92 | boost::optional<std::string> compositeFramingSize() const; | ||
| 93 | |||
| 94 | /** Returns a list of suggestions for composite framing sizes, filters list by material standard and standards category if set. */ | ||
| 95 | std::vector<std::string> suggestedCompositeFramingSizes() const; | ||
| 96 | |||
| 97 | /** Returns the cavity insulation for a composite layer, e.g. '30'*/ | ||
| 98 | boost::optional<std::string> compositeCavityInsulation() const; | ||
| 99 | |||
| 100 | /** Returns a list of suggestions for cavity insulation, filters list by material standard and standards category if set. */ | ||
| 101 | std::vector<std::string> suggestedCompositeCavityInsulations() const; | ||
| 102 | |||
| 103 | //@} | ||
| 104 | /** @name Setters */ | ||
| 105 | //@{ | ||
| 106 | |||
| 107 | bool setMaterialStandard(const std::string& materialStandard); | ||
| 108 | void resetMaterialStandard(); | ||
| 109 | |||
| 110 | bool setMaterialStandardSource(const std::string& materialStandardSource); | ||
| 111 | void resetMaterialStandardSource(); | ||
| 112 | |||
| 113 | bool setStandardsCategory(const std::string& standardsCategory); | ||
| 114 | void resetStandardsCategory(); | ||
| 115 | |||
| 116 | bool setStandardsIdentifier(const std::string& standardsIdentifier); | ||
| 117 | void resetStandardsIdentifier(); | ||
| 118 | |||
| 119 | bool setCompositeFramingMaterial(const std::string& compositeFramingMaterial); | ||
| 120 | void resetCompositeFramingMaterial(); | ||
| 121 | |||
| 122 | bool setCompositeFramingConfiguration(const std::string& compositeFramingConfiguration); | ||
| 123 | void resetCompositeFramingConfiguration(); | ||
| 124 | |||
| 125 | bool setCompositeFramingDepth(const std::string& compositeFramingDepth); | ||
| 126 | void resetCompositeFramingDepth(); | ||
| 127 | |||
| 128 | bool setCompositeFramingSize(const std::string& compositeFramingSize); | ||
| 129 | void resetCompositeFramingSize(); | ||
| 130 | |||
| 131 | bool setCompositeCavityInsulation(const std::string& compositeCavityInsulation); | ||
| 132 | void resetCompositeCavityInsulation(); | ||
| 133 | |||
| 134 | //@} | ||
| 135 | /** @name Other */ | ||
| 136 | //@{ | ||
| 137 | |||
| 138 | //@} | ||
| 139 | protected: | ||
| 140 | /// @cond | ||
| 141 | using ImplType = detail::StandardsInformationMaterial_Impl; | ||
| 142 | |||
| 143 | explicit StandardsInformationMaterial(const Material& material); | ||
| 144 | |||
| 145 | explicit StandardsInformationMaterial(std::shared_ptr<detail::StandardsInformationMaterial_Impl> impl); | ||
| 146 | |||
| 147 | friend class detail::StandardsInformationMaterial_Impl; | ||
| 148 | friend class Model; | ||
| 149 | friend class IdfObject; | ||
| 150 | friend class openstudio::detail::IdfObject_Impl; | ||
| 151 | friend class openstudio::model::Material; | ||
| 152 | friend class openstudio::model::detail::Material_Impl; | ||
| 153 | /// @endcond | ||
| 154 | private: | ||
| 155 | REGISTER_LOGGER("openstudio.model.StandardsInformationMaterial"); | ||
| 156 | }; | ||
| 157 | |||
| 158 | /** \relates StandardsInformationMaterial*/ | ||
| 159 | using OptionalStandardsInformationMaterial = boost::optional<StandardsInformationMaterial>; | ||
| 160 | |||
| 161 | /** \relates StandardsInformationMaterial*/ | ||
| 162 | using StandardsInformationMaterialVector = std::vector<StandardsInformationMaterial>; | ||
| 163 | |||
| 164 | } // namespace model | ||
| 165 | } // namespace openstudio | ||
| 166 | |||
| 167 | #endif // MODEL_STANDARDSINFORMATIONMATERIAL_HPP | ||
| 168 |