ShadowCalculation Class Reference

#include "ShadowCalculation.hpp"

Inheritance diagram for openstudio::model::ShadowCalculation:

Public Member Functions
ShadowCalculation &	operator= (const ShadowCalculation &)=default
ShadowCalculation &	operator= (ShadowCalculation &&)=default
	ShadowCalculation (const ShadowCalculation &other)=default
	ShadowCalculation (ShadowCalculation &&other)=default
virtual	~ShadowCalculation ()=default
std::string	shadingCalculationMethod () const
std::string	shadingCalculationUpdateFrequencyMethod () const
bool	isShadingCalculationUpdateFrequencyMethodDefaulted () const
int	shadingCalculationUpdateFrequency () const
bool	isShadingCalculationUpdateFrequencyDefaulted () const
int	maximumFiguresInShadowOverlapCalculations () const
bool	isMaximumFiguresInShadowOverlapCalculationsDefaulted () const
std::string	polygonClippingAlgorithm () const
int	pixelCountingResolution () const
std::string	skyDiffuseModelingAlgorithm () const
bool	outputExternalShadingCalculationResults () const
bool	disableSelfShadingWithinShadingZoneGroups () const
bool	disableSelfShadingFromShadingZoneGroupstoOtherZones () const
unsigned int	numberofShadingZoneGroups () const
std::vector< ThermalZone >	getShadingZoneGroup (unsigned groupIndex) const
bool	setShadingCalculationMethod (const std::string &shadingCalculationMethod)
bool	setShadingCalculationUpdateFrequencyMethod (const std::string &shadingCalculationUpdateFrequencyMethod)
void	resetShadingCalculationUpdateFrequencyMethod ()
bool	setShadingCalculationUpdateFrequency (int shadingCalculationUpdateFrequency)
void	resetShadingCalculationUpdateFrequency ()
bool	setMaximumFiguresInShadowOverlapCalculations (int maximumFiguresInShadowOverlapCalculations)
void	resetMaximumFiguresInShadowOverlapCalculations ()
bool	setPolygonClippingAlgorithm (const std::string &polygonClippingAlgorithm)
void	resetPolygonClippingAlgorithm ()
bool	setPixelCountingResolution (int pixelCountingResolution)
bool	setSkyDiffuseModelingAlgorithm (const std::string &skyDiffuseModelingAlgorithm)
void	resetSkyDiffuseModelingAlgorithm ()
bool	setOutputExternalShadingCalculationResults (bool outputExternalShadingCalculationResults)
bool	setDisableSelfShadingWithinShadingZoneGroups (bool disableSelfShadingWithinShadingZoneGroups)
bool	setDisableSelfShadingFromShadingZoneGroupstoOtherZones (bool disableSelfShadingFromShadingZoneGroupstoOtherZones)
bool	addShadingZoneGroup (const std::vector< ThermalZone > &thermalZones)
bool	removeShadingZoneGroup (unsigned groupIndex)
void	removeAllShadingZoneGroups ()

Static Public Member Functions
static IddObjectType	iddObjectType ()
static std::vector< std::string >	shadingCalculationMethodValues ()
static std::vector< std::string >	validShadingCalculationMethodValues ()
static std::vector< std::string >	shadingCalculationUpdateFrequencyMethodValues ()
static std::vector< std::string >	validShadingCalculationUpdateFrequencyMethodValues ()
static std::vector< std::string >	polygonClippingAlgorithmValues ()
static std::vector< std::string >	validPolygonClippingAlgorithmValues ()
static std::vector< std::string >	skyDiffuseModelingAlgorithmValues ()
static std::vector< std::string >	validSkyDiffuseModelingAlgorithmValues ()

Protected Member Functions
	ShadowCalculation (const Model &model)

Related Functions
using	OptionalShadowCalculation = boost::optional< ShadowCalculation >

Detailed Description

ShadowCalculation derives from ModelObject and is an interface to the OpenStudio IDD object named "ShadowCalculation".

ShadowCalculation defines how often shadowing calculations should be performed in EnergyPlus simulations as well as how many overlapping figures can be considered in a shadow calculation. ShadowCalculation does not have a public constructor because it is a unique ModelObject. To get the ShadowCalculation object for a Model or create one if it does not yet exist use model.getUniqueObject<ShadowCalculation>(). To get the ShadowCalculation object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<ShadowCalculation>().

Constructor & Destructor Documentation

virtual openstudio::model::ShadowCalculation::~ShadowCalculation ( )

virtualdefault

openstudio::model::ShadowCalculation::ShadowCalculation ( const ShadowCalculation &  other )

default

openstudio::model::ShadowCalculation::ShadowCalculation ( ShadowCalculation &&  other )

default

openstudio::model::ShadowCalculation::ShadowCalculation ( const Model &  model )

explicitprotected

Constructs a new ShadowCalculation object in the model.

Member Function Documentation

bool openstudio::model::ShadowCalculation::addShadingZoneGroup

(

const std::vector< ThermalZone > &

thermalZones

)

bool openstudio::model::ShadowCalculation::disableSelfShadingFromShadingZoneGroupstoOtherZones

(

)

const

bool openstudio::model::ShadowCalculation::disableSelfShadingWithinShadingZoneGroups

(

)

const

std::vector<ThermalZone> openstudio::model::ShadowCalculation::getShadingZoneGroup

(

unsigned

groupIndex

)

const

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

static

bool openstudio::model::ShadowCalculation::isMaximumFiguresInShadowOverlapCalculationsDefaulted

(

)

const

bool openstudio::model::ShadowCalculation::isShadingCalculationUpdateFrequencyDefaulted

(

)

const

bool openstudio::model::ShadowCalculation::isShadingCalculationUpdateFrequencyMethodDefaulted

(

)

const

int openstudio::model::ShadowCalculation::maximumFiguresInShadowOverlapCalculations

(

)

const

unsigned int openstudio::model::ShadowCalculation::numberofShadingZoneGroups

(

)

const

ShadowCalculation& openstudio::model::ShadowCalculation::operator= ( const ShadowCalculation &  )

default

ShadowCalculation& openstudio::model::ShadowCalculation::operator= ( ShadowCalculation &&  )

default

bool openstudio::model::ShadowCalculation::outputExternalShadingCalculationResults

(

)

const

int openstudio::model::ShadowCalculation::pixelCountingResolution

(

)

const

std::string openstudio::model::ShadowCalculation::polygonClippingAlgorithm

(

)

const

static std::vector<std::string> openstudio::model::ShadowCalculation::polygonClippingAlgorithmValues ( )

static

void openstudio::model::ShadowCalculation::removeAllShadingZoneGroups

(

)

bool openstudio::model::ShadowCalculation::removeShadingZoneGroup

(

unsigned

groupIndex

)

void openstudio::model::ShadowCalculation::resetMaximumFiguresInShadowOverlapCalculations

(

)

void openstudio::model::ShadowCalculation::resetPolygonClippingAlgorithm

(

)

void openstudio::model::ShadowCalculation::resetShadingCalculationUpdateFrequency

(

)

void openstudio::model::ShadowCalculation::resetShadingCalculationUpdateFrequencyMethod

(

)

void openstudio::model::ShadowCalculation::resetSkyDiffuseModelingAlgorithm

(

)

bool openstudio::model::ShadowCalculation::setDisableSelfShadingFromShadingZoneGroupstoOtherZones

(

bool

disableSelfShadingFromShadingZoneGroupstoOtherZones

)

bool openstudio::model::ShadowCalculation::setDisableSelfShadingWithinShadingZoneGroups

(

bool

disableSelfShadingWithinShadingZoneGroups

)

bool openstudio::model::ShadowCalculation::setMaximumFiguresInShadowOverlapCalculations

(

int

maximumFiguresInShadowOverlapCalculations

)

bool openstudio::model::ShadowCalculation::setOutputExternalShadingCalculationResults

(

bool

outputExternalShadingCalculationResults

)

bool openstudio::model::ShadowCalculation::setPixelCountingResolution

(

int

pixelCountingResolution

)

bool openstudio::model::ShadowCalculation::setPolygonClippingAlgorithm

(

const std::string &

polygonClippingAlgorithm

)

bool openstudio::model::ShadowCalculation::setShadingCalculationMethod

(

const std::string &

shadingCalculationMethod

)

bool openstudio::model::ShadowCalculation::setShadingCalculationUpdateFrequency

(

int

shadingCalculationUpdateFrequency

)

bool openstudio::model::ShadowCalculation::setShadingCalculationUpdateFrequencyMethod

(

const std::string &

shadingCalculationUpdateFrequencyMethod

)

bool openstudio::model::ShadowCalculation::setSkyDiffuseModelingAlgorithm

(

const std::string &

skyDiffuseModelingAlgorithm

)

std::string openstudio::model::ShadowCalculation::shadingCalculationMethod

(

)

const

static std::vector<std::string> openstudio::model::ShadowCalculation::shadingCalculationMethodValues ( )

static

int openstudio::model::ShadowCalculation::shadingCalculationUpdateFrequency

(

)

const

std::string openstudio::model::ShadowCalculation::shadingCalculationUpdateFrequencyMethod

(

)

const

static std::vector<std::string> openstudio::model::ShadowCalculation::shadingCalculationUpdateFrequencyMethodValues ( )

static

std::string openstudio::model::ShadowCalculation::skyDiffuseModelingAlgorithm

(

)

const

static std::vector<std::string> openstudio::model::ShadowCalculation::skyDiffuseModelingAlgorithmValues ( )

static

static std::vector<std::string> openstudio::model::ShadowCalculation::validPolygonClippingAlgorithmValues ( )

static

static std::vector<std::string> openstudio::model::ShadowCalculation::validShadingCalculationMethodValues ( )

static

static std::vector<std::string> openstudio::model::ShadowCalculation::validShadingCalculationUpdateFrequencyMethodValues ( )

static

static std::vector<std::string> openstudio::model::ShadowCalculation::validSkyDiffuseModelingAlgorithmValues ( )

static

Friends And Related Function Documentation

using OptionalShadowCalculation = boost::optional<ShadowCalculation>

related