OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "StandardsInformationMaterial.hpp"

Inheritance diagram for openstudio::model::StandardsInformationMaterial:

Public Member Functions

virtual ~StandardsInformationMaterial ()
Material material () const
boost::optional< std::string > materialStandard () const
std::vector< std::string > suggestedMaterialStandards () const
boost::optional< std::string > materialStandardSource () const
std::vector< std::string > suggestedMaterialStandardSources () const
boost::optional< std::string > standardsCategory () const
std::vector< std::string > suggestedStandardsCategories () const
bool isCompositeMaterial () const
boost::optional< std::string > standardsIdentifier () const
std::vector< std::string > suggestedStandardsIdentifiers () const
boost::optional< std::string > compositeFramingMaterial () const
std::vector< std::string > suggestedCompositeFramingMaterials () const
boost::optional< std::string > compositeFramingConfiguration () const
std::vector< std::string > suggestedCompositeFramingConfigurations () const
boost::optional< std::string > compositeFramingDepth () const
std::vector< std::string > suggestedCompositeFramingDepths () const
boost::optional< std::string > compositeFramingSize () const
std::vector< std::string > suggestedCompositeFramingSizes () const
boost::optional< std::string > compositeCavityInsulation () const
std::vector< std::string > suggestedCompositeCavityInsulations () const
void setMaterialStandard (const std::string &materialStandard)
void resetMaterialStandard ()
void setMaterialStandardSource (const std::string &materialStandardSource)
void resetMaterialStandardSource ()
void setStandardsCategory (const std::string &standardsCategory)
void resetStandardsCategory ()
void setStandardsIdentifier (const std::string &standardsIdentifier)
void resetStandardsIdentifier ()
void setCompositeFramingMaterial (const std::string &compositeFramingMaterial)
void resetCompositeFramingMaterial ()
void setCompositeFramingConfiguration (const std::string &compositeFramingConfiguration)
void resetCompositeFramingConfiguration ()
void setCompositeFramingDepth (const std::string &compositeFramingDepth)
void resetCompositeFramingDepth ()
void setCompositeFramingSize (const std::string &compositeFramingSize)
void resetCompositeFramingSize ()
void setCompositeCavityInsulation (const std::string &compositeCavityInsulation)
void resetCompositeCavityInsulation ()

Static Public Member Functions

static IddObjectType iddObjectType ()

Related Functions

typedef boost::optional
< StandardsInformationMaterial
OptionalStandardsInformationMaterial
typedef std::vector
< StandardsInformationMaterial
StandardsInformationMaterialVector

Detailed Description

StandardsInformationMaterial is a ModelObject that wraps the OpenStudio IDD object 'OS:StandardsInformation:Material'.

Constructor & Destructor Documentation

virtual openstudio::model::StandardsInformationMaterial::~StandardsInformationMaterial ( )
inlinevirtual

Member Function Documentation

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 IddObjectType openstudio::model::StandardsInformationMaterial::iddObjectType ( )
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 ( )
void openstudio::model::StandardsInformationMaterial::setCompositeCavityInsulation ( const std::string &  compositeCavityInsulation)
void openstudio::model::StandardsInformationMaterial::setCompositeFramingConfiguration ( const std::string &  compositeFramingConfiguration)
void openstudio::model::StandardsInformationMaterial::setCompositeFramingDepth ( const std::string &  compositeFramingDepth)
void openstudio::model::StandardsInformationMaterial::setCompositeFramingMaterial ( const std::string &  compositeFramingMaterial)
void openstudio::model::StandardsInformationMaterial::setCompositeFramingSize ( const std::string &  compositeFramingSize)
void openstudio::model::StandardsInformationMaterial::setMaterialStandard ( const std::string &  materialStandard)
void openstudio::model::StandardsInformationMaterial::setMaterialStandardSource ( const std::string &  materialStandardSource)
void openstudio::model::StandardsInformationMaterial::setStandardsCategory ( const std::string &  standardsCategory)
void 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.

Friends And Related Function Documentation