DesignDay Class Reference

#include "DesignDay.hpp"

Inheritance diagram for openstudio::model::DesignDay:

Public Member Functions
	DesignDay (const Model &model)
	DesignDay (const DesignDay &other)=default
	DesignDay (DesignDay &&other)=default
DesignDay &	operator= (const DesignDay &)=default
DesignDay &	operator= (DesignDay &&)=default
virtual	~DesignDay ()=default
double	maximumDryBulbTemperature () const
bool	isMaximumDryBulbTemperatureDefaulted () const
double	dailyDryBulbTemperatureRange () const
bool	isDailyDryBulbTemperatureRangeDefaulted () const
OS_DEPRECATED double	humidityIndicatingConditionsAtMaximumDryBulb () const
OS_DEPRECATED bool	isHumidityIndicatingConditionsAtMaximumDryBulbDefaulted () const
double	barometricPressure () const
bool	isBarometricPressureDefaulted () const
double	windSpeed () const
bool	isWindSpeedDefaulted () const
double	windDirection () const
bool	isWindDirectionDefaulted () const
double	skyClearness () const
bool	isSkyClearnessDefaulted () const
bool	rainIndicator () const
bool	isRainIndicatorDefaulted () const
bool	snowIndicator () const
bool	isSnowIndicatorDefaulted () const
int	dayOfMonth () const
bool	isDayOfMonthDefaulted () const
int	month () const
bool	isMonthDefaulted () const
std::string	dayType () const
bool	isDayTypeDefaulted () const
bool	daylightSavingTimeIndicator () const
bool	isDaylightSavingTimeIndicatorDefaulted () const
OS_DEPRECATED std::string	humidityIndicatingType () const
std::string	humidityConditionType () const
OS_DEPRECATED bool	isHumidityIndicatingTypeDefaulted () const
bool	isHumidityConditionTypeDefaulted () const
OS_DEPRECATED boost::optional < ScheduleDay >	humidityIndicatingDaySchedule () const
boost::optional< ScheduleDay >	humidityConditionDaySchedule () const
boost::optional< double >	wetBulbOrDewPointAtMaximumDryBulb () const
boost::optional< double >	humidityRatioAtMaximumDryBulb () const
boost::optional< double >	enthalpyAtMaximumDryBulb () const
std::string	dryBulbTemperatureRangeModifierType () const
bool	isDryBulbTemperatureRangeModifierTypeDefaulted () const
OS_DEPRECATED boost::optional < ScheduleDay >	dryBulbTemperatureRangeModifierSchedule () const
boost::optional< ScheduleDay >	dryBulbTemperatureRangeModifierDaySchedule () const
std::string	solarModelIndicator () const
bool	isSolarModelIndicatorDefaulted () const
boost::optional< ScheduleDay >	beamSolarDaySchedule () const
boost::optional< ScheduleDay >	diffuseSolarDaySchedule () const
OS_DEPRECATED double	ashraeTaub () const
double	ashraeClearSkyOpticalDepthForBeamIrradiance () const
OS_DEPRECATED bool	isAshraeTaubDefaulted () const
bool	isAshraeClearSkyOpticalDepthForBeamIrradianceDefaulted () const
OS_DEPRECATED double	ashraeTaud () const
double	ashraeClearSkyOpticalDepthForDiffuseIrradiance () const
OS_DEPRECATED bool	isAshraeTaudDefaulted () const
bool	isAshraeClearSkyOpticalDepthForDiffuseIrradianceDefaulted () const
boost::optional< double >	dailyWetBulbTemperatureRange () const
boost::optional< int >	maximumNumberWarmupDays () const
std::string	beginEnvironmentResetMode () const
bool	isBeginEnvironmentResetModeDefaulted () const
bool	setMaximumDryBulbTemperature (double maximumDryBulbTemperature)
void	resetMaximumDryBulbTemperature ()
bool	setDailyDryBulbTemperatureRange (double dailyDryBulbTemperatureRange)
void	resetDailyDryBulbTemperatureRange ()
bool	setBarometricPressure (double barometricPressure)
void	resetBarometricPressure ()
bool	setWindSpeed (double windSpeed)
void	resetWindSpeed ()
bool	setWindDirection (double windDirection)
void	resetWindDirection ()
bool	setSkyClearness (double skyClearness)
void	resetSkyClearness ()
bool	setRainIndicator (bool rainIndicator)
void	resetRainIndicator ()
bool	setSnowIndicator (bool snowIndicator)
void	resetSnowIndicator ()
bool	setDayOfMonth (int dayOfMonth)
void	resetDayOfMonth ()
bool	setMonth (int month)
void	resetMonth ()
bool	setDayType (const std::string &dayType)
void	resetDayType ()
bool	setDaylightSavingTimeIndicator (bool daylightSavingTimeIndicator)
void	resetDaylightSavingTimeIndicator ()
OS_DEPRECATED bool	setHumidityIndicatingType (const std::string &humidityIndicatingType)
bool	setHumidityConditionType (const std::string &humidityConditionType)
OS_DEPRECATED void	resetHumidityIndicatingType ()
void	resetHumidityConditionType ()
OS_DEPRECATED bool	setHumidityIndicatingDaySchedule (const ScheduleDay &schedule)
bool	setHumidityConditionDaySchedule (const ScheduleDay &schedule)
OS_DEPRECATED void	resetHumidityIndicatingDaySchedule ()
void	resetHumidityConditionDaySchedule ()
OS_DEPRECATED bool	setHumidityIndicatingConditionsAtMaximumDryBulb (double humidityIndicatingConditionsAtMaximumDryBulb)
OS_DEPRECATED void	resetHumidityIndicatingConditionsAtMaximumDryBulb ()
bool	setWetBulbOrDewPointAtMaximumDryBulb (double wetBulbOrDewPointAtMaximumDryBulb)
void	resetWetBulbOrDewPointAtMaximumDryBulb ()
bool	setHumidityRatioAtMaximumDryBulb (double humidityRatioAtMaximumDryBulb)
void	resetHumidityRatioAtMaximumDryBulb ()
bool	setEnthalpyAtMaximumDryBulb (double enthalpyAtMaximumDryBulb)
void	resetEnthalpyAtMaximumDryBulb ()
bool	setDryBulbTemperatureRangeModifierType (const std::string &dryBulbTemperatureRangeModifierType)
void	resetDryBulbTemperatureRangeModifierType ()
OS_DEPRECATED bool	setDryBulbTemperatureRangeModifierSchedule (const ScheduleDay &schedule)
bool	setDryBulbTemperatureRangeModifierDaySchedule (const ScheduleDay &schedule)
OS_DEPRECATED void	resetDryBulbTemperatureRangeModifierSchedule ()
void	resetDryBulbTemperatureRangeModifierDaySchedule ()
bool	setSolarModelIndicator (const std::string &solarModelIndicator)
void	resetSolarModelIndicator ()
bool	setBeamSolarDaySchedule (const ScheduleDay &schedule)
void	resetBeamSolarDaySchedule ()
bool	setDiffuseSolarDaySchedule (const ScheduleDay &schedule)
void	resetDiffuseSolarDaySchedule ()
OS_DEPRECATED bool	setAshraeTaub (double ashraeTaub)
bool	setAshraeClearSkyOpticalDepthForBeamIrradiance (double ashraeClearSkyOpticalDepthForBeamIrradiance)
OS_DEPRECATED void	resetAshraeTaub ()
void	resetAshraeClearSkyOpticalDepthForBeamIrradiance ()
OS_DEPRECATED bool	setAshraeTaud (double ashraeTaud)
bool	setAshraeClearSkyOpticalDepthForDiffuseIrradiance (double ashraeClearSkyOpticalDepthForDiffuseIrradiance)
OS_DEPRECATED void	resetAshraeTaud ()
void	resetAshraeClearSkyOpticalDepthForDiffuseIrradiance ()
bool	setDailyWetBulbTemperatureRange (double dailyWetBulbTemperatureRange)
void	resetDailyWetBulbTemperatureRange ()
bool	setMaximumNumberWarmupDays (int maximumNumberWarmupDays)
void	resetMaximumNumberWarmupDays ()
bool	setBeginEnvironmentResetMode (const std::string &beginEnvironmentResetMode)
void	resetBeginEnvironmentResetMode ()

Static Public Member Functions
static IddObjectType	iddObjectType ()
static std::vector< std::string >	validDayTypeValues ()
static OS_DEPRECATED std::vector< std::string >	validHumidityIndicatingTypeValues ()
static std::vector< std::string >	validHumidityConditionTypeValues ()
static std::vector< std::string >	validDryBulbTemperatureRangeModifierTypeValues ()
static std::vector< std::string >	validSolarModelIndicatorValues ()
static std::vector< std::string >	validBeginEnvironmentResetModeValues ()

Protected Types
using	ImplType = detail::DesignDay_Impl

Protected Member Functions
	DesignDay (std::shared_ptr< detail::DesignDay_Impl > impl)

Related Functions
using	DesignDayVector = std::vector< DesignDay >
using	OptionalDesignDay = boost::optional< DesignDay >

Member Typedef Documentation

using openstudio::model::DesignDay::ImplType = detail::DesignDay_Impl

protected

Constructor & Destructor Documentation

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

explicit

virtual openstudio::model::DesignDay::~DesignDay ( )

virtualdefault

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

default

openstudio::model::DesignDay::DesignDay ( DesignDay &&  other )

default

openstudio::model::DesignDay::DesignDay ( std::shared_ptr< detail::DesignDay_Impl >  impl )

explicitprotected

Member Function Documentation

double openstudio::model::DesignDay::ashraeClearSkyOpticalDepthForBeamIrradiance

(

)

const

double openstudio::model::DesignDay::ashraeClearSkyOpticalDepthForDiffuseIrradiance

(

)

const

OS_DEPRECATED double openstudio::model::DesignDay::ashraeTaub

(

)

const

OS_DEPRECATED double openstudio::model::DesignDay::ashraeTaud

(

)

const

double openstudio::model::DesignDay::barometricPressure

(

)

const

boost::optional<ScheduleDay> openstudio::model::DesignDay::beamSolarDaySchedule

(

)

const

std::string openstudio::model::DesignDay::beginEnvironmentResetMode

(

)

const

double openstudio::model::DesignDay::dailyDryBulbTemperatureRange

(

)

const

boost::optional<double> openstudio::model::DesignDay::dailyWetBulbTemperatureRange

(

)

const

bool openstudio::model::DesignDay::daylightSavingTimeIndicator

(

)

const

int openstudio::model::DesignDay::dayOfMonth

(

)

const

std::string openstudio::model::DesignDay::dayType

(

)

const

boost::optional<ScheduleDay> openstudio::model::DesignDay::diffuseSolarDaySchedule

(

)

const

boost::optional<ScheduleDay> openstudio::model::DesignDay::dryBulbTemperatureRangeModifierDaySchedule

(

)

const

OS_DEPRECATED boost::optional<ScheduleDay> openstudio::model::DesignDay::dryBulbTemperatureRangeModifierSchedule

(

)

const

std::string openstudio::model::DesignDay::dryBulbTemperatureRangeModifierType

(

)

const

boost::optional<double> openstudio::model::DesignDay::enthalpyAtMaximumDryBulb

(

)

const

boost::optional<ScheduleDay> openstudio::model::DesignDay::humidityConditionDaySchedule

(

)

const

std::string openstudio::model::DesignDay::humidityConditionType

(

)

const

OS_DEPRECATED double openstudio::model::DesignDay::humidityIndicatingConditionsAtMaximumDryBulb

(

)

const

OS_DEPRECATED boost::optional<ScheduleDay> openstudio::model::DesignDay::humidityIndicatingDaySchedule

(

)

const

OS_DEPRECATED std::string openstudio::model::DesignDay::humidityIndicatingType

(

)

const

boost::optional<double> openstudio::model::DesignDay::humidityRatioAtMaximumDryBulb

(

)

const

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

static

bool openstudio::model::DesignDay::isAshraeClearSkyOpticalDepthForBeamIrradianceDefaulted

(

)

const

bool openstudio::model::DesignDay::isAshraeClearSkyOpticalDepthForDiffuseIrradianceDefaulted

(

)

const

OS_DEPRECATED bool openstudio::model::DesignDay::isAshraeTaubDefaulted

(

)

const

OS_DEPRECATED bool openstudio::model::DesignDay::isAshraeTaudDefaulted

(

)

const

bool openstudio::model::DesignDay::isBarometricPressureDefaulted

(

)

const

bool openstudio::model::DesignDay::isBeginEnvironmentResetModeDefaulted

(

)

const

bool openstudio::model::DesignDay::isDailyDryBulbTemperatureRangeDefaulted

(

)

const

bool openstudio::model::DesignDay::isDaylightSavingTimeIndicatorDefaulted

(

)

const

bool openstudio::model::DesignDay::isDayOfMonthDefaulted

(

)

const

bool openstudio::model::DesignDay::isDayTypeDefaulted

(

)

const

bool openstudio::model::DesignDay::isDryBulbTemperatureRangeModifierTypeDefaulted

(

)

const

bool openstudio::model::DesignDay::isHumidityConditionTypeDefaulted

(

)

const

OS_DEPRECATED bool openstudio::model::DesignDay::isHumidityIndicatingConditionsAtMaximumDryBulbDefaulted

(

)

const

OS_DEPRECATED bool openstudio::model::DesignDay::isHumidityIndicatingTypeDefaulted

(

)

const

bool openstudio::model::DesignDay::isMaximumDryBulbTemperatureDefaulted

(

)

const

bool openstudio::model::DesignDay::isMonthDefaulted

(

)

const

bool openstudio::model::DesignDay::isRainIndicatorDefaulted

(

)

const

bool openstudio::model::DesignDay::isSkyClearnessDefaulted

(

)

const

bool openstudio::model::DesignDay::isSnowIndicatorDefaulted

(

)

const

bool openstudio::model::DesignDay::isSolarModelIndicatorDefaulted

(

)

const

bool openstudio::model::DesignDay::isWindDirectionDefaulted

(

)

const

bool openstudio::model::DesignDay::isWindSpeedDefaulted

(

)

const

double openstudio::model::DesignDay::maximumDryBulbTemperature

(

)

const

boost::optional<int> openstudio::model::DesignDay::maximumNumberWarmupDays

(

)

const

int openstudio::model::DesignDay::month

(

)

const

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

default

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

default

bool openstudio::model::DesignDay::rainIndicator

(

)

const

void openstudio::model::DesignDay::resetAshraeClearSkyOpticalDepthForBeamIrradiance

(

)

void openstudio::model::DesignDay::resetAshraeClearSkyOpticalDepthForDiffuseIrradiance

(

)

OS_DEPRECATED void openstudio::model::DesignDay::resetAshraeTaub

(

)

OS_DEPRECATED void openstudio::model::DesignDay::resetAshraeTaud

(

)

void openstudio::model::DesignDay::resetBarometricPressure

(

)

void openstudio::model::DesignDay::resetBeamSolarDaySchedule

(

)

void openstudio::model::DesignDay::resetBeginEnvironmentResetMode

(

)

void openstudio::model::DesignDay::resetDailyDryBulbTemperatureRange

(

)

void openstudio::model::DesignDay::resetDailyWetBulbTemperatureRange

(

)

void openstudio::model::DesignDay::resetDaylightSavingTimeIndicator

(

)

void openstudio::model::DesignDay::resetDayOfMonth

(

)

void openstudio::model::DesignDay::resetDayType

(

)

void openstudio::model::DesignDay::resetDiffuseSolarDaySchedule

(

)

void openstudio::model::DesignDay::resetDryBulbTemperatureRangeModifierDaySchedule

(

)

OS_DEPRECATED void openstudio::model::DesignDay::resetDryBulbTemperatureRangeModifierSchedule

(

)

void openstudio::model::DesignDay::resetDryBulbTemperatureRangeModifierType

(

)

void openstudio::model::DesignDay::resetEnthalpyAtMaximumDryBulb

(

)

void openstudio::model::DesignDay::resetHumidityConditionDaySchedule

(

)

void openstudio::model::DesignDay::resetHumidityConditionType

(

)

OS_DEPRECATED void openstudio::model::DesignDay::resetHumidityIndicatingConditionsAtMaximumDryBulb

(

)

OS_DEPRECATED void openstudio::model::DesignDay::resetHumidityIndicatingDaySchedule

(

)

OS_DEPRECATED void openstudio::model::DesignDay::resetHumidityIndicatingType

(

)

void openstudio::model::DesignDay::resetHumidityRatioAtMaximumDryBulb

(

)

void openstudio::model::DesignDay::resetMaximumDryBulbTemperature

(

)

void openstudio::model::DesignDay::resetMaximumNumberWarmupDays

(

)

void openstudio::model::DesignDay::resetMonth

(

)

void openstudio::model::DesignDay::resetRainIndicator

(

)

void openstudio::model::DesignDay::resetSkyClearness

(

)

void openstudio::model::DesignDay::resetSnowIndicator

(

)

void openstudio::model::DesignDay::resetSolarModelIndicator

(

)

void openstudio::model::DesignDay::resetWetBulbOrDewPointAtMaximumDryBulb

(

)

void openstudio::model::DesignDay::resetWindDirection

(

)

void openstudio::model::DesignDay::resetWindSpeed

(

)

bool openstudio::model::DesignDay::setAshraeClearSkyOpticalDepthForBeamIrradiance

(

double

ashraeClearSkyOpticalDepthForBeamIrradiance

)

bool openstudio::model::DesignDay::setAshraeClearSkyOpticalDepthForDiffuseIrradiance

(

double

ashraeClearSkyOpticalDepthForDiffuseIrradiance

)

OS_DEPRECATED bool openstudio::model::DesignDay::setAshraeTaub

(

double

ashraeTaub

)

OS_DEPRECATED bool openstudio::model::DesignDay::setAshraeTaud

(

double

ashraeTaud

)

bool openstudio::model::DesignDay::setBarometricPressure

(

double

barometricPressure

)

bool openstudio::model::DesignDay::setBeamSolarDaySchedule

(

const ScheduleDay &

schedule

)

bool openstudio::model::DesignDay::setBeginEnvironmentResetMode

(

const std::string &

beginEnvironmentResetMode

)

bool openstudio::model::DesignDay::setDailyDryBulbTemperatureRange

(

double

dailyDryBulbTemperatureRange

)

bool openstudio::model::DesignDay::setDailyWetBulbTemperatureRange

(

double

dailyWetBulbTemperatureRange

)

bool openstudio::model::DesignDay::setDaylightSavingTimeIndicator

(

bool

daylightSavingTimeIndicator

)

bool openstudio::model::DesignDay::setDayOfMonth

(

int

dayOfMonth

)

bool openstudio::model::DesignDay::setDayType

(

const std::string &

dayType

)

bool openstudio::model::DesignDay::setDiffuseSolarDaySchedule

(

const ScheduleDay &

schedule

)

bool openstudio::model::DesignDay::setDryBulbTemperatureRangeModifierDaySchedule

(

const ScheduleDay &

schedule

)

OS_DEPRECATED bool openstudio::model::DesignDay::setDryBulbTemperatureRangeModifierSchedule

(

const ScheduleDay &

schedule

)

Sets the dry bulb temperature range modifier day schedule.

The appropriate ScheduleTypeLimits varies depending on the dry bulb temperature range modifier type. Please see the EnergyPlus input-output reference for details before using this feature.

bool openstudio::model::DesignDay::setDryBulbTemperatureRangeModifierType

(

const std::string &

dryBulbTemperatureRangeModifierType

)

bool openstudio::model::DesignDay::setEnthalpyAtMaximumDryBulb

(

double

enthalpyAtMaximumDryBulb

)

bool openstudio::model::DesignDay::setHumidityConditionDaySchedule

(

const ScheduleDay &

schedule

)

bool openstudio::model::DesignDay::setHumidityConditionType

(

const std::string &

humidityConditionType

)

OS_DEPRECATED bool openstudio::model::DesignDay::setHumidityIndicatingConditionsAtMaximumDryBulb

(

double

humidityIndicatingConditionsAtMaximumDryBulb

)

OS_DEPRECATED bool openstudio::model::DesignDay::setHumidityIndicatingDaySchedule

(

const ScheduleDay &

schedule

)

Sets the humidity indicating day schedule.

The appropriate ScheduleTypeLimits varies depending on the humidity indicating type. Please see the EnergyPlus input-output reference for details before using this feature.

OS_DEPRECATED bool openstudio::model::DesignDay::setHumidityIndicatingType

(

const std::string &

humidityIndicatingType

)

bool openstudio::model::DesignDay::setHumidityRatioAtMaximumDryBulb

(

double

humidityRatioAtMaximumDryBulb

)

bool openstudio::model::DesignDay::setMaximumDryBulbTemperature

(

double

maximumDryBulbTemperature

)

bool openstudio::model::DesignDay::setMaximumNumberWarmupDays

(

int

maximumNumberWarmupDays

)

bool openstudio::model::DesignDay::setMonth

(

int

month

)

bool openstudio::model::DesignDay::setRainIndicator

(

bool

rainIndicator

)

bool openstudio::model::DesignDay::setSkyClearness

(

double

skyClearness

)

bool openstudio::model::DesignDay::setSnowIndicator

(

bool

snowIndicator

)

bool openstudio::model::DesignDay::setSolarModelIndicator

(

const std::string &

solarModelIndicator

)

bool openstudio::model::DesignDay::setWetBulbOrDewPointAtMaximumDryBulb

(

double

wetBulbOrDewPointAtMaximumDryBulb

)

bool openstudio::model::DesignDay::setWindDirection

(

double

windDirection

)

bool openstudio::model::DesignDay::setWindSpeed

(

double

windSpeed

)

double openstudio::model::DesignDay::skyClearness

(

)

const

bool openstudio::model::DesignDay::snowIndicator

(

)

const

std::string openstudio::model::DesignDay::solarModelIndicator

(

)

const

static std::vector<std::string> openstudio::model::DesignDay::validBeginEnvironmentResetModeValues ( )

static

static std::vector<std::string> openstudio::model::DesignDay::validDayTypeValues ( )

static

static std::vector<std::string> openstudio::model::DesignDay::validDryBulbTemperatureRangeModifierTypeValues ( )

static

static std::vector<std::string> openstudio::model::DesignDay::validHumidityConditionTypeValues ( )

static

static OS_DEPRECATED std::vector<std::string> openstudio::model::DesignDay::validHumidityIndicatingTypeValues ( )

static

static std::vector<std::string> openstudio::model::DesignDay::validSolarModelIndicatorValues ( )

static

boost::optional<double> openstudio::model::DesignDay::wetBulbOrDewPointAtMaximumDryBulb

(

)

const

double openstudio::model::DesignDay::windDirection

(

)

const

double openstudio::model::DesignDay::windSpeed

(

)

const

Friends And Related Function Documentation

using DesignDayVector = std::vector<DesignDay>

related

using OptionalDesignDay = boost::optional<DesignDay>

related