All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Protected Types | Protected Member Functions | Related Functions | List of all members
openstudio::model::DesignDay Class Reference

#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 ()
bool 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)
 Sets the humidity indicating day schedule. More...
void resetHumidityIndicatingDaySchedule ()
bool setDryBulbTemperatureRangeModifierType (std::string dryBulbTemperatureRangeModifierType)
void resetDryBulbTemperatureRangeModifierType ()
bool setDryBulbTemperatureRangeModifierSchedule (const ScheduleDay &schedule)
 Sets the dry bulb temperature range modifier day schedule. More...
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 ()
bool setDailyWetBulbTemperatureRange (double dailyWetBulbTemperatureRange)
void resetDailyWetBulbTemperatureRange ()
- Public Member Functions inherited from openstudio::model::SizingPeriod
void ensureNoLeapDays ()
virtual ~SizingPeriod ()
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectTypeallowableChildTypes () 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...
< 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< IdfObjectremoveLifeCycleCosts ()
 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< IdfObjectremoveAdditionalProperties ()
 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
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
std::vector< std::string > canBeTarget () const
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
IdfObject idfObject ()
IdfObject idfObject () const
bool initialized () const
bool isSource () const
bool isTarget () const
unsigned numSources () const
bool objectListFieldsEqual (const WorkspaceObject &other) const
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
bool operator< (const WorkspaceObject &right) const
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
< openstudio::IdfObject
remove ()
bool setPointer (unsigned index, const Handle &targetHandle)
std::vector< WorkspaceObjectsources () const
std::vector< WorkspaceObjecttargets () const
Workspace workspace () const
virtual ~WorkspaceObject ()
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
cast () const
std::vector< T > castVector (const std::vector< U > &objects)
std::vector< std::vector
< std::string > > 
clearExtensibleGroups ()
IdfObject clone (bool keepHandle=false) const
std::string comment () const
boost::optional< std::string > createName (bool overwrite=true)
std::vector< unsigned > dataFields () const
bool dataFieldsEqual (const IdfObject &other) const
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
std::vector< IdfExtensibleGroupextensibleGroups () const
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
std::vector< Handle > getHandles (const std::vector< T > &objects)
boost::optional< intgetInt (unsigned index, bool returnDefault=false) const
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
boost::optional< QUrl > getURL (unsigned index, bool returnDefault=false) const
Handle handle () const
IddObject iddObject () const
 IdfObject (IddObjectType type, bool fastName=false)
 IdfObject (const IddObject &, bool fastName=false)
 IdfObject (const IdfObject &other)
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
bool isDataField (unsigned index) const
bool isEmpty (unsigned index) const
bool isObjectListField (unsigned index) const
bool isValid (StrictnessLevel level, bool checkNames=false) const
boost::optional< unsigned > maxExtensibleGroups () const
boost::optional< unsigned > maxFields () const
unsigned minExtensibleGroups () const
unsigned minFields () const
boost::optional< std::string > name (bool returnDefault=false) const
std::string nameString (bool returnDefault=false) const
unsigned numExtensibleGroups () const
unsigned numFields () const
unsigned numNonextensibleFields () const
std::vector< unsigned > objectListFields () const
bool objectListFieldsEqual (const IdfObject &other) const
bool objectListFieldsNonConflicting (const IdfObject &other) const
bool operator!= (const IdfObject &other) const
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
bool operator== (const IdfObject &other) const
boost::optional< T > optionalCast () const
std::vector< std::string > popExtensibleGroup ()
std::ostream & print (std::ostream &os) const
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
std::ostream & printName (std::ostream &os, bool hasFields=true) const
IdfExtensibleGroup pushExtensibleGroup ()
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
std::vector< unsigned > requiredFields () const
void setComment (const std::string &msg)
bool setDouble (unsigned index, double value)
bool setFieldComment (unsigned index, const std::string &cmnt)
bool setInt (unsigned index, int value)
boost::optional< std::string > setName (const std::string &newName)
bool setQuantity (unsigned index, const Quantity &q)
bool setString (unsigned index, const std::string &value)
bool setUnsigned (unsigned index, unsigned value)
std::vector< T > subsetCastVector (const std::vector< U > &original)
ValidityReport validityReport (StrictnessLevel level, bool checkNames=false) const
virtual ~IdfObject ()

Static Public Member Functions

Static Methods
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 ()
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
static int printedFieldSpace ()

Protected Types

typedef detail::DesignDay_Impl ImplType
- Protected Types inherited from openstudio::model::SizingPeriod
typedef detail::SizingPeriod_Impl ImplType
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
- Protected Types inherited from openstudio::WorkspaceObject
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType

Protected Member Functions

 DesignDay (std::shared_ptr< detail::DesignDay_Impl > impl)
- Protected Member Functions inherited from openstudio::model::SizingPeriod
 SizingPeriod (IddObjectType type, const Model &model)
 SizingPeriod (std::shared_ptr< detail::SizingPeriod_Impl > impl)
- 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)
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
typedef std::vector
< WorkspaceObject
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
typedef std::vector< IdfObjectIdfObjectVector
typedef boost::optional
< IdfObject

Member Typedef Documentation

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

Constructor & Destructor Documentation

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

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

Friends And Related Function Documentation

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