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

#include <Blind.hpp>

+ Inheritance diagram for openstudio::model::Blind:

Public Member Functions

Constructors and Destructors
 Blind (const Model &model, double slatWidth=0.025, double slatSeparation=0.01875, double frontSideSlatBeamSolarReflectance=0.5, double backSideSlatBeamSolarReflectance=0.5, double frontSideSlatDiffuseSolarReflectance=0.5, double backSideSlatDiffuseSolarReflectance=0.5, double slatBeamVisibleTransmittance=0.0)
 
virtual ~Blind ()
 
Getters
std::string slatOrientation () const
 
bool isSlatOrientationDefaulted () const
 
double slatWidth () const
 
double slatSeparation () const
 
double slatThickness () const
 
bool isSlatThicknessDefaulted () const
 
double slatAngle () const
 
bool isSlatAngleDefaulted () const
 
double slatConductivity () const
 
bool isSlatConductivityDefaulted () const
 
double slatBeamSolarTransmittance () const
 
bool isSlatBeamSolarTransmittanceDefaulted () const
 
double frontSideSlatBeamSolarReflectance () const
 
double backSideSlatBeamSolarReflectance () const
 
double slatDiffuseSolarTransmittance () const
 
bool isSlatDiffuseSolarTransmittanceDefaulted () const
 
double frontSideSlatDiffuseSolarReflectance () const
 
double backSideSlatDiffuseSolarReflectance () const
 
double slatBeamVisibleTransmittance () const
 
boost::optional< double > frontSideSlatBeamVisibleReflectance () const
 
boost::optional< double > backSideSlatBeamVisibleReflectance () const
 
double slatDiffuseVisibleTransmittance () const
 
bool isSlatDiffuseVisibleTransmittanceDefaulted () const
 
boost::optional< double > frontSideSlatDiffuseVisibleReflectance () const
 
boost::optional< double > backSideSlatDiffuseVisibleReflectance () const
 
double slatInfraredHemisphericalTransmittance () const
 
bool isSlatInfraredHemisphericalTransmittanceDefaulted () const
 
double frontSideSlatInfraredHemisphericalEmissivity () const
 
bool isFrontSideSlatInfraredHemisphericalEmissivityDefaulted () const
 
double backSideSlatInfraredHemisphericalEmissivity () const
 
bool isBackSideSlatInfraredHemisphericalEmissivityDefaulted () const
 
double blindtoGlassDistance () const
 
bool isBlindtoGlassDistanceDefaulted () const
 
double blindTopOpeningMultiplier () const
 
bool isBlindTopOpeningMultiplierDefaulted () const
 
double blindBottomOpeningMultiplier () const
 
bool isBlindBottomOpeningMultiplierDefaulted () const
 
double blindLeftSideOpeningMultiplier () const
 
bool isBlindLeftSideOpeningMultiplierDefaulted () const
 
double blindRightSideOpeningMultiplier () const
 
bool isBlindRightSideOpeningMultiplierDefaulted () const
 
double minimumSlatAngle () const
 
bool isMinimumSlatAngleDefaulted () const
 
double maximumSlatAngle () const
 
bool isMaximumSlatAngleDefaulted () const
 
Setters
bool setSlatOrientation (const std::string &slatOrientation)
 
void resetSlatOrientation ()
 
bool setSlatWidth (double slatWidth)
 
bool setSlatSeparation (double slatSeparation)
 
bool setSlatThickness (double slatThickness)
 
void resetSlatThickness ()
 
bool setSlatAngle (double slatAngle)
 
void resetSlatAngle ()
 
bool setSlatConductivity (double slatConductivity)
 
void resetSlatConductivity ()
 
bool setSlatBeamSolarTransmittance (double slatBeamSolarTransmittance)
 
void resetSlatBeamSolarTransmittance ()
 
bool setFrontSideSlatBeamSolarReflectance (double frontSideSlatBeamSolarReflectance)
 
bool setBackSideSlatBeamSolarReflectance (double backSideSlatBeamSolarReflectance)
 
bool setSlatDiffuseSolarTransmittance (double slatDiffuseSolarTransmittance)
 
void resetSlatDiffuseSolarTransmittance ()
 
bool setFrontSideSlatDiffuseSolarReflectance (double frontSideSlatDiffuseSolarReflectance)
 
bool setBackSideSlatDiffuseSolarReflectance (double backSideSlatDiffuseSolarReflectance)
 
bool setSlatBeamVisibleTransmittance (double slatBeamVisibleTransmittance)
 
bool setFrontSideSlatBeamVisibleReflectance (double frontSideSlatBeamVisibleReflectance)
 
void resetFrontSideSlatBeamVisibleReflectance ()
 
bool setBackSideSlatBeamVisibleReflectance (double backSideSlatBeamVisibleReflectance)
 
void resetBackSideSlatBeamVisibleReflectance ()
 
bool setSlatDiffuseVisibleTransmittance (double slatDiffuseVisibleTransmittance)
 
void resetSlatDiffuseVisibleTransmittance ()
 
bool setFrontSideSlatDiffuseVisibleReflectance (double frontSideSlatDiffuseVisibleReflectance)
 
void resetFrontSideSlatDiffuseVisibleReflectance ()
 
bool setBackSideSlatDiffuseVisibleReflectance (double backSideSlatDiffuseVisibleReflectance)
 
void resetBackSideSlatDiffuseVisibleReflectance ()
 
bool setSlatInfraredHemisphericalTransmittance (double slatInfraredHemisphericalTransmittance)
 
void resetSlatInfraredHemisphericalTransmittance ()
 
bool setFrontSideSlatInfraredHemisphericalEmissivity (double frontSideSlatInfraredHemisphericalEmissivity)
 
void resetFrontSideSlatInfraredHemisphericalEmissivity ()
 
bool setBackSideSlatInfraredHemisphericalEmissivity (double backSideSlatInfraredHemisphericalEmissivity)
 
void resetBackSideSlatInfraredHemisphericalEmissivity ()
 
bool setBlindtoGlassDistance (double blindtoGlassDistance)
 
void resetBlindtoGlassDistance ()
 
bool setBlindTopOpeningMultiplier (double blindTopOpeningMultiplier)
 
void resetBlindTopOpeningMultiplier ()
 
bool setBlindBottomOpeningMultiplier (double blindBottomOpeningMultiplier)
 
void resetBlindBottomOpeningMultiplier ()
 
bool setBlindLeftSideOpeningMultiplier (double blindLeftSideOpeningMultiplier)
 
void resetBlindLeftSideOpeningMultiplier ()
 
bool setBlindRightSideOpeningMultiplier (double blindRightSideOpeningMultiplier)
 
void resetBlindRightSideOpeningMultiplier ()
 
bool setMinimumSlatAngle (double minimumSlatAngle)
 
void resetMinimumSlatAngle ()
 
bool setMaximumSlatAngle (double maximumSlatAngle)
 
void resetMaximumSlatAngle ()
 
- 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< 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...
 
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 > slatOrientationValues ()
 
- 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 std::vector< BlindBlindVector
 
typedef boost::optional< BlindOptionalBlind
 

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

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

Constructor & Destructor Documentation

openstudio::model::Blind::Blind ( const Model model,
double  slatWidth = 0.025,
double  slatSeparation = 0.01875,
double  frontSideSlatBeamSolarReflectance = 0.5,
double  backSideSlatBeamSolarReflectance = 0.5,
double  frontSideSlatDiffuseSolarReflectance = 0.5,
double  backSideSlatDiffuseSolarReflectance = 0.5,
double  slatBeamVisibleTransmittance = 0.0 
)
explicit
virtual openstudio::model::Blind::~Blind ( )
inlinevirtual

Member Function Documentation

double openstudio::model::Blind::backSideSlatBeamSolarReflectance ( ) const
boost::optional<double> openstudio::model::Blind::backSideSlatBeamVisibleReflectance ( ) const
double openstudio::model::Blind::backSideSlatDiffuseSolarReflectance ( ) const
boost::optional<double> openstudio::model::Blind::backSideSlatDiffuseVisibleReflectance ( ) const
double openstudio::model::Blind::backSideSlatInfraredHemisphericalEmissivity ( ) const
double openstudio::model::Blind::blindBottomOpeningMultiplier ( ) const
double openstudio::model::Blind::blindLeftSideOpeningMultiplier ( ) const
double openstudio::model::Blind::blindRightSideOpeningMultiplier ( ) const
double openstudio::model::Blind::blindtoGlassDistance ( ) const
double openstudio::model::Blind::blindTopOpeningMultiplier ( ) const
double openstudio::model::Blind::frontSideSlatBeamSolarReflectance ( ) const
boost::optional<double> openstudio::model::Blind::frontSideSlatBeamVisibleReflectance ( ) const
double openstudio::model::Blind::frontSideSlatDiffuseSolarReflectance ( ) const
boost::optional<double> openstudio::model::Blind::frontSideSlatDiffuseVisibleReflectance ( ) const
double openstudio::model::Blind::frontSideSlatInfraredHemisphericalEmissivity ( ) const
static IddObjectType openstudio::model::Blind::iddObjectType ( )
static
bool openstudio::model::Blind::isBackSideSlatInfraredHemisphericalEmissivityDefaulted ( ) const
bool openstudio::model::Blind::isBlindBottomOpeningMultiplierDefaulted ( ) const
bool openstudio::model::Blind::isBlindLeftSideOpeningMultiplierDefaulted ( ) const
bool openstudio::model::Blind::isBlindRightSideOpeningMultiplierDefaulted ( ) const
bool openstudio::model::Blind::isBlindtoGlassDistanceDefaulted ( ) const
bool openstudio::model::Blind::isBlindTopOpeningMultiplierDefaulted ( ) const
bool openstudio::model::Blind::isFrontSideSlatInfraredHemisphericalEmissivityDefaulted ( ) const
bool openstudio::model::Blind::isMaximumSlatAngleDefaulted ( ) const
bool openstudio::model::Blind::isMinimumSlatAngleDefaulted ( ) const
bool openstudio::model::Blind::isSlatAngleDefaulted ( ) const
bool openstudio::model::Blind::isSlatBeamSolarTransmittanceDefaulted ( ) const
bool openstudio::model::Blind::isSlatConductivityDefaulted ( ) const
bool openstudio::model::Blind::isSlatDiffuseSolarTransmittanceDefaulted ( ) const
bool openstudio::model::Blind::isSlatDiffuseVisibleTransmittanceDefaulted ( ) const
bool openstudio::model::Blind::isSlatInfraredHemisphericalTransmittanceDefaulted ( ) const
bool openstudio::model::Blind::isSlatOrientationDefaulted ( ) const
bool openstudio::model::Blind::isSlatThicknessDefaulted ( ) const
double openstudio::model::Blind::maximumSlatAngle ( ) const
double openstudio::model::Blind::minimumSlatAngle ( ) const
void openstudio::model::Blind::resetBackSideSlatBeamVisibleReflectance ( )
void openstudio::model::Blind::resetBackSideSlatDiffuseVisibleReflectance ( )
void openstudio::model::Blind::resetBackSideSlatInfraredHemisphericalEmissivity ( )
void openstudio::model::Blind::resetBlindBottomOpeningMultiplier ( )
void openstudio::model::Blind::resetBlindLeftSideOpeningMultiplier ( )
void openstudio::model::Blind::resetBlindRightSideOpeningMultiplier ( )
void openstudio::model::Blind::resetBlindtoGlassDistance ( )
void openstudio::model::Blind::resetBlindTopOpeningMultiplier ( )
void openstudio::model::Blind::resetFrontSideSlatBeamVisibleReflectance ( )
void openstudio::model::Blind::resetFrontSideSlatDiffuseVisibleReflectance ( )
void openstudio::model::Blind::resetFrontSideSlatInfraredHemisphericalEmissivity ( )
void openstudio::model::Blind::resetMaximumSlatAngle ( )
void openstudio::model::Blind::resetMinimumSlatAngle ( )
void openstudio::model::Blind::resetSlatAngle ( )
void openstudio::model::Blind::resetSlatBeamSolarTransmittance ( )
void openstudio::model::Blind::resetSlatConductivity ( )
void openstudio::model::Blind::resetSlatDiffuseSolarTransmittance ( )
void openstudio::model::Blind::resetSlatDiffuseVisibleTransmittance ( )
void openstudio::model::Blind::resetSlatInfraredHemisphericalTransmittance ( )
void openstudio::model::Blind::resetSlatOrientation ( )
void openstudio::model::Blind::resetSlatThickness ( )
bool openstudio::model::Blind::setBackSideSlatBeamSolarReflectance ( double  backSideSlatBeamSolarReflectance)
bool openstudio::model::Blind::setBackSideSlatBeamVisibleReflectance ( double  backSideSlatBeamVisibleReflectance)
bool openstudio::model::Blind::setBackSideSlatDiffuseSolarReflectance ( double  backSideSlatDiffuseSolarReflectance)
bool openstudio::model::Blind::setBackSideSlatDiffuseVisibleReflectance ( double  backSideSlatDiffuseVisibleReflectance)
bool openstudio::model::Blind::setBackSideSlatInfraredHemisphericalEmissivity ( double  backSideSlatInfraredHemisphericalEmissivity)
bool openstudio::model::Blind::setBlindBottomOpeningMultiplier ( double  blindBottomOpeningMultiplier)
bool openstudio::model::Blind::setBlindLeftSideOpeningMultiplier ( double  blindLeftSideOpeningMultiplier)
bool openstudio::model::Blind::setBlindRightSideOpeningMultiplier ( double  blindRightSideOpeningMultiplier)
bool openstudio::model::Blind::setBlindtoGlassDistance ( double  blindtoGlassDistance)
bool openstudio::model::Blind::setBlindTopOpeningMultiplier ( double  blindTopOpeningMultiplier)
bool openstudio::model::Blind::setFrontSideSlatBeamSolarReflectance ( double  frontSideSlatBeamSolarReflectance)
bool openstudio::model::Blind::setFrontSideSlatBeamVisibleReflectance ( double  frontSideSlatBeamVisibleReflectance)
bool openstudio::model::Blind::setFrontSideSlatDiffuseSolarReflectance ( double  frontSideSlatDiffuseSolarReflectance)
bool openstudio::model::Blind::setFrontSideSlatDiffuseVisibleReflectance ( double  frontSideSlatDiffuseVisibleReflectance)
bool openstudio::model::Blind::setFrontSideSlatInfraredHemisphericalEmissivity ( double  frontSideSlatInfraredHemisphericalEmissivity)
bool openstudio::model::Blind::setMaximumSlatAngle ( double  maximumSlatAngle)
bool openstudio::model::Blind::setMinimumSlatAngle ( double  minimumSlatAngle)
bool openstudio::model::Blind::setSlatAngle ( double  slatAngle)
bool openstudio::model::Blind::setSlatBeamSolarTransmittance ( double  slatBeamSolarTransmittance)
bool openstudio::model::Blind::setSlatBeamVisibleTransmittance ( double  slatBeamVisibleTransmittance)
bool openstudio::model::Blind::setSlatConductivity ( double  slatConductivity)
bool openstudio::model::Blind::setSlatDiffuseSolarTransmittance ( double  slatDiffuseSolarTransmittance)
bool openstudio::model::Blind::setSlatDiffuseVisibleTransmittance ( double  slatDiffuseVisibleTransmittance)
bool openstudio::model::Blind::setSlatInfraredHemisphericalTransmittance ( double  slatInfraredHemisphericalTransmittance)
bool openstudio::model::Blind::setSlatOrientation ( const std::string &  slatOrientation)
bool openstudio::model::Blind::setSlatSeparation ( double  slatSeparation)
bool openstudio::model::Blind::setSlatThickness ( double  slatThickness)
bool openstudio::model::Blind::setSlatWidth ( double  slatWidth)
double openstudio::model::Blind::slatAngle ( ) const
double openstudio::model::Blind::slatBeamSolarTransmittance ( ) const
double openstudio::model::Blind::slatBeamVisibleTransmittance ( ) const
double openstudio::model::Blind::slatConductivity ( ) const
double openstudio::model::Blind::slatDiffuseSolarTransmittance ( ) const
double openstudio::model::Blind::slatDiffuseVisibleTransmittance ( ) const
double openstudio::model::Blind::slatInfraredHemisphericalTransmittance ( ) const
std::string openstudio::model::Blind::slatOrientation ( ) const
static std::vector<std::string> openstudio::model::Blind::slatOrientationValues ( )
static
double openstudio::model::Blind::slatSeparation ( ) const
double openstudio::model::Blind::slatThickness ( ) const
double openstudio::model::Blind::slatWidth ( ) const

Friends And Related Function Documentation

typedef std::vector<Blind> BlindVector
related
typedef boost::optional<Blind> OptionalBlind
related