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

#include <Shade.hpp>

+ Inheritance diagram for openstudio::model::Shade:

Public Member Functions

Constructors and Destructors
 Shade (const Model &model, double solarTransmittance=0.4, double solarReflectance=0.5, double visibleTransmittance=0.4, double visibleReflectance=0.5, double thermalHemisphericalEmissivity=0.9, double thermalTransmittance=0.0, double thickness=0.005, double conductivity=0.1)
 
virtual ~Shade ()
 
Getters
double thermalConductivity () const
 The conductivity of the material in W/m*K. More...
 
double thermalConductance () const
 The conductance of the material in W/m^2*K. More...
 
double thermalResistivity () const
 The resistivity of the material in m*K/W. More...
 
double thermalResistance () const
 The resistance of the material in m^2*K/W. More...
 
double solarTransmittance () const
 
double solarReflectance () const
 
double visibleTransmittance () const
 
double visibleReflectance () const
 
double thermalHemisphericalEmissivity () const
 
double thermalTransmittance () const
 
double solarAbsorptance () const
 
double visibleAbsorptance () const
 
double thickness () const
 
double conductivity () const
 
double shadetoGlassDistance () const
 
bool isShadetoGlassDistanceDefaulted () const
 
double topOpeningMultiplier () const
 
bool isTopOpeningMultiplierDefaulted () const
 
double bottomOpeningMultiplier () const
 
bool isBottomOpeningMultiplierDefaulted () const
 
double leftSideOpeningMultiplier () const
 
bool isLeftSideOpeningMultiplierDefaulted () const
 
double rightSideOpeningMultiplier () const
 
bool isRightSideOpeningMultiplierDefaulted () const
 
double airflowPermeability () const
 
bool isAirflowPermeabilityDefaulted () const
 
Setters
bool setThermalConductivity (double value)
 Sets the conductivity of the material in W/m*K, if possible. More...
 
bool setThermalConductance (double value)
 Sets the conductance of the material in W/m^2*K, if possible. More...
 
bool setThermalResistivity (double value)
 Sets the resistivity of the material in m*K/W, if possible. More...
 
bool setThermalResistance (double value)
 Sets the resistance of the material in m^2*K/W, if possible. More...
 
bool setThermalTransmittance (double thermalTransmittance)
 
bool setSolarTransmittance (double solarTransmittance)
 
bool setSolarReflectance (double solarReflectance)
 
bool setVisibleTransmittance (double visibleTransmittance)
 
bool setVisibleReflectance (double visibleReflectance)
 
bool setThermalHemisphericalEmissivity (double thermalHemisphericalEmissivity)
 
bool setThickness (double thickness)
 
bool setConductivity (double conductivity)
 
bool setShadetoGlassDistance (double shadetoGlassDistance)
 
void resetShadetoGlassDistance ()
 
bool setTopOpeningMultiplier (double topOpeningMultiplier)
 
void resetTopOpeningMultiplier ()
 
bool setBottomOpeningMultiplier (double bottomOpeningMultiplier)
 
void resetBottomOpeningMultiplier ()
 
bool setLeftSideOpeningMultiplier (double leftSideOpeningMultiplier)
 
void resetLeftSideOpeningMultiplier ()
 
bool setRightSideOpeningMultiplier (double rightSideOpeningMultiplier)
 
void resetRightSideOpeningMultiplier ()
 
bool setAirflowPermeability (double airflowPermeability)
 
void resetAirflowPermeability ()
 
- Public Member Functions inherited from openstudio::model::ShadingMaterial
virtual ~ShadingMaterial ()
 
- Public Member Functions inherited from openstudio::model::FenestrationMaterial
virtual ~FenestrationMaterial ()
 
- Public Member Functions inherited from openstudio::model::Material
virtual ~Material ()
 
double thickness () const
 
boost::optional< double > getVisibleTransmittance () const
 
boost::optional< double > interiorVisibleAbsorptance () const
 
boost::optional< double > exteriorVisibleAbsorptance () const
 
StandardsInformationMaterial standardsInformation () const
 Returns this materials's standards information, constructing a new object if necessary. More...
 
bool setThickness (double value)
 
- 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...
 
boost::optional< std::string > cadObjectId () const
 
bool setCADObjectId (const std::string &cadObjectId)
 
boost::optional< std::string > gbXMLId () const
 
bool setGBXMLId (const std::string &gbXMLId)
 
boost::optional< std::string > displayName () const
 
bool setDisplayName (const std::string &displayName)
 
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 Public Member Functions inherited from openstudio::model::FenestrationMaterial
static double ufactorInsideAirTemperature ()
 Returns the inside air temperature used by EnergyPlus for calculating fenestration u-factors (K). More...
 
static double ufactorOutsideAirTemperature ()
 Returns the outside air temperature used by EnergyPlus for calculating fenestration u-factors (K). More...
 
static const std::vector< double > airThermalConductivityCoefficients ()
 Returns the conductivity coefficients for air. More...
 
static const std::vector< double > airViscosityCoefficients ()
 Returns the viscosity coefficients for air. More...
 
static const std::vector< double > airSpecificHeatCoefficients ()
 Returns the specific heat coefficients for air. More...
 
static double airMolecularWeight ()
 The molecular weight of air (u). More...
 
static const std::vector< double > argonThermalConductivityCoefficients ()
 Returns the conductivity coefficients for argon. More...
 
static const std::vector< double > argonViscosityCoefficients ()
 Returns the viscosity coefficients for argon. More...
 
static const std::vector< double > argonSpecificHeatCoefficients ()
 Returns the specific heat coefficients for argon. More...
 
static double argonMolecularWeight ()
 The molecular weight of argon (u). More...
 
static const std::vector< double > kryptonThermalConductivityCoefficients ()
 Returns the conductivity coefficients for krypton. More...
 
static const std::vector< double > kryptonViscosityCoefficients ()
 Returns the viscosity coefficients for krypton. More...
 
static const std::vector< double > kryptonSpecificHeatCoefficients ()
 Returns the specific heat coefficients for krypton. More...
 
static double kryptonMolecularWeight ()
 The molecular weight of krypton (u). More...
 
static const std::vector< double > xenonThermalConductivityCoefficients ()
 Returns the conductivity coefficients for xenon. More...
 
static const std::vector< double > xenonViscosityCoefficients ()
 Returns the viscosity coefficients for xenon. More...
 
static const std::vector< double > xenonSpecificHeatCoefficients ()
 Returns the specific heat coefficients for xenon. More...
 
static double xenonMolecularWeight ()
 The molecular weight of xenon (u). More...
 

Related Functions

(Note that these are not member functions.)

typedef boost::optional< ShadeOptionalShade
 
typedef std::vector< ShadeShadeVector
 

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

Shade is a ShadingMaterial that wraps the OpenStudio IDD object 'OS:WindowMaterial:Shade'.

Constructor & Destructor Documentation

openstudio::model::Shade::Shade ( const Model model,
double  solarTransmittance = 0.4,
double  solarReflectance = 0.5,
double  visibleTransmittance = 0.4,
double  visibleReflectance = 0.5,
double  thermalHemisphericalEmissivity = 0.9,
double  thermalTransmittance = 0.0,
double  thickness = 0.005,
double  conductivity = 0.1 
)
explicit
virtual openstudio::model::Shade::~Shade ( )
inlinevirtual

Member Function Documentation

double openstudio::model::Shade::airflowPermeability ( ) const
double openstudio::model::Shade::bottomOpeningMultiplier ( ) const
double openstudio::model::Shade::conductivity ( ) const
static IddObjectType openstudio::model::Shade::iddObjectType ( )
static
bool openstudio::model::Shade::isAirflowPermeabilityDefaulted ( ) const
bool openstudio::model::Shade::isBottomOpeningMultiplierDefaulted ( ) const
bool openstudio::model::Shade::isLeftSideOpeningMultiplierDefaulted ( ) const
bool openstudio::model::Shade::isRightSideOpeningMultiplierDefaulted ( ) const
bool openstudio::model::Shade::isShadetoGlassDistanceDefaulted ( ) const
bool openstudio::model::Shade::isTopOpeningMultiplierDefaulted ( ) const
double openstudio::model::Shade::leftSideOpeningMultiplier ( ) const
void openstudio::model::Shade::resetAirflowPermeability ( )
void openstudio::model::Shade::resetBottomOpeningMultiplier ( )
void openstudio::model::Shade::resetLeftSideOpeningMultiplier ( )
void openstudio::model::Shade::resetRightSideOpeningMultiplier ( )
void openstudio::model::Shade::resetShadetoGlassDistance ( )
void openstudio::model::Shade::resetTopOpeningMultiplier ( )
double openstudio::model::Shade::rightSideOpeningMultiplier ( ) const
bool openstudio::model::Shade::setAirflowPermeability ( double  airflowPermeability)
bool openstudio::model::Shade::setBottomOpeningMultiplier ( double  bottomOpeningMultiplier)
bool openstudio::model::Shade::setConductivity ( double  conductivity)
bool openstudio::model::Shade::setLeftSideOpeningMultiplier ( double  leftSideOpeningMultiplier)
bool openstudio::model::Shade::setRightSideOpeningMultiplier ( double  rightSideOpeningMultiplier)
bool openstudio::model::Shade::setShadetoGlassDistance ( double  shadetoGlassDistance)
bool openstudio::model::Shade::setSolarReflectance ( double  solarReflectance)
bool openstudio::model::Shade::setSolarTransmittance ( double  solarTransmittance)
bool openstudio::model::Shade::setThermalConductance ( double  value)

Sets the conductance of the material in W/m^2*K, if possible.

Sets thickness to achieve conductivity.

bool openstudio::model::Shade::setThermalConductivity ( double  value)

Sets the conductivity of the material in W/m*K, if possible.

bool openstudio::model::Shade::setThermalHemisphericalEmissivity ( double  thermalHemisphericalEmissivity)
bool openstudio::model::Shade::setThermalResistance ( double  value)

Sets the resistance of the material in m^2*K/W, if possible.

Sets thickness to achieve resistivity.

bool openstudio::model::Shade::setThermalResistivity ( double  value)

Sets the resistivity of the material in m*K/W, if possible.

bool openstudio::model::Shade::setThermalTransmittance ( double  thermalTransmittance)
bool openstudio::model::Shade::setThickness ( double  thickness)
bool openstudio::model::Shade::setTopOpeningMultiplier ( double  topOpeningMultiplier)
bool openstudio::model::Shade::setVisibleReflectance ( double  visibleReflectance)
bool openstudio::model::Shade::setVisibleTransmittance ( double  visibleTransmittance)
double openstudio::model::Shade::shadetoGlassDistance ( ) const
double openstudio::model::Shade::solarAbsorptance ( ) const
double openstudio::model::Shade::solarReflectance ( ) const
double openstudio::model::Shade::solarTransmittance ( ) const
double openstudio::model::Shade::thermalConductance ( ) const

The conductance of the material in W/m^2*K.

double openstudio::model::Shade::thermalConductivity ( ) const

The conductivity of the material in W/m*K.

double openstudio::model::Shade::thermalHemisphericalEmissivity ( ) const
double openstudio::model::Shade::thermalResistance ( ) const

The resistance of the material in m^2*K/W.

double openstudio::model::Shade::thermalResistivity ( ) const

The resistivity of the material in m*K/W.

double openstudio::model::Shade::thermalTransmittance ( ) const
double openstudio::model::Shade::thickness ( ) const
double openstudio::model::Shade::topOpeningMultiplier ( ) const
double openstudio::model::Shade::visibleAbsorptance ( ) const
double openstudio::model::Shade::visibleReflectance ( ) const
double openstudio::model::Shade::visibleTransmittance ( ) const

Friends And Related Function Documentation

typedef boost::optional<Shade> OptionalShade
related
typedef std::vector<Shade> ShadeVector
related