OpenStudioCore:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "DesignDay.hpp"

Inheritance diagram for openstudio::model::DesignDay:

Public Member Functions

 DesignDay (const Model &model)
virtual ~DesignDay ()
double maximumDryBulbTemperature () const
bool isMaximumDryBulbTemperatureDefaulted () const
double dailyDryBulbTemperatureRange () const
bool isDailyDryBulbTemperatureRangeDefaulted () const
double humidityIndicatingConditionsAtMaximumDryBulb () const
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
std::string humidityIndicatingType () const
bool isHumidityIndicatingTypeDefaulted () const
boost::optional< ScheduleDayhumidityIndicatingDaySchedule () const
std::string dryBulbTemperatureRangeModifierType () const
bool isDryBulbTemperatureRangeModifierTypeDefaulted () const
boost::optional< ScheduleDaydryBulbTemperatureRangeModifierSchedule () const
std::string solarModelIndicator () const
bool isSolarModelIndicatorDefaulted () const
boost::optional< ScheduleDaybeamSolarDaySchedule () const
boost::optional< ScheduleDaydiffuseSolarDaySchedule () const
double ashraeTaub () const
bool isAshraeTaubDefaulted () const
double ashraeTaud () const
bool isAshraeTaudDefaulted () const
boost::optional< double > dailyWetBulbTemperatureRange () const
bool setMaximumDryBulbTemperature (double maximumDryBulbTemperature)
void resetMaximumDryBulbTemperature ()
bool setDailyDryBulbTemperatureRange (double dailyDryBulbTemperatureRange)
void resetDailyDryBulbTemperatureRange ()
void setHumidityIndicatingConditionsAtMaximumDryBulb (double humidityIndicatingConditionsAtMaximumDryBulb)
void resetHumidityIndicatingConditionsAtMaximumDryBulb ()
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 (std::string dayType)
void resetDayType ()
bool setDaylightSavingTimeIndicator (bool daylightSavingTimeIndicator)
void resetDaylightSavingTimeIndicator ()
bool setHumidityIndicatingType (std::string humidityIndicatingType)
void resetHumidityIndicatingType ()
bool setHumidityIndicatingDaySchedule (const ScheduleDay &schedule)
void resetHumidityIndicatingDaySchedule ()
bool setDryBulbTemperatureRangeModifierType (std::string dryBulbTemperatureRangeModifierType)
void resetDryBulbTemperatureRangeModifierType ()
bool setDryBulbTemperatureRangeModifierSchedule (const ScheduleDay &schedule)
void resetDryBulbTemperatureRangeModifierSchedule ()
bool setSolarModelIndicator (std::string solarModelIndicator)
void resetSolarModelIndicator ()
bool setBeamSolarDaySchedule (const ScheduleDay &schedule)
void resetBeamSolarDaySchedule ()
bool setDiffuseSolarDaySchedule (const ScheduleDay &schedule)
void resetDiffuseSolarDaySchedule ()
bool setAshraeTaub (double aSHRAETaub)
void resetAshraeTaub ()
bool setAshraeTaud (double aSHRAETaud)
void resetAshraeTaud ()
void setDailyWetBulbTemperatureRange (double dailyWetBulbTemperatureRange)
void resetDailyWetBulbTemperatureRange ()

Static Public Member Functions

static IddObjectType iddObjectType ()
static std::vector< std::string > validDayTypeValues ()
static std::vector< std::string > validHumidityIndicatingTypeValues ()
static std::vector< std::string > validDryBulbTemperatureRangeModifierTypeValues ()
static std::vector< std::string > validSolarModelIndicatorValues ()

Protected Types

typedef detail::DesignDay_Impl ImplType

Protected Member Functions

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

Related Functions

typedef std::vector< DesignDayDesignDayVector
typedef boost::optional
< DesignDay
OptionalDesignDay

Member Typedef Documentation

typedef detail::DesignDay_Impl openstudio::model::DesignDay::ImplType
protected

Constructor & Destructor Documentation

openstudio::model::DesignDay::DesignDay ( const Model model)
explicit
virtual openstudio::model::DesignDay::~DesignDay ( )
inlinevirtual
openstudio::model::DesignDay::DesignDay ( std::shared_ptr< detail::DesignDay_Impl >  impl)
explicitprotected

Member Function Documentation

double openstudio::model::DesignDay::ashraeTaub ( ) const
double openstudio::model::DesignDay::ashraeTaud ( ) const
double openstudio::model::DesignDay::barometricPressure ( ) const
boost::optional<ScheduleDay> openstudio::model::DesignDay::beamSolarDaySchedule ( ) 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::dryBulbTemperatureRangeModifierSchedule ( ) const
std::string openstudio::model::DesignDay::dryBulbTemperatureRangeModifierType ( ) const
double openstudio::model::DesignDay::humidityIndicatingConditionsAtMaximumDryBulb ( ) const
boost::optional<ScheduleDay> openstudio::model::DesignDay::humidityIndicatingDaySchedule ( ) const
std::string openstudio::model::DesignDay::humidityIndicatingType ( ) const
static IddObjectType openstudio::model::DesignDay::iddObjectType ( )
static
bool openstudio::model::DesignDay::isAshraeTaubDefaulted ( ) const
bool openstudio::model::DesignDay::isAshraeTaudDefaulted ( ) const
bool openstudio::model::DesignDay::isBarometricPressureDefaulted ( ) 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::isHumidityIndicatingConditionsAtMaximumDryBulbDefaulted ( ) const
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
int openstudio::model::DesignDay::month ( ) const
bool openstudio::model::DesignDay::rainIndicator ( ) const
void openstudio::model::DesignDay::resetAshraeTaub ( )
void openstudio::model::DesignDay::resetAshraeTaud ( )
void openstudio::model::DesignDay::resetBarometricPressure ( )
void openstudio::model::DesignDay::resetBeamSolarDaySchedule ( )
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::resetDryBulbTemperatureRangeModifierSchedule ( )
void openstudio::model::DesignDay::resetDryBulbTemperatureRangeModifierType ( )
void openstudio::model::DesignDay::resetHumidityIndicatingConditionsAtMaximumDryBulb ( )
void openstudio::model::DesignDay::resetHumidityIndicatingDaySchedule ( )
void openstudio::model::DesignDay::resetHumidityIndicatingType ( )
void openstudio::model::DesignDay::resetMaximumDryBulbTemperature ( )
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::resetWindDirection ( )
void openstudio::model::DesignDay::resetWindSpeed ( )
bool openstudio::model::DesignDay::setAshraeTaub ( double  aSHRAETaub)
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::setDailyDryBulbTemperatureRange ( double  dailyDryBulbTemperatureRange)
void 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 ( std::string  dayType)
bool openstudio::model::DesignDay::setDiffuseSolarDaySchedule ( const ScheduleDay schedule)
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 ( std::string  dryBulbTemperatureRangeModifierType)
void openstudio::model::DesignDay::setHumidityIndicatingConditionsAtMaximumDryBulb ( double  humidityIndicatingConditionsAtMaximumDryBulb)
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.

bool openstudio::model::DesignDay::setHumidityIndicatingType ( std::string  humidityIndicatingType)
bool openstudio::model::DesignDay::setMaximumDryBulbTemperature ( double  maximumDryBulbTemperature)
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 ( std::string  solarModelIndicator)
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::validDayTypeValues ( )
static
static std::vector<std::string> openstudio::model::DesignDay::validDryBulbTemperatureRangeModifierTypeValues ( )
static
static std::vector<std::string> openstudio::model::DesignDay::validHumidityIndicatingTypeValues ( )
static
static std::vector<std::string> openstudio::model::DesignDay::validSolarModelIndicatorValues ( )
static
double openstudio::model::DesignDay::windDirection ( ) const
double openstudio::model::DesignDay::windSpeed ( ) const

Friends And Related Function Documentation

typedef std::vector<DesignDay> DesignDayVector
related
typedef boost::optional<DesignDay> OptionalDesignDay
related