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

#include <Screen.hpp>

+ Inheritance diagram for openstudio::model::Screen:

Public Member Functions

Constructors and Destructors
 Screen (const Model &model, double diffuseSolarReflectance=0.08, double diffuseVisibleReflectance=0.08, double screenMaterialSpacing=0.00157, double screenMaterialDiameter=0.000381)
 
virtual ~Screen ()=default
 
 Screen (const Screen &other)=default
 
 Screen (Screen &&other)=default
 
Screenoperator= (const Screen &)=default
 
Screenoperator= (Screen &&)=default
 
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...
 
std::string reflectedBeamTransmittanceAccountingMethod () const
 
bool isReflectedBeamTransmittanceAccountingMethodDefaulted () const
 
double diffuseSolarReflectance () const
 
double diffuseVisibleReflectance () const
 
double thermalHemisphericalEmissivity () const
 
bool isThermalHemisphericalEmissivityDefaulted () const
 
double conductivity () const
 
bool isConductivityDefaulted () const
 
double screenMaterialSpacing () const
 
double screenMaterialDiameter () const
 
double screentoGlassDistance () const
 
bool isScreentoGlassDistanceDefaulted () 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
 
std::string angleofResolutionforScreenTransmittanceOutputMap () const
 
bool isAngleofResolutionforScreenTransmittanceOutputMapDefaulted () const
 
Setters
bool setThermalConductivity (double value)
 Sets the conductivity of the material in W/m*K, if possible. More...
 
bool setThermalResistivity (double value)
 Sets the resistivity of the material in m*K/W, if possible. More...
 
bool setReflectedBeamTransmittanceAccountingMethod (const std::string &reflectedBeamTransmittanceAccountingMethod)
 
void resetReflectedBeamTransmittanceAccountingMethod ()
 
bool setDiffuseSolarReflectance (double diffuseSolarReflectance)
 
bool setDiffuseVisibleReflectance (double diffuseVisibleReflectance)
 
bool setThermalHemisphericalEmissivity (double thermalHemisphericalEmissivity)
 
void resetThermalHemisphericalEmissivity ()
 
bool setConductivity (double conductivity)
 
void resetConductivity ()
 
bool setScreenMaterialSpacing (double screenMaterialSpacing)
 
bool setScreenMaterialDiameter (double screenMaterialDiameter)
 
bool setScreentoGlassDistance (double screentoGlassDistance)
 
void resetScreentoGlassDistance ()
 
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 setAngleofResolutionforScreenTransmittanceOutputMap (const std::string &angleofResolutionforScreenTransmittanceOutputMap)
 
void resetAngleofResolutionforScreenTransmittanceOutputMap ()
 
- Public Member Functions inherited from openstudio::model::ShadingMaterial
virtual ~ShadingMaterial ()=default
 
 ShadingMaterial (const ShadingMaterial &other)=default
 
 ShadingMaterial (ShadingMaterial &&other)=default
 
ShadingMaterialoperator= (const ShadingMaterial &)=default
 
ShadingMaterialoperator= (ShadingMaterial &&)=default
 
- Public Member Functions inherited from openstudio::model::FenestrationMaterial
virtual ~FenestrationMaterial ()=default
 
 FenestrationMaterial (const FenestrationMaterial &other)=default
 
 FenestrationMaterial (FenestrationMaterial &&other)=default
 
FenestrationMaterialoperator= (const FenestrationMaterial &)=default
 
FenestrationMaterialoperator= (FenestrationMaterial &&)=default
 
- Public Member Functions inherited from openstudio::model::Material
virtual ~Material ()=default
 
 Material (const Material &other)=default
 
 Material (Material &&other)=default
 
Materialoperator= (const Material &)=default
 
Materialoperator= (Material &&)=default
 
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...
 
ResourceObjectoperator= (const ResourceObject &)=default
 
ResourceObjectoperator= (ResourceObject &&)=default
 
 ResourceObject (const ResourceObject &other)=default
 
 ResourceObject (ResourceObject &&other)=default
 
virtual ~ResourceObject ()=default
 
- 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...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject ()=default
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
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 (const std::string &valueName, const std::string &units) 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 std::vector< std::string > angleofResolutionforScreenTransmittanceOutputMapValues ()
 
static IddObjectType iddObjectType ()
 
static std::vector< std::string > reflectedBeamTransmittanceAccountingMethodValues ()
 
- 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.)

using OptionalScreen = boost::optional< Screen >
 
using ScreenVector = std::vector< Screen >
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- 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

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

Constructor & Destructor Documentation

openstudio::model::Screen::Screen ( const Model model,
double  diffuseSolarReflectance = 0.08,
double  diffuseVisibleReflectance = 0.08,
double  screenMaterialSpacing = 0.00157,
double  screenMaterialDiameter = 0.000381 
)
explicit
virtual openstudio::model::Screen::~Screen ( )
virtualdefault
openstudio::model::Screen::Screen ( const Screen other)
default
openstudio::model::Screen::Screen ( Screen &&  other)
default

Member Function Documentation

std::string openstudio::model::Screen::angleofResolutionforScreenTransmittanceOutputMap ( ) const
static std::vector<std::string> openstudio::model::Screen::angleofResolutionforScreenTransmittanceOutputMapValues ( )
static
double openstudio::model::Screen::bottomOpeningMultiplier ( ) const
double openstudio::model::Screen::conductivity ( ) const
double openstudio::model::Screen::diffuseSolarReflectance ( ) const
double openstudio::model::Screen::diffuseVisibleReflectance ( ) const
static IddObjectType openstudio::model::Screen::iddObjectType ( )
static
bool openstudio::model::Screen::isAngleofResolutionforScreenTransmittanceOutputMapDefaulted ( ) const
bool openstudio::model::Screen::isBottomOpeningMultiplierDefaulted ( ) const
bool openstudio::model::Screen::isConductivityDefaulted ( ) const
bool openstudio::model::Screen::isLeftSideOpeningMultiplierDefaulted ( ) const
bool openstudio::model::Screen::isReflectedBeamTransmittanceAccountingMethodDefaulted ( ) const
bool openstudio::model::Screen::isRightSideOpeningMultiplierDefaulted ( ) const
bool openstudio::model::Screen::isScreentoGlassDistanceDefaulted ( ) const
bool openstudio::model::Screen::isThermalHemisphericalEmissivityDefaulted ( ) const
bool openstudio::model::Screen::isTopOpeningMultiplierDefaulted ( ) const
double openstudio::model::Screen::leftSideOpeningMultiplier ( ) const
Screen& openstudio::model::Screen::operator= ( const Screen )
default
Screen& openstudio::model::Screen::operator= ( Screen &&  )
default
std::string openstudio::model::Screen::reflectedBeamTransmittanceAccountingMethod ( ) const
static std::vector<std::string> openstudio::model::Screen::reflectedBeamTransmittanceAccountingMethodValues ( )
static
void openstudio::model::Screen::resetAngleofResolutionforScreenTransmittanceOutputMap ( )
void openstudio::model::Screen::resetBottomOpeningMultiplier ( )
void openstudio::model::Screen::resetConductivity ( )
void openstudio::model::Screen::resetLeftSideOpeningMultiplier ( )
void openstudio::model::Screen::resetReflectedBeamTransmittanceAccountingMethod ( )
void openstudio::model::Screen::resetRightSideOpeningMultiplier ( )
void openstudio::model::Screen::resetScreentoGlassDistance ( )
void openstudio::model::Screen::resetThermalHemisphericalEmissivity ( )
void openstudio::model::Screen::resetTopOpeningMultiplier ( )
double openstudio::model::Screen::rightSideOpeningMultiplier ( ) const
double openstudio::model::Screen::screenMaterialDiameter ( ) const
double openstudio::model::Screen::screenMaterialSpacing ( ) const
double openstudio::model::Screen::screentoGlassDistance ( ) const
bool openstudio::model::Screen::setAngleofResolutionforScreenTransmittanceOutputMap ( const std::string &  angleofResolutionforScreenTransmittanceOutputMap)
bool openstudio::model::Screen::setBottomOpeningMultiplier ( double  bottomOpeningMultiplier)
bool openstudio::model::Screen::setConductivity ( double  conductivity)
bool openstudio::model::Screen::setDiffuseSolarReflectance ( double  diffuseSolarReflectance)
bool openstudio::model::Screen::setDiffuseVisibleReflectance ( double  diffuseVisibleReflectance)
bool openstudio::model::Screen::setLeftSideOpeningMultiplier ( double  leftSideOpeningMultiplier)
bool openstudio::model::Screen::setReflectedBeamTransmittanceAccountingMethod ( const std::string &  reflectedBeamTransmittanceAccountingMethod)
bool openstudio::model::Screen::setRightSideOpeningMultiplier ( double  rightSideOpeningMultiplier)
bool openstudio::model::Screen::setScreenMaterialDiameter ( double  screenMaterialDiameter)
bool openstudio::model::Screen::setScreenMaterialSpacing ( double  screenMaterialSpacing)
bool openstudio::model::Screen::setScreentoGlassDistance ( double  screentoGlassDistance)
bool openstudio::model::Screen::setThermalConductivity ( double  value)

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

bool openstudio::model::Screen::setThermalHemisphericalEmissivity ( double  thermalHemisphericalEmissivity)
bool openstudio::model::Screen::setThermalResistivity ( double  value)

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

bool openstudio::model::Screen::setTopOpeningMultiplier ( double  topOpeningMultiplier)
double openstudio::model::Screen::thermalConductance ( ) const

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

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

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

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

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

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

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

double openstudio::model::Screen::topOpeningMultiplier ( ) const

Friends And Related Function Documentation

using OptionalScreen = boost::optional<Screen>
related
using ScreenVector = std::vector<Screen>
related