 |
OpenStudio:model |
#include <StandardsInformationMaterial.hpp>
Inheritance diagram for openstudio::model::StandardsInformationMaterial:Public Member Functions | |
Constructors and Destructors | |
| virtual | ~StandardsInformationMaterial () |
Getters | |
| Material | material () const |
| Returns the material that this standards information object refers to. More... | |
| boost::optional< std::string > | materialStandard () const |
| Returns the standard that specifies this material, e.g. More... | |
| std::vector< std::string > | suggestedMaterialStandards () const |
| Returns a list of suggested material standards. More... | |
| boost::optional< std::string > | materialStandardSource () const |
| Identifies the table or section in the standard which specifies this material. More... | |
| std::vector< std::string > | suggestedMaterialStandardSources () const |
| Returns a list of suggestions for material standard source based on material standard. More... | |
| boost::optional< std::string > | standardsCategory () const |
| Returns the category of this material, e.g. More... | |
| std::vector< std::string > | suggestedStandardsCategories () const |
| Returns a list of suggestions for standards category, filters list by material standard if it is set. More... | |
| bool | isCompositeMaterial () const |
| Returns true if this standards category represents a composite layer (such as framing with cavity insulation). More... | |
| boost::optional< std::string > | standardsIdentifier () const |
| Returns the id of this material within a standard, e.g. More... | |
| std::vector< std::string > | suggestedStandardsIdentifiers () const |
| Returns a list of suggestions for standards identifier, filters list by material standard and standards category if set. More... | |
| boost::optional< std::string > | compositeFramingMaterial () const |
| Returns the framing material for a composite layer, e.g. More... | |
| std::vector< std::string > | suggestedCompositeFramingMaterials () const |
| Returns a list of suggestions for composite framing material, filters list by material standard and standards category if set. More... | |
| boost::optional< std::string > | compositeFramingConfiguration () const |
| Returns the framing configuration for a composite layer, e.g. More... | |
| std::vector< std::string > | suggestedCompositeFramingConfigurations () const |
| Returns a list of suggestions for composite framing configurations, filters list by material standard and standards category if set. More... | |
| boost::optional< std::string > | compositeFramingDepth () const |
| Returns the framing depth for a composite layer, e.g. More... | |
| std::vector< std::string > | suggestedCompositeFramingDepths () const |
| Returns a list of suggestions for composite framing depths, filters list by material standard and standards category if set. More... | |
| boost::optional< std::string > | compositeFramingSize () const |
| Returns the framing size for a composite layer, e.g. More... | |
| std::vector< std::string > | suggestedCompositeFramingSizes () const |
| Returns a list of suggestions for composite framing sizes, filters list by material standard and standards category if set. More... | |
| boost::optional< std::string > | compositeCavityInsulation () const |
| Returns the cavity insulation for a composite layer, e.g. More... | |
| std::vector< std::string > | suggestedCompositeCavityInsulations () const |
| Returns a list of suggestions for cavity insulation, filters list by material standard and standards category if set. More... | |
Setters | |
| bool | setMaterialStandard (const std::string &materialStandard) |
| void | resetMaterialStandard () |
| bool | setMaterialStandardSource (const std::string &materialStandardSource) |
| void | resetMaterialStandardSource () |
| bool | setStandardsCategory (const std::string &standardsCategory) |
| void | resetStandardsCategory () |
| bool | setStandardsIdentifier (const std::string &standardsIdentifier) |
| void | resetStandardsIdentifier () |
| bool | setCompositeFramingMaterial (const std::string &compositeFramingMaterial) |
| void | resetCompositeFramingMaterial () |
| bool | setCompositeFramingConfiguration (const std::string &compositeFramingConfiguration) |
| void | resetCompositeFramingConfiguration () |
| bool | setCompositeFramingDepth (const std::string &compositeFramingDepth) |
| void | resetCompositeFramingDepth () |
| bool | setCompositeFramingSize (const std::string &compositeFramingSize) |
| void | resetCompositeFramingSize () |
| bool | setCompositeCavityInsulation (const std::string &compositeCavityInsulation) |
| void | resetCompositeCavityInsulation () |
| Public Member Functions inherited from openstudio::model::ModelObject | |
| virtual | ~ModelObject () |
| ModelObject | clone () const |
| Creates a deep copy of this object, placing it in this object's model(). More... | |
| ModelObject | clone (Model model) const |
| Creates a deep copy of this object, placing it in model. More... | |
| Component | createComponent () const |
| Method for creating sharable Model snippets. More... | |
| Model | model () const |
| Returns the Model that contains this object. More... | |
| boost::optional< ParentObject > | parent () const |
| Return this object's parent in the hierarchy, if it has one. More... | |
| std::vector< ResourceObject > | resources () const |
| Get the resources directly used by this ModelObject. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectSources () const |
| Get all objects of type T that point to this object. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectSources (IddObjectType iddObjectType) const |
| Get all objects of type T that point to this object. More... | |
| template<typename T > | |
| boost::optional< T > | getModelObjectTarget (unsigned index) const |
| Get the object of type T pointed to by this object from field index. More... | |
| template<typename T > | |
| std::vector< T > | getModelObjectTargets () const |
| Get all objects of type T to which this object points. More... | |
| const std::vector< std::string > & | outputVariableNames () const |
| Get all output variables names that could be associated with this object. More... | |
| std::vector< OutputVariable > | outputVariables () const |
| Get all output variables associated with this object, must run simulation to generate data. More... | |
| boost::optional < openstudio::TimeSeries > | getData (const OutputVariable &variable, const std::string &envPeriod) const |
| Get data associated with this output variable and this object. More... | |
| std::vector< LifeCycleCost > | lifeCycleCosts () const |
| Returns the list of all LifeCycleCosts that refer to this object. More... | |
| std::vector< IdfObject > | removeLifeCycleCosts () |
| Removes all LifeCycleCosts that refer to this object. More... | |
| IddObjectType | iddObjectType () const |
| This is a virtual function that will tell you the type of iddObject you are dealing with. More... | |
| AdditionalProperties | additionalProperties () const |
| Returns this object's additional properties, constructing a new object if necessary. More... | |
| bool | hasAdditionalProperties () const |
| Returns true if this object has additional properties. More... | |
| std::vector< IdfObject > | removeAdditionalProperties () |
| Removes all additional properties that refer to this object. More... | |
| bool | setParent (ParentObject &newParent) |
| set the parent, child may have to call non-const methods on the parent More... | |
| bool | operator< (const ModelObject &right) const |
| bool | operator== (const ModelObject &other) const |
| equality test More... | |
| bool | operator!= (const ModelObject &other) const |
| inequality test More... | |
| std::vector< ScheduleTypeKey > | getScheduleTypeKeys (const Schedule &schedule) const |
| Return the ScheduleTypeKeys indicating how schedule is used in this object. More... | |
| boost::optional< double > | getAutosizedValue (std::string valueName, std::string unitString) const |
| Gets the autosized component value from the sql file. More... | |
| virtual std::vector < EMSActuatorNames > | emsActuatorNames () const |
| Return the names of the available ems actuators. More... | |
| virtual std::vector< std::string > | emsInternalVariableNames () const |
| Return the names of the available ems internal variables. More... | |
| boost::optional< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
| static IddObjectType | iddObjectType () |
Related Functions | |
(Note that these are not member functions.) | |
| typedef boost::optional < StandardsInformationMaterial > | OptionalStandardsInformationMaterial |
| typedef std::vector < StandardsInformationMaterial > | StandardsInformationMaterialVector |
| Related Functions inherited from openstudio::model::ModelObject | |
| std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
| Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
| typedef std::pair< std::string, std::string > | ScheduleTypeKey |
| Typedef for ScheduleTypeRegistry key. More... | |
| typedef std::pair< std::string, std::string > | ScheduleTypeKey |
| Typedef for ScheduleTypeRegistry key. More... | |
Additional Inherited Members | |
| Protected Types inherited from openstudio::model::ModelObject | |
| typedef detail::ModelObject_Impl | ImplType |
| Protected Member Functions inherited from openstudio::model::ModelObject | |
| ModelObject (IddObjectType type, const Model &model, bool fastName=false) | |
| ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl) | |
StandardsInformationMaterial is a ModelObject that wraps the OpenStudio IDD object 'OS:StandardsInformation:Material'.
|
inlinevirtual |
| boost::optional<std::string> openstudio::model::StandardsInformationMaterial::compositeCavityInsulation | ( | ) | const |
Returns the cavity insulation for a composite layer, e.g.
'30'
| boost::optional<std::string> openstudio::model::StandardsInformationMaterial::compositeFramingConfiguration | ( | ) | const |
Returns the framing configuration for a composite layer, e.g.
'Wall16inOC'.
| boost::optional<std::string> openstudio::model::StandardsInformationMaterial::compositeFramingDepth | ( | ) | const |
Returns the framing depth for a composite layer, e.g.
'3_5In'.
| boost::optional<std::string> openstudio::model::StandardsInformationMaterial::compositeFramingMaterial | ( | ) | const |
Returns the framing material for a composite layer, e.g.
'Wood' or 'Metal'.
| boost::optional<std::string> openstudio::model::StandardsInformationMaterial::compositeFramingSize | ( | ) | const |
Returns the framing size for a composite layer, e.g.
'2x4'.
|
static |
| bool openstudio::model::StandardsInformationMaterial::isCompositeMaterial | ( | ) | const |
Returns true if this standards category represents a composite layer (such as framing with cavity insulation).
| Material openstudio::model::StandardsInformationMaterial::material | ( | ) | const |
Returns the material that this standards information object refers to.
| boost::optional<std::string> openstudio::model::StandardsInformationMaterial::materialStandard | ( | ) | const |
Returns the standard that specifies this material, e.g.
'CEC Title24-2013'.
| boost::optional<std::string> openstudio::model::StandardsInformationMaterial::materialStandardSource | ( | ) | const |
Identifies the table or section in the standard which specifies this material.
| void openstudio::model::StandardsInformationMaterial::resetCompositeCavityInsulation | ( | ) |
| void openstudio::model::StandardsInformationMaterial::resetCompositeFramingConfiguration | ( | ) |
| void openstudio::model::StandardsInformationMaterial::resetCompositeFramingDepth | ( | ) |
| void openstudio::model::StandardsInformationMaterial::resetCompositeFramingMaterial | ( | ) |
| void openstudio::model::StandardsInformationMaterial::resetCompositeFramingSize | ( | ) |
| void openstudio::model::StandardsInformationMaterial::resetMaterialStandard | ( | ) |
| void openstudio::model::StandardsInformationMaterial::resetMaterialStandardSource | ( | ) |
| void openstudio::model::StandardsInformationMaterial::resetStandardsCategory | ( | ) |
| void openstudio::model::StandardsInformationMaterial::resetStandardsIdentifier | ( | ) |
| bool openstudio::model::StandardsInformationMaterial::setCompositeCavityInsulation | ( | const std::string & | compositeCavityInsulation | ) |
| bool openstudio::model::StandardsInformationMaterial::setCompositeFramingConfiguration | ( | const std::string & | compositeFramingConfiguration | ) |
| bool openstudio::model::StandardsInformationMaterial::setCompositeFramingDepth | ( | const std::string & | compositeFramingDepth | ) |
| bool openstudio::model::StandardsInformationMaterial::setCompositeFramingMaterial | ( | const std::string & | compositeFramingMaterial | ) |
| bool openstudio::model::StandardsInformationMaterial::setCompositeFramingSize | ( | const std::string & | compositeFramingSize | ) |
| bool openstudio::model::StandardsInformationMaterial::setMaterialStandard | ( | const std::string & | materialStandard | ) |
| bool openstudio::model::StandardsInformationMaterial::setMaterialStandardSource | ( | const std::string & | materialStandardSource | ) |
| bool openstudio::model::StandardsInformationMaterial::setStandardsCategory | ( | const std::string & | standardsCategory | ) |
| bool openstudio::model::StandardsInformationMaterial::setStandardsIdentifier | ( | const std::string & | standardsIdentifier | ) |
| boost::optional<std::string> openstudio::model::StandardsInformationMaterial::standardsCategory | ( | ) | const |
Returns the category of this material, e.g.
'Plastering Materials' 'Wood Framed Wall', or 'Roofing'.
| boost::optional<std::string> openstudio::model::StandardsInformationMaterial::standardsIdentifier | ( | ) | const |
Returns the id of this material within a standard, e.g.
'Wood siding - 1/2 in.'.
| std::vector<std::string> openstudio::model::StandardsInformationMaterial::suggestedCompositeCavityInsulations | ( | ) | const |
Returns a list of suggestions for cavity insulation, filters list by material standard and standards category if set.
| std::vector<std::string> openstudio::model::StandardsInformationMaterial::suggestedCompositeFramingConfigurations | ( | ) | const |
Returns a list of suggestions for composite framing configurations, filters list by material standard and standards category if set.
| std::vector<std::string> openstudio::model::StandardsInformationMaterial::suggestedCompositeFramingDepths | ( | ) | const |
Returns a list of suggestions for composite framing depths, filters list by material standard and standards category if set.
| std::vector<std::string> openstudio::model::StandardsInformationMaterial::suggestedCompositeFramingMaterials | ( | ) | const |
Returns a list of suggestions for composite framing material, filters list by material standard and standards category if set.
| std::vector<std::string> openstudio::model::StandardsInformationMaterial::suggestedCompositeFramingSizes | ( | ) | const |
Returns a list of suggestions for composite framing sizes, filters list by material standard and standards category if set.
| std::vector<std::string> openstudio::model::StandardsInformationMaterial::suggestedMaterialStandards | ( | ) | const |
Returns a list of suggested material standards.
| std::vector<std::string> openstudio::model::StandardsInformationMaterial::suggestedMaterialStandardSources | ( | ) | const |
Returns a list of suggestions for material standard source based on material standard.
| std::vector<std::string> openstudio::model::StandardsInformationMaterial::suggestedStandardsCategories | ( | ) | const |
Returns a list of suggestions for standards category, filters list by material standard if it is set.
| std::vector<std::string> openstudio::model::StandardsInformationMaterial::suggestedStandardsIdentifiers | ( | ) | const |
Returns a list of suggestions for standards identifier, filters list by material standard and standards category if set.
|
related |
|
related |