OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Related Functions | List of all members
openstudio::model::Material Class Reference

#include <Material.hpp>

+ Inheritance diagram for openstudio::model::Material:

Public Member Functions

Constructors and Destructors
virtual ~Material ()
 
Getters
double thickness () const
 Get the thickness of the material. More...
 
boost::optional< double > getVisibleTransmittance () const
 Get the visible transmittance of the material. More...
 
boost::optional< double > interiorVisibleAbsorptance () const
 Get the interiorVisibleAbsorptance of the material. More...
 
boost::optional< double > exteriorVisibleAbsorptance () const
 Get the exteriorVisibleAbsorptance of the material. More...
 
StandardsInformationMaterial standardsInformation () const
 Returns this materials's standards information, constructing a new object if necessary. More...
 
Setters
bool setThickness (double value)
 Set thickness to value (m). More...
 
boost::optional
< MaterialPropertyMoisturePenetrationDepthSettings
createMaterialPropertyMoisturePenetrationDepthSettings (double waterVaporDiffusionResistanceFactor, double moistureEquationCoefficientA, double moistureEquationCoefficientB, double moistureEquationCoefficientC, double moistureEquationCoefficientD, double coatingLayerThickness, double coatingLayerWaterVaporDiffusionResistanceFactor)
 
boost::optional
< MaterialPropertyMoisturePenetrationDepthSettings
materialPropertyMoisturePenetrationDepthSettings () const
 
void resetMaterialPropertyMoisturePenetrationDepthSettings ()
 
- Public Member Functions inherited from openstudio::model::ResourceObject
unsigned directUseCount (bool excludeChildren=false) const
 Returns the number of objects that use this resource directly. More...
 
unsigned nonResourceObjectUseCount (bool excludeChildren=false) const
 Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...
 
virtual ~ResourceObject ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
virtual ~ParentObject ()
 
- 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< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () 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< OutputVariableoutputVariables () 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< LifeCycleCostlifeCycleCosts () 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< ScheduleTypeKeygetScheduleTypeKeys (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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Related Functions

(Note that these are not member functions.)

typedef std::vector< MaterialMaterialVector
 
typedef boost::optional< MaterialOptionalMaterial
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- Protected Member Functions inherited from openstudio::model::ResourceObject
 ResourceObject (IddObjectType type, const Model &model)
 Constructs a new PlanarSurface object in the model. More...
 
- Protected Member Functions inherited from openstudio::model::ParentObject
 ParentObject (IddObjectType type, const Model &model)
 Constructs a new ParentObject object in the model. More...
 
- 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)
 

Detailed Description

A Material is a ResourceObject that serves as a base class for all objects that can be used in LayeredConstructions .

It also provides Attributes for 'thickness', 'getVisibleTransmiattance', 'interiorVisibleAbsorptance', and 'exteriorVisibleAbsorptance'.

Constructor & Destructor Documentation

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

Member Function Documentation

boost::optional<MaterialPropertyMoisturePenetrationDepthSettings> openstudio::model::Material::createMaterialPropertyMoisturePenetrationDepthSettings ( double  waterVaporDiffusionResistanceFactor,
double  moistureEquationCoefficientA,
double  moistureEquationCoefficientB,
double  moistureEquationCoefficientC,
double  moistureEquationCoefficientD,
double  coatingLayerThickness,
double  coatingLayerWaterVaporDiffusionResistanceFactor 
)
boost::optional<double> openstudio::model::Material::exteriorVisibleAbsorptance ( ) const

Get the exteriorVisibleAbsorptance of the material.

Virtual implementation.

Attribute Name: 'exteriorVisibleAbsorptance'

boost::optional<double> openstudio::model::Material::getVisibleTransmittance ( ) const

Get the visible transmittance of the material.

Virtual implementation.

Attribute Name: 'getVisibleTransmittance'

boost::optional<double> openstudio::model::Material::interiorVisibleAbsorptance ( ) const

Get the interiorVisibleAbsorptance of the material.

Virtual implementation.

Attribute Name: 'interiorVisibleAbsorptance'

boost::optional<MaterialPropertyMoisturePenetrationDepthSettings> openstudio::model::Material::materialPropertyMoisturePenetrationDepthSettings ( ) const
void openstudio::model::Material::resetMaterialPropertyMoisturePenetrationDepthSettings ( )
bool openstudio::model::Material::setThickness ( double  value)

Set thickness to value (m).

For some materials, false is always returned.

Attribute Name: 'thickness'

StandardsInformationMaterial openstudio::model::Material::standardsInformation ( ) const

Returns this materials's standards information, constructing a new object if necessary.

double openstudio::model::Material::thickness ( ) const

Get the thickness of the material.

Virtual implementation. For some materials, 0.0 is always returned.

Attribute Name: 'thickness'

Friends And Related Function Documentation

typedef std::vector<Material> MaterialVector
related
typedef boost::optional<Material> OptionalMaterial
related