RoofVegetation Class Reference

#include "RoofVegetation.hpp"

Inheritance diagram for openstudio::model::RoofVegetation:

Public Member Functions
	RoofVegetation (const Model &model, std::string roughness="Smooth")
virtual	~RoofVegetation ()
double	heightofPlants () const
Quantity	getHeightofPlants (bool returnIP=false) const
bool	isHeightofPlantsDefaulted () const
double	leafAreaIndex () const
Quantity	getLeafAreaIndex (bool returnIP=false) const
bool	isLeafAreaIndexDefaulted () const
double	leafReflectivity () const
Quantity	getLeafReflectivity (bool returnIP=false) const
bool	isLeafReflectivityDefaulted () const
double	leafEmissivity () const
Quantity	getLeafEmissivity (bool returnIP=false) const
bool	isLeafEmissivityDefaulted () const
double	minimumStomatalResistance () const
Quantity	getMinimumStomatalResistance (bool returnIP=false) const
bool	isMinimumStomatalResistanceDefaulted () const
std::string	soilLayerName () const
bool	isSoilLayerNameDefaulted () const
std::string	roughness () const
double	density () const
double	specificHeat () const
double	saturationVolumetricMoistureContent () const
double	residualVolumetricMoistureContent () const
double	initialVolumetricMoistureContent () const
bool	isRoughnessDefaulted () const
double	thickness () const
Quantity	getThickness (bool returnIP=false) const
bool	isThicknessDefaulted () const
double	conductivityofDrySoil () const
Quantity	getConductivityofDrySoil (bool returnIP=false) const
bool	isConductivityofDrySoilDefaulted () const
double	densityofDrySoil () const
Quantity	getDensityofDrySoil (bool returnIP=false) const
bool	isDensityofDrySoilDefaulted () const
double	specificHeatofDrySoil () const
Quantity	getSpecificHeatofDrySoil (bool returnIP=false) const
bool	isSpecificHeatofDrySoilDefaulted () const
boost::optional< double >	thermalAbsorptance () const
Quantity	getThermalAbsorptance (bool returnIP=false) const
bool	isThermalAbsorptanceDefaulted () const
boost::optional< double >	solarAbsorptance () const
Quantity	getSolarAbsorptance (bool returnIP=false) const
bool	isSolarAbsorptanceDefaulted () const
boost::optional< double >	visibleAbsorptance () const
Quantity	getVisibleAbsorptance (bool returnIP=false) const
bool	isVisibleAbsorptanceDefaulted () const
double	saturationVolumetricMoistureContentoftheSoilLayer () const
Quantity	getSaturationVolumetricMoistureContentoftheSoilLayer (bool returnIP=false) const
bool	isSaturationVolumetricMoistureContentoftheSoilLayerDefaulted () const
double	residualVolumetricMoistureContentoftheSoilLayer () const
Quantity	getResidualVolumetricMoistureContentoftheSoilLayer (bool returnIP=false) const
bool	isResidualVolumetricMoistureContentoftheSoilLayerDefaulted () const
double	initialVolumetricMoistureContentoftheSoilLayer () const
Quantity	getInitialVolumetricMoistureContentoftheSoilLayer (bool returnIP=false) 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)
bool	setSpecificHeat (double value)
bool	setSaturationVolumetricMoistureContent (double value)
bool	setResidualVolumetricMoistureContent (double value)
bool	setInitialVolumetricMoistureConent (double value)
bool	setMoistureDiffusionCalculationMethod (const std::string &value)
bool	setHeightofPlants (double heightofPlants)
bool	setHeightofPlants (const Quantity &heightofPlants)
void	resetHeightofPlants ()
bool	setLeafAreaIndex (const Quantity &leafAreaIndex)
void	resetLeafAreaIndex ()
bool	setLeafReflectivity (const Quantity &leafReflectivity)
void	resetLeafReflectivity ()
bool	setLeafEmissivity (const Quantity &leafEmissivity)
void	resetLeafEmissivity ()
bool	setMinimumStomatalResistance (const Quantity &minimumStomatalResistance)
void	resetMinimumStomatalResistance ()
void	resetSoilLayerName ()
void	resetRoughness ()
bool	setThickness (double thickness)
bool	setThickness (const Quantity &thickness)
void	resetThickness ()
bool	setConductivityofDrySoil (double conductivityofDrySoil)
bool	setConductivityofDrySoil (const Quantity &conductivityofDrySoil)
void	resetConductivityofDrySoil ()
bool	setDensityofDrySoil (double densityofDrySoil)
bool	setDensityofDrySoil (const Quantity &densityofDrySoil)
void	resetDensityofDrySoil ()
bool	setSpecificHeatofDrySoil (double specificHeatofDrySoil)
bool	setSpecificHeatofDrySoil (const Quantity &specificHeatofDrySoil)
void	resetSpecificHeatofDrySoil ()
bool	setThermalAbsorptance (double thermalAbsorptance)
bool	setThermalAbsorptance (const Quantity &thermalAbsorptance)
void	resetThermalAbsorptance ()
bool	setSolarAbsorptance (double solarAbsorptance)
bool	setSolarAbsorptance (const Quantity &solarAbsorptance)
void	resetSolarAbsorptance ()
bool	setVisibleAbsorptance (double visibleAbsorptance)
bool	setVisibleAbsorptance (const Quantity &visibleAbsorptance)
void	resetVisibleAbsorptance ()
bool	setSaturationVolumetricMoistureContentoftheSoilLayer (double saturationVolumetricMoistureContentoftheSoilLayer)
bool	setSaturationVolumetricMoistureContentoftheSoilLayer (const Quantity &saturationVolumetricMoistureContentoftheSoilLayer)
void	resetSaturationVolumetricMoistureContentoftheSoilLayer ()
bool	setResidualVolumetricMoistureContentoftheSoilLayer (double residualVolumetricMoistureContentoftheSoilLayer)
bool	setResidualVolumetricMoistureContentoftheSoilLayer (const Quantity &residualVolumetricMoistureContentoftheSoilLayer)
void	resetResidualVolumetricMoistureContentoftheSoilLayer ()
bool	setInitialVolumetricMoistureContentoftheSoilLayer (double initialVolumetricMoistureContentoftheSoilLayer)
bool	setInitialVolumetricMoistureContentoftheSoilLayer (const Quantity &initialVolumetricMoistureContentoftheSoilLayer)
void	resetInitialVolumetricMoistureContentoftheSoilLayer ()
void	resetMoistureDiffusionCalculationMethod ()

Static Public Member Functions
static IddObjectType	iddObjectType ()
static std::vector< std::string >	moistureDiffusionCalculationMethodValues ()
static std::vector< std::string >	roughnessValues ()

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

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"  )

explicit

virtual openstudio::model::RoofVegetation::~RoofVegetation ( )

inlinevirtual

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

Quantity openstudio::model::RoofVegetation::getConductivityofDrySoil

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getDensityofDrySoil

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getHeightofPlants

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getInitialVolumetricMoistureContentoftheSoilLayer

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getLeafAreaIndex

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getLeafEmissivity

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getLeafReflectivity

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getMinimumStomatalResistance

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getResidualVolumetricMoistureContentoftheSoilLayer

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getSaturationVolumetricMoistureContentoftheSoilLayer

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getSolarAbsorptance

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getSpecificHeatofDrySoil

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getThermalAbsorptance

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getThickness

(

bool

returnIP = false

)

const

Quantity openstudio::model::RoofVegetation::getVisibleAbsorptance

(

bool

returnIP = false

)

const

double openstudio::model::RoofVegetation::heightofPlants

(

)

const

static IddObjectType openstudio::model::RoofVegetation::iddObjectType ( )

static

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 ( )

static

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 ( )

static

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::setConductivityofDrySoil

(

const Quantity &

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::setDensityofDrySoil

(

const Quantity &

densityofDrySoil

)

bool openstudio::model::RoofVegetation::setHeightofPlants

(

double

heightofPlants

)

bool openstudio::model::RoofVegetation::setHeightofPlants

(

const Quantity &

heightofPlants

)

bool openstudio::model::RoofVegetation::setInitialVolumetricMoistureConent

(

double

value

)

bool openstudio::model::RoofVegetation::setInitialVolumetricMoistureContentoftheSoilLayer

(

double

initialVolumetricMoistureContentoftheSoilLayer

)

bool openstudio::model::RoofVegetation::setInitialVolumetricMoistureContentoftheSoilLayer

(

const Quantity &

initialVolumetricMoistureContentoftheSoilLayer

)

bool openstudio::model::RoofVegetation::setLeafAreaIndex

(

double

value

)

bool openstudio::model::RoofVegetation::setLeafAreaIndex

(

const Quantity &

leafAreaIndex

)

bool openstudio::model::RoofVegetation::setLeafEmissivity

(

double

value

)

bool openstudio::model::RoofVegetation::setLeafEmissivity

(

const Quantity &

leafEmissivity

)

bool openstudio::model::RoofVegetation::setLeafReflectivity

(

double

value

)

bool openstudio::model::RoofVegetation::setLeafReflectivity

(

const Quantity &

leafReflectivity

)

bool openstudio::model::RoofVegetation::setMinimumStomatalResistance

(

double

value

)

bool openstudio::model::RoofVegetation::setMinimumStomatalResistance

(

const Quantity &

minimumStomatalResistance

)

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::setResidualVolumetricMoistureContentoftheSoilLayer

(

const Quantity &

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::setSaturationVolumetricMoistureContentoftheSoilLayer

(

const Quantity &

saturationVolumetricMoistureContentoftheSoilLayer

)

bool openstudio::model::RoofVegetation::setSoilLayerName

(

const std::string &

name

)

bool openstudio::model::RoofVegetation::setSolarAbsorptance

(

double

solarAbsorptance

)

bool openstudio::model::RoofVegetation::setSolarAbsorptance

(

const Quantity &

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::setSpecificHeatofDrySoil

(

const Quantity &

specificHeatofDrySoil

)

bool openstudio::model::RoofVegetation::setThermalAbsorptance

(

double

thermalAbsorptance

)

bool openstudio::model::RoofVegetation::setThermalAbsorptance

(

const Quantity &

thermalAbsorptance

)

bool openstudio::model::RoofVegetation::setThickness

(

double

thickness

)

bool openstudio::model::RoofVegetation::setThickness

(

const Quantity &

thickness

)

bool openstudio::model::RoofVegetation::setVisibleAbsorptance

(

double

visibleAbsorptance

)

bool openstudio::model::RoofVegetation::setVisibleAbsorptance

(

const Quantity &

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

related

typedef std::vector<RoofVegetation> RoofVegetationVector

related