All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Static Public Member Functions | Related Functions | List of all members
openstudio::model::RoofVegetation Class Reference

#include <RoofVegetation.hpp>

+ Inheritance diagram for openstudio::model::RoofVegetation:

Public Member Functions

Constructors and Destructors
 RoofVegetation (const Model &model, std::string roughness="Smooth")
virtual ~RoofVegetation ()
double heightofPlants () const
bool isHeightofPlantsDefaulted () const
double leafAreaIndex () const
bool isLeafAreaIndexDefaulted () const
double leafReflectivity () const
bool isLeafReflectivityDefaulted () const
double leafEmissivity () const
bool isLeafEmissivityDefaulted () const
double minimumStomatalResistance () const
bool isMinimumStomatalResistanceDefaulted () const
std::string soilLayerName () const
bool isSoilLayerNameDefaulted () const
std::string roughness () const
double density () const
 Density of dry soil (kg/m^3). More...
double specificHeat () const
 Specific heat of dry soil (J/kg*K). More...
double saturationVolumetricMoistureContent () const
 Maximum moisture content of the soil layer by volume fraction. More...
double residualVolumetricMoistureContent () const
double initialVolumetricMoistureContent () const
bool isRoughnessDefaulted () const
double thickness () const
bool isThicknessDefaulted () const
double conductivityofDrySoil () const
bool isConductivityofDrySoilDefaulted () const
double densityofDrySoil () const
bool isDensityofDrySoilDefaulted () const
double specificHeatofDrySoil () const
bool isSpecificHeatofDrySoilDefaulted () const
boost::optional< double > thermalAbsorptance () const
bool isThermalAbsorptanceDefaulted () const
boost::optional< double > solarAbsorptance () const
bool isSolarAbsorptanceDefaulted () const
boost::optional< double > visibleAbsorptance () const
bool isVisibleAbsorptanceDefaulted () const
double saturationVolumetricMoistureContentoftheSoilLayer () const
bool isSaturationVolumetricMoistureContentoftheSoilLayerDefaulted () const
double residualVolumetricMoistureContentoftheSoilLayer () const
bool isResidualVolumetricMoistureContentoftheSoilLayerDefaulted () const
double initialVolumetricMoistureContentoftheSoilLayer () const
bool isInitialVolumetricMoistureContentoftheSoilLayerDefaulted () const
std::string moistureDiffusionCalculationMethod () const
bool isMoistureDiffusionCalculationMethodDefaulted () const
bool setLeafAreaIndex (double value)
bool setLeafReflectivity (double value)
bool setLeafEmissivity (double value)
bool setMinimumStomatalResistance (double value)
bool setSoilLayerName (const std::string &name)
bool setRoughness (const std::string &value)
bool setDensity (double value)
 Set density of dry soil (kg/m^3). More...
bool setSpecificHeat (double value)
 Set specific heat of dry soil (J/kg*K). More...
bool setSaturationVolumetricMoistureContent (double value)
 Set the maximum moisture content of the soil layer by volume fraction. More...
bool setResidualVolumetricMoistureContent (double value)
bool setInitialVolumetricMoistureConent (double value)
bool setMoistureDiffusionCalculationMethod (const std::string &value)
bool setHeightofPlants (double heightofPlants)
void resetHeightofPlants ()
void resetLeafAreaIndex ()
void resetLeafReflectivity ()
void resetLeafEmissivity ()
void resetMinimumStomatalResistance ()
void resetSoilLayerName ()
void resetRoughness ()
bool setThickness (double thickness)
void resetThickness ()
bool setConductivityofDrySoil (double conductivityofDrySoil)
void resetConductivityofDrySoil ()
bool setDensityofDrySoil (double densityofDrySoil)
void resetDensityofDrySoil ()
bool setSpecificHeatofDrySoil (double specificHeatofDrySoil)
void resetSpecificHeatofDrySoil ()
bool setThermalAbsorptance (double thermalAbsorptance)
void resetThermalAbsorptance ()
bool setSolarAbsorptance (double solarAbsorptance)
void resetSolarAbsorptance ()
bool setVisibleAbsorptance (double visibleAbsorptance)
void resetVisibleAbsorptance ()
bool setSaturationVolumetricMoistureContentoftheSoilLayer (double saturationVolumetricMoistureContentoftheSoilLayer)
void resetSaturationVolumetricMoistureContentoftheSoilLayer ()
bool setResidualVolumetricMoistureContentoftheSoilLayer (double residualVolumetricMoistureContentoftheSoilLayer)
void resetResidualVolumetricMoistureContentoftheSoilLayer ()
bool setInitialVolumetricMoistureContentoftheSoilLayer (double initialVolumetricMoistureContentoftheSoilLayer)
void resetInitialVolumetricMoistureContentoftheSoilLayer ()
void resetMoistureDiffusionCalculationMethod ()
- Public Member Functions inherited from openstudio::model::OpaqueMaterial
virtual ~OpaqueMaterial ()
double thermalConductivity () const
 Thermal conductivity of the Material in W/m*K. More...
double thermalConductance () const
 Thermal conductance of the Material in W/m^2*K. More...
double thermalResistivity () const
 Thermal resistivity of the Material in m*K/W. More...
double thermalResistance () const
 Thermal resistance of the Material in m^2*K/W. More...
double thermalAbsorptance () const
 Thermal absorptance of the Material (dimensionless fraction). More...
boost::optional< double > thermalReflectance () const
 Thermal reflectance of the Material (dimensionless fraction). More...
double solarAbsorptance () const
 Solar absorptance of the Material (dimensionless fraction). More...
boost::optional< double > solarReflectance () const
 Solar reflectance of the Material (dimensionless fraction). More...
double visibleAbsorptance () const
 Visible absorptance of the Material (dimensionless fraction). More...
boost::optional< double > visibleReflectance () const
 Visible reflectance of the Material (dimensionless fraction). More...
bool setThermalConductivity (double value)
 Set the thermal conductivity (W/m*K). More...
bool setThermalConductance (double value)
 Set the thermal conductance (W/m^2*K). More...
bool setThermalResistivity (double value)
 Set the thermal resistivity (m*K/W). More...
bool setThermalResistance (double value)
 Set the thermal resistance (m^2*K/W). More...
bool setThermalAbsorptance (double value)
 Set the thermal absorptance (dimensionless fraction). More...
bool setThermalReflectance (boost::optional< double > value)
 Set the thermal reflectance (dimensionless fraction). More...
bool setSolarAbsorptance (boost::optional< double > value)
 Set the solar absorptance (dimensionless fraction). More...
bool setSolarReflectance (boost::optional< double > value)
 Set the solar reflectance (dimensionless fraction). More...
bool setVisibleAbsorptance (boost::optional< double > value)
 Set the visible absorptance (dimensionless fraction). More...
bool setVisibleReflectance (boost::optional< double > value)
 Set the visible reflectance (dimensionless fraction). More...
boost::optional< double > heatCapacity () const
 Energy it takes to raise the temperature of this material 1 K (J/m^2*K). More...
- Public Member Functions inherited from openstudio::model::Material
virtual ~Material ()
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...
bool setThickness (double value)
 Set thickness to value (m). More...
< MaterialPropertyMoisturePenetrationDepthSettings
createMaterialPropertyMoisturePenetrationDepthSettings (double waterVaporDiffusionResistanceFactor, double moistureEquationCoefficientA, double moistureEquationCoefficientB, double moistureEquationCoefficientC, double moistureEquationCoefficientD, double coatingLayerThickness, double coatingLayerWaterVaporDiffusionResistanceFactor)
< 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...
< 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

Static Public Member Functions

static IddObjectType iddObjectType ()
static std::vector< std::string > moistureDiffusionCalculationMethodValues ()
static std::vector< std::string > roughnessValues ()

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< RoofVegetation
typedef std::vector
< RoofVegetation

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

RoofVegetation is a OpaqueMaterial that wraps the OpenStudio IDD object 'OS:Material:RoofVegetation'.

Constructor & Destructor Documentation

openstudio::model::RoofVegetation::RoofVegetation ( const Model model,
std::string  roughness = "Smooth" 
virtual openstudio::model::RoofVegetation::~RoofVegetation ( )

Member Function Documentation

double openstudio::model::RoofVegetation::conductivityofDrySoil ( ) const
double openstudio::model::RoofVegetation::density ( ) const

Density of dry soil (kg/m^3).

double openstudio::model::RoofVegetation::densityofDrySoil ( ) const
double openstudio::model::RoofVegetation::heightofPlants ( ) const
static IddObjectType openstudio::model::RoofVegetation::iddObjectType ( )
double openstudio::model::RoofVegetation::initialVolumetricMoistureContent ( ) const
double openstudio::model::RoofVegetation::initialVolumetricMoistureContentoftheSoilLayer ( ) const
bool openstudio::model::RoofVegetation::isConductivityofDrySoilDefaulted ( ) const
bool openstudio::model::RoofVegetation::isDensityofDrySoilDefaulted ( ) const
bool openstudio::model::RoofVegetation::isHeightofPlantsDefaulted ( ) const
bool openstudio::model::RoofVegetation::isInitialVolumetricMoistureContentoftheSoilLayerDefaulted ( ) const
bool openstudio::model::RoofVegetation::isLeafAreaIndexDefaulted ( ) const
bool openstudio::model::RoofVegetation::isLeafEmissivityDefaulted ( ) const
bool openstudio::model::RoofVegetation::isLeafReflectivityDefaulted ( ) const
bool openstudio::model::RoofVegetation::isMinimumStomatalResistanceDefaulted ( ) const
bool openstudio::model::RoofVegetation::isMoistureDiffusionCalculationMethodDefaulted ( ) const
bool openstudio::model::RoofVegetation::isResidualVolumetricMoistureContentoftheSoilLayerDefaulted ( ) const
bool openstudio::model::RoofVegetation::isRoughnessDefaulted ( ) const
bool openstudio::model::RoofVegetation::isSaturationVolumetricMoistureContentoftheSoilLayerDefaulted ( ) const
bool openstudio::model::RoofVegetation::isSoilLayerNameDefaulted ( ) const
bool openstudio::model::RoofVegetation::isSolarAbsorptanceDefaulted ( ) const
bool openstudio::model::RoofVegetation::isSpecificHeatofDrySoilDefaulted ( ) const
bool openstudio::model::RoofVegetation::isThermalAbsorptanceDefaulted ( ) const
bool openstudio::model::RoofVegetation::isThicknessDefaulted ( ) const
bool openstudio::model::RoofVegetation::isVisibleAbsorptanceDefaulted ( ) const
double openstudio::model::RoofVegetation::leafAreaIndex ( ) const
double openstudio::model::RoofVegetation::leafEmissivity ( ) const
double openstudio::model::RoofVegetation::leafReflectivity ( ) const
double openstudio::model::RoofVegetation::minimumStomatalResistance ( ) const
std::string openstudio::model::RoofVegetation::moistureDiffusionCalculationMethod ( ) const
static std::vector<std::string> openstudio::model::RoofVegetation::moistureDiffusionCalculationMethodValues ( )
void openstudio::model::RoofVegetation::resetConductivityofDrySoil ( )
void openstudio::model::RoofVegetation::resetDensityofDrySoil ( )
void openstudio::model::RoofVegetation::resetHeightofPlants ( )
void openstudio::model::RoofVegetation::resetInitialVolumetricMoistureContentoftheSoilLayer ( )
void openstudio::model::RoofVegetation::resetLeafAreaIndex ( )
void openstudio::model::RoofVegetation::resetLeafEmissivity ( )
void openstudio::model::RoofVegetation::resetLeafReflectivity ( )
void openstudio::model::RoofVegetation::resetMinimumStomatalResistance ( )
void openstudio::model::RoofVegetation::resetMoistureDiffusionCalculationMethod ( )
void openstudio::model::RoofVegetation::resetResidualVolumetricMoistureContentoftheSoilLayer ( )
void openstudio::model::RoofVegetation::resetRoughness ( )
void openstudio::model::RoofVegetation::resetSaturationVolumetricMoistureContentoftheSoilLayer ( )
void openstudio::model::RoofVegetation::resetSoilLayerName ( )
void openstudio::model::RoofVegetation::resetSolarAbsorptance ( )
void openstudio::model::RoofVegetation::resetSpecificHeatofDrySoil ( )
void openstudio::model::RoofVegetation::resetThermalAbsorptance ( )
void openstudio::model::RoofVegetation::resetThickness ( )
void openstudio::model::RoofVegetation::resetVisibleAbsorptance ( )
double openstudio::model::RoofVegetation::residualVolumetricMoistureContent ( ) const
double openstudio::model::RoofVegetation::residualVolumetricMoistureContentoftheSoilLayer ( ) const
std::string openstudio::model::RoofVegetation::roughness ( ) const
static std::vector<std::string> openstudio::model::RoofVegetation::roughnessValues ( )
double openstudio::model::RoofVegetation::saturationVolumetricMoistureContent ( ) const

Maximum moisture content of the soil layer by volume fraction.

double openstudio::model::RoofVegetation::saturationVolumetricMoistureContentoftheSoilLayer ( ) const
bool openstudio::model::RoofVegetation::setConductivityofDrySoil ( double  conductivityofDrySoil)
bool openstudio::model::RoofVegetation::setDensity ( double  value)

Set density of dry soil (kg/m^3).

bool openstudio::model::RoofVegetation::setDensityofDrySoil ( double  densityofDrySoil)
bool openstudio::model::RoofVegetation::setHeightofPlants ( double  heightofPlants)
bool openstudio::model::RoofVegetation::setInitialVolumetricMoistureConent ( double  value)
bool openstudio::model::RoofVegetation::setInitialVolumetricMoistureContentoftheSoilLayer ( double  initialVolumetricMoistureContentoftheSoilLayer)
bool openstudio::model::RoofVegetation::setLeafAreaIndex ( double  value)
bool openstudio::model::RoofVegetation::setLeafEmissivity ( double  value)
bool openstudio::model::RoofVegetation::setLeafReflectivity ( double  value)
bool openstudio::model::RoofVegetation::setMinimumStomatalResistance ( double  value)
bool openstudio::model::RoofVegetation::setMoistureDiffusionCalculationMethod ( const std::string &  value)
bool openstudio::model::RoofVegetation::setResidualVolumetricMoistureContent ( double  value)
bool openstudio::model::RoofVegetation::setResidualVolumetricMoistureContentoftheSoilLayer ( double  residualVolumetricMoistureContentoftheSoilLayer)
bool openstudio::model::RoofVegetation::setRoughness ( const std::string &  value)
bool openstudio::model::RoofVegetation::setSaturationVolumetricMoistureContent ( double  value)

Set the maximum moisture content of the soil layer by volume fraction.

bool openstudio::model::RoofVegetation::setSaturationVolumetricMoistureContentoftheSoilLayer ( double  saturationVolumetricMoistureContentoftheSoilLayer)
bool openstudio::model::RoofVegetation::setSoilLayerName ( const std::string &  name)
bool openstudio::model::RoofVegetation::setSolarAbsorptance ( double  solarAbsorptance)
bool openstudio::model::RoofVegetation::setSpecificHeat ( double  value)

Set specific heat of dry soil (J/kg*K).

bool openstudio::model::RoofVegetation::setSpecificHeatofDrySoil ( double  specificHeatofDrySoil)
bool openstudio::model::RoofVegetation::setThermalAbsorptance ( double  thermalAbsorptance)
bool openstudio::model::RoofVegetation::setThickness ( double  thickness)
bool openstudio::model::RoofVegetation::setVisibleAbsorptance ( double  visibleAbsorptance)
std::string openstudio::model::RoofVegetation::soilLayerName ( ) const
boost::optional<double> openstudio::model::RoofVegetation::solarAbsorptance ( ) const
double openstudio::model::RoofVegetation::specificHeat ( ) const

Specific heat of dry soil (J/kg*K).

double openstudio::model::RoofVegetation::specificHeatofDrySoil ( ) const
boost::optional<double> openstudio::model::RoofVegetation::thermalAbsorptance ( ) const
double openstudio::model::RoofVegetation::thickness ( ) const
boost::optional<double> openstudio::model::RoofVegetation::visibleAbsorptance ( ) const

Friends And Related Function Documentation

typedef boost::optional<RoofVegetation> OptionalRoofVegetation
typedef std::vector<RoofVegetation> RoofVegetationVector