ShadingControl Class Reference

#include "ShadingControl.hpp"

Inheritance diagram for openstudio::model::ShadingControl:

Public Member Functions
	ShadingControl (const Construction &construction)
	ShadingControl (const ShadingMaterial &shadingMaterial)
virtual	~ShadingControl ()
boost::optional< Construction >	construction () const
boost::optional< ShadingMaterial >	shadingMaterial () const
std::string	shadingType () const
std::string	shadingControlType () const
bool	isShadingControlTypeDefaulted () const
boost::optional< Schedule >	schedule () const
boost::optional< double >	setpoint () const
bool	isSetpointDefaulted () const
bool	setShadingType (const std::string &shadingType)
bool	setShadingControlType (const std::string &shadingControlType)
void	resetShadingControlType ()
bool	setSchedule (const Schedule &schedule)
void	resetSchedule ()
bool	setSetpoint (double setpoint)
void	resetSetpoint ()

Static Public Member Functions
static IddObjectType	iddObjectType ()
static std::vector< std::string >	shadingControlTypeValues ()
static std::vector< std::string >	shadingTypeValues ()

Related Functions
typedef boost::optional < ShadingControl >	OptionalShadingControl
typedef std::vector < ShadingControl >	ShadingControlVector

Detailed Description

ShadingControl is a ResourceObject that wraps the OpenStudio IDD object 'OS:ShadingControl'.

Constructor & Destructor Documentation

openstudio::model::ShadingControl::ShadingControl ( const Construction &  construction )

explicit

Create a ShadingControl object which references the passed in construction for the shaded state.

This constructor should be used to model switchable glazing only at this time, other configurations will not be supported by the Radiance ForwardTranslator. Note that changes to the construction made after this constructor will not be reflected in this ShadingControl object. If changes to the construction are made a new ShadingControl object should be constructed.

openstudio::model::ShadingControl::ShadingControl ( const ShadingMaterial &  shadingMaterial )

explicit

Create a ShadingControl object which references the passed in material for the shading layer.

This constructor is preferred for all configurations other than switchable glazing.

virtual openstudio::model::ShadingControl::~ShadingControl ( )

inlinevirtual

Member Function Documentation

boost::optional<Construction> openstudio::model::ShadingControl::construction

(

)

const

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

static

bool openstudio::model::ShadingControl::isSetpointDefaulted

(

)

const

bool openstudio::model::ShadingControl::isShadingControlTypeDefaulted

(

)

const

void openstudio::model::ShadingControl::resetSchedule

(

)

void openstudio::model::ShadingControl::resetSetpoint

(

)

void openstudio::model::ShadingControl::resetShadingControlType

(

)

boost::optional<Schedule> openstudio::model::ShadingControl::schedule

(

)

const

boost::optional<double> openstudio::model::ShadingControl::setpoint

(

)

const

bool openstudio::model::ShadingControl::setSchedule

(

const Schedule &

schedule

)

bool openstudio::model::ShadingControl::setSetpoint

(

double

setpoint

)

bool openstudio::model::ShadingControl::setShadingControlType

(

const std::string &

shadingControlType

)

bool openstudio::model::ShadingControl::setShadingType

(

const std::string &

shadingType

)

Sets the shading type field.

There is no error checking to ensure that shadingType is correct given the shaded construction or shading material.

std::string openstudio::model::ShadingControl::shadingControlType

(

)

const

static std::vector<std::string> openstudio::model::ShadingControl::shadingControlTypeValues ( )

static

boost::optional<ShadingMaterial> openstudio::model::ShadingControl::shadingMaterial

(

)

const

std::string openstudio::model::ShadingControl::shadingType

(

)

const

static std::vector<std::string> openstudio::model::ShadingControl::shadingTypeValues ( )

static

Friends And Related Function Documentation

typedef boost::optional<ShadingControl> OptionalShadingControl

related

typedef std::vector<ShadingControl> ShadingControlVector

related