#include <Screen.hpp>
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 () |
Getters | |
double | thermalConductivity () const |
The conductivitiy 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 () |
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) |
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< ModelObject > | children () 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< ParentObject > | parent () const |
Return this object's parent in the hierarchy, if it has one. More... | |
std::vector< ResourceObject > | resources () 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< OutputVariable > | outputVariables () 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< LifeCycleCost > | lifeCycleCosts () 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< ScheduleTypeKey > | getScheduleTypeKeys (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< ModelObject > | connectedObject (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.) | |
typedef boost::optional< Screen > | OptionalScreen |
typedef std::vector< Screen > | ScreenVector |
Related Functions inherited from openstudio::model::ShadingMaterial | |
typedef boost::optional < ShadingMaterial > | OptionalShadingMaterial |
typedef std::vector < ShadingMaterial > | ShadingMaterialVector |
Related Functions inherited from openstudio::model::FenestrationMaterial | |
typedef std::vector < FenestrationMaterial > | FenestrationMaterialVector |
typedef boost::optional < FenestrationMaterial > | OptionalFenestrationMaterial |
Related Functions inherited from openstudio::model::Material | |
typedef std::vector< Material > | MaterialVector |
typedef boost::optional< Material > | OptionalMaterial |
Related Functions inherited from openstudio::model::ResourceObject | |
typedef boost::optional < ResourceObject > | OptionalResourceObject |
typedef std::vector < ResourceObject > | ResourceObjectVector |
Related Functions inherited from openstudio::model::ParentObject | |
std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true) |
Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
Related Functions inherited from openstudio::model::ModelObject | |
std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
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) | |
Screen is a ShadingMaterial that wraps the OpenStudio IDD object 'OS:WindowMaterial:Screen'.
|
explicit |
|
inlinevirtual |
std::string openstudio::model::Screen::angleofResolutionforScreenTransmittanceOutputMap | ( | ) | const |
|
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 |
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 |
std::string openstudio::model::Screen::reflectedBeamTransmittanceAccountingMethod | ( | ) | const |
|
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 conductivitiy 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 |
|
related |
|
related |