OpenStudio:model
Loading...
Searching...
No Matches
openstudio::model::DesignDay Class Reference

#include <DesignDay.hpp>

+ Inheritance diagram for openstudio::model::DesignDay:

Public Member Functions

 DesignDay (const Model &model)
 
Getters
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< ScheduleDayhumidityIndicatingDaySchedule () const
 
boost::optional< ScheduleDayhumidityConditionDaySchedule () 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< ScheduleDaydryBulbTemperatureRangeModifierSchedule () const
 
boost::optional< ScheduleDaydryBulbTemperatureRangeModifierDaySchedule () const
 
std::string solarModelIndicator () const
 
bool isSolarModelIndicatorDefaulted () const
 
boost::optional< ScheduleDaybeamSolarDaySchedule () const
 
boost::optional< ScheduleDaydiffuseSolarDaySchedule () 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
 
- Public Member Functions inherited from openstudio::model::SizingPeriod
void ensureNoLeapDays ()
 
SizingPeriodoperator= (const SizingPeriod &)=default
 
SizingPeriodoperator= (SizingPeriod &&)=default
 
 SizingPeriod (const SizingPeriod &other)=default
 
 SizingPeriod (SizingPeriod &&other)=default
 
virtual ~SizingPeriod () override=default
 
- Public Member Functions inherited from openstudio::model::ParentObject
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (ParentObject &&)=default
 
 ParentObject (const ParentObject &other)=default
 
 ParentObject (ParentObject &&other)=default
 
virtual ~ParentObject () override=default
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model.
 
std::vector< IddObjectTypeallowableChildTypes () const
 Returns a vector of allowable children types.
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject () override=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
ModelObject clone () const
 Creates a deep copy of this object, placing it in this object's model().
 
ModelObject clone (Model model) const
 Creates a deep copy of this object, placing it in model.
 
Component createComponent () const
 Method for creating sharable Model snippets.
 
Model model () const
 Returns the Model that contains this object.
 
boost::optional< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one.
 
std::vector< ResourceObjectresources () const
 Get the resources directly used by this ModelObject.
 
template<typename T >
std::vector< T > getModelObjectSources () const
 Get all objects of type T that point to this object.
 
template<typename T >
std::vector< T > getModelObjectSources (IddObjectType iddObjectType) const
 Get all objects of type T that point to this object.
 
template<typename T >
boost::optional< T > getModelObjectTarget (unsigned index) const
 Get the object of type T pointed to by this object from field index.
 
template<typename T >
std::vector< T > getModelObjectTargets () const
 Get all objects of type T to which this object points.
 
const std::vector< std::string > & outputVariableNames () const
 Get all output variables names that could be associated with this object.
 
std::vector< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data.
 
boost::optional< openstudio::TimeSeriesgetData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object.
 
std::vector< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object.
 
std::vector< IdfObjectremoveLifeCycleCosts ()
 Removes all LifeCycleCosts that refer to this object.
 
IddObjectType iddObjectType () const
 This is a virtual function that will tell you the type of iddObject you are dealing with.
 
AdditionalProperties additionalProperties () const
 Returns this object's additional properties, constructing a new object if necessary.
 
bool hasAdditionalProperties () const
 Returns true if this object has additional properties.
 
std::vector< IdfObjectremoveAdditionalProperties ()
 Removes all additional properties that refer to this object.
 
boost::optional< std::string > cadObjectId () const
 
bool setCADObjectId (const std::string &cadObjectId)
 
boost::optional< std::string > gbXMLId () const
 
bool setGBXMLId (const std::string &gbXMLId)
 
boost::optional< std::string > displayName () const
 
bool setDisplayName (const std::string &displayName)
 
bool setParent (ParentObject &newParent)
 set the parent, child may have to call non-const methods on the parent
 
bool operator< (const ModelObject &right) const
 
bool operator== (const ModelObject &other) const
 equality test
 
bool operator!= (const ModelObject &other) const
 inequality test
 
std::vector< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object.
 
boost::optional< double > getAutosizedValue (const std::string &valueName, const std::string &units) const
 Gets the autosized component value from the sql file.
 
virtual std::vector< EMSActuatorNamesemsActuatorNames () const
 Return the names of the available ems actuators.
 
virtual std::vector< std::string > emsInternalVariableNames () const
 Return the names of the available ems internal variables.
 
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 () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool initialized () const
 
bool isSource () const
 
bool isSource () const
 
bool isTarget () const
 
bool isTarget () const
 
unsigned numSources () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
WorkspaceObjectoperator= (const WorkspaceObject &)=default
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
WorkspaceObjectoperator= (WorkspaceObject &&)=default
 
std::vector< openstudio::IdfObjectremove ()
 
std::vector< openstudio::IdfObjectremove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
Workspace workspace () const
 
 WorkspaceObject (const WorkspaceObject &other)=default
 
 WorkspaceObject (const WorkspaceObject &other)=default
 
 WorkspaceObject (WorkspaceObject &&other)=default
 
 WorkspaceObject (WorkspaceObject &&other)=default
 
virtual ~WorkspaceObject () override=default
 
virtual ~WorkspaceObject () override=default
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector< std::string > > clearExtensibleGroups ()
 
std::vector< std::vector< std::string > > clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
boost::optional< std::string > getField (unsigned index, bool returnDefault=false) const
 
boost::optional< std::string > getField (unsigned index, bool returnDefault=false) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< int > getInt (unsigned index, bool returnDefault=false) const
 
boost::optional< int > getInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=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< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
Handle handle () const
 
IddObject iddObject () const
 
IddObject iddObject () const
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
 IdfObject (const IdfObject &other)
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (IdfObject &&other) noexcept
 
 IdfObject (IdfObject &&other) noexcept
 
void initializeFields (bool fill_default=false)
 
void initializeFields (bool fill_default=false)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level, bool checkNames=false) const
 
bool isValid (StrictnessLevel level, bool checkNames=false) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
IdfObjectoperator= (const IdfObject &other)
 
IdfObjectoperator= (const IdfObject &other)
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
IdfObjectoperator= (IdfObject &&other) noexcept
 
bool operator== (const IdfObject &other) const
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
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 ()
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
std::vector< unsigned > requiredFields () const
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=false) const
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=false) const
 
virtual ~IdfObject ()=default
 
virtual ~IdfObject ()=default
 

Static Public Member Functions

Static Methods
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 ()
 
- 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 ()
 

Related Symbols

(Note that these are not member symbols.)

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

Setters

using ImplType = detail::DesignDay_Impl
 
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)
 Sets the humidity indicating day 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)
 Sets the dry bulb temperature range modifier day 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 ()
 
virtual ~DesignDay () override=default
 
 DesignDay (const DesignDay &other)=default
 
 DesignDay (DesignDay &&other)=default
 
DesignDayoperator= (const DesignDay &)=default
 
DesignDayoperator= (DesignDay &&)=default
 
 DesignDay (std::shared_ptr< detail::DesignDay_Impl > impl)
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional< WorkspaceObjectOptionalWorkspaceObject
 
typedef std::vector< WorkspaceObjectWorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObjectIdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional< IdfObjectOptionalIdfObject
 
- Protected Types inherited from openstudio::model::SizingPeriod
using ImplType = detail::SizingPeriod_Impl
 
- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
 
- 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.
 
- 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)
 

Member Typedef Documentation

◆ ImplType

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

Constructor & Destructor Documentation

◆ DesignDay() [1/4]

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

◆ ~DesignDay()

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

◆ DesignDay() [2/4]

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

◆ DesignDay() [3/4]

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

◆ DesignDay() [4/4]

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

Member Function Documentation

◆ ashraeClearSkyOpticalDepthForBeamIrradiance()

double openstudio::model::DesignDay::ashraeClearSkyOpticalDepthForBeamIrradiance ( ) const

◆ ashraeClearSkyOpticalDepthForDiffuseIrradiance()

double openstudio::model::DesignDay::ashraeClearSkyOpticalDepthForDiffuseIrradiance ( ) const

◆ ashraeTaub()

OS_DEPRECATED double openstudio::model::DesignDay::ashraeTaub ( ) const

◆ ashraeTaud()

OS_DEPRECATED double openstudio::model::DesignDay::ashraeTaud ( ) const

◆ barometricPressure()

double openstudio::model::DesignDay::barometricPressure ( ) const

◆ beamSolarDaySchedule()

boost::optional< ScheduleDay > openstudio::model::DesignDay::beamSolarDaySchedule ( ) const

◆ beginEnvironmentResetMode()

std::string openstudio::model::DesignDay::beginEnvironmentResetMode ( ) const

◆ dailyDryBulbTemperatureRange()

double openstudio::model::DesignDay::dailyDryBulbTemperatureRange ( ) const

◆ dailyWetBulbTemperatureRange()

boost::optional< double > openstudio::model::DesignDay::dailyWetBulbTemperatureRange ( ) const

◆ daylightSavingTimeIndicator()

bool openstudio::model::DesignDay::daylightSavingTimeIndicator ( ) const

◆ dayOfMonth()

int openstudio::model::DesignDay::dayOfMonth ( ) const

◆ dayType()

std::string openstudio::model::DesignDay::dayType ( ) const

◆ diffuseSolarDaySchedule()

boost::optional< ScheduleDay > openstudio::model::DesignDay::diffuseSolarDaySchedule ( ) const

◆ dryBulbTemperatureRangeModifierDaySchedule()

boost::optional< ScheduleDay > openstudio::model::DesignDay::dryBulbTemperatureRangeModifierDaySchedule ( ) const

◆ dryBulbTemperatureRangeModifierSchedule()

OS_DEPRECATED boost::optional< ScheduleDay > openstudio::model::DesignDay::dryBulbTemperatureRangeModifierSchedule ( ) const

◆ dryBulbTemperatureRangeModifierType()

std::string openstudio::model::DesignDay::dryBulbTemperatureRangeModifierType ( ) const

◆ enthalpyAtMaximumDryBulb()

boost::optional< double > openstudio::model::DesignDay::enthalpyAtMaximumDryBulb ( ) const

◆ humidityConditionDaySchedule()

boost::optional< ScheduleDay > openstudio::model::DesignDay::humidityConditionDaySchedule ( ) const

◆ humidityConditionType()

std::string openstudio::model::DesignDay::humidityConditionType ( ) const

◆ humidityIndicatingConditionsAtMaximumDryBulb()

OS_DEPRECATED double openstudio::model::DesignDay::humidityIndicatingConditionsAtMaximumDryBulb ( ) const

◆ humidityIndicatingDaySchedule()

OS_DEPRECATED boost::optional< ScheduleDay > openstudio::model::DesignDay::humidityIndicatingDaySchedule ( ) const

◆ humidityIndicatingType()

OS_DEPRECATED std::string openstudio::model::DesignDay::humidityIndicatingType ( ) const

◆ humidityRatioAtMaximumDryBulb()

boost::optional< double > openstudio::model::DesignDay::humidityRatioAtMaximumDryBulb ( ) const

◆ iddObjectType()

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

◆ isAshraeClearSkyOpticalDepthForBeamIrradianceDefaulted()

bool openstudio::model::DesignDay::isAshraeClearSkyOpticalDepthForBeamIrradianceDefaulted ( ) const

◆ isAshraeClearSkyOpticalDepthForDiffuseIrradianceDefaulted()

bool openstudio::model::DesignDay::isAshraeClearSkyOpticalDepthForDiffuseIrradianceDefaulted ( ) const

◆ isAshraeTaubDefaulted()

OS_DEPRECATED bool openstudio::model::DesignDay::isAshraeTaubDefaulted ( ) const

◆ isAshraeTaudDefaulted()

OS_DEPRECATED bool openstudio::model::DesignDay::isAshraeTaudDefaulted ( ) const

◆ isBarometricPressureDefaulted()

bool openstudio::model::DesignDay::isBarometricPressureDefaulted ( ) const

◆ isBeginEnvironmentResetModeDefaulted()

bool openstudio::model::DesignDay::isBeginEnvironmentResetModeDefaulted ( ) const

◆ isDailyDryBulbTemperatureRangeDefaulted()

bool openstudio::model::DesignDay::isDailyDryBulbTemperatureRangeDefaulted ( ) const

◆ isDaylightSavingTimeIndicatorDefaulted()

bool openstudio::model::DesignDay::isDaylightSavingTimeIndicatorDefaulted ( ) const

◆ isDayOfMonthDefaulted()

bool openstudio::model::DesignDay::isDayOfMonthDefaulted ( ) const

◆ isDayTypeDefaulted()

bool openstudio::model::DesignDay::isDayTypeDefaulted ( ) const

◆ isDryBulbTemperatureRangeModifierTypeDefaulted()

bool openstudio::model::DesignDay::isDryBulbTemperatureRangeModifierTypeDefaulted ( ) const

◆ isHumidityConditionTypeDefaulted()

bool openstudio::model::DesignDay::isHumidityConditionTypeDefaulted ( ) const

◆ isHumidityIndicatingConditionsAtMaximumDryBulbDefaulted()

OS_DEPRECATED bool openstudio::model::DesignDay::isHumidityIndicatingConditionsAtMaximumDryBulbDefaulted ( ) const

◆ isHumidityIndicatingTypeDefaulted()

OS_DEPRECATED bool openstudio::model::DesignDay::isHumidityIndicatingTypeDefaulted ( ) const

◆ isMaximumDryBulbTemperatureDefaulted()

bool openstudio::model::DesignDay::isMaximumDryBulbTemperatureDefaulted ( ) const

◆ isMonthDefaulted()

bool openstudio::model::DesignDay::isMonthDefaulted ( ) const

◆ isRainIndicatorDefaulted()

bool openstudio::model::DesignDay::isRainIndicatorDefaulted ( ) const

◆ isSkyClearnessDefaulted()

bool openstudio::model::DesignDay::isSkyClearnessDefaulted ( ) const

◆ isSnowIndicatorDefaulted()

bool openstudio::model::DesignDay::isSnowIndicatorDefaulted ( ) const

◆ isSolarModelIndicatorDefaulted()

bool openstudio::model::DesignDay::isSolarModelIndicatorDefaulted ( ) const

◆ isWindDirectionDefaulted()

bool openstudio::model::DesignDay::isWindDirectionDefaulted ( ) const

◆ isWindSpeedDefaulted()

bool openstudio::model::DesignDay::isWindSpeedDefaulted ( ) const

◆ maximumDryBulbTemperature()

double openstudio::model::DesignDay::maximumDryBulbTemperature ( ) const

◆ maximumNumberWarmupDays()

boost::optional< int > openstudio::model::DesignDay::maximumNumberWarmupDays ( ) const

◆ month()

int openstudio::model::DesignDay::month ( ) const

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ rainIndicator()

bool openstudio::model::DesignDay::rainIndicator ( ) const

◆ resetAshraeClearSkyOpticalDepthForBeamIrradiance()

void openstudio::model::DesignDay::resetAshraeClearSkyOpticalDepthForBeamIrradiance ( )

◆ resetAshraeClearSkyOpticalDepthForDiffuseIrradiance()

void openstudio::model::DesignDay::resetAshraeClearSkyOpticalDepthForDiffuseIrradiance ( )

◆ resetAshraeTaub()

OS_DEPRECATED void openstudio::model::DesignDay::resetAshraeTaub ( )

◆ resetAshraeTaud()

OS_DEPRECATED void openstudio::model::DesignDay::resetAshraeTaud ( )

◆ resetBarometricPressure()

void openstudio::model::DesignDay::resetBarometricPressure ( )

◆ resetBeamSolarDaySchedule()

void openstudio::model::DesignDay::resetBeamSolarDaySchedule ( )

◆ resetBeginEnvironmentResetMode()

void openstudio::model::DesignDay::resetBeginEnvironmentResetMode ( )

◆ resetDailyDryBulbTemperatureRange()

void openstudio::model::DesignDay::resetDailyDryBulbTemperatureRange ( )

◆ resetDailyWetBulbTemperatureRange()

void openstudio::model::DesignDay::resetDailyWetBulbTemperatureRange ( )

◆ resetDaylightSavingTimeIndicator()

void openstudio::model::DesignDay::resetDaylightSavingTimeIndicator ( )

◆ resetDayOfMonth()

void openstudio::model::DesignDay::resetDayOfMonth ( )

◆ resetDayType()

void openstudio::model::DesignDay::resetDayType ( )

◆ resetDiffuseSolarDaySchedule()

void openstudio::model::DesignDay::resetDiffuseSolarDaySchedule ( )

◆ resetDryBulbTemperatureRangeModifierDaySchedule()

void openstudio::model::DesignDay::resetDryBulbTemperatureRangeModifierDaySchedule ( )

◆ resetDryBulbTemperatureRangeModifierSchedule()

OS_DEPRECATED void openstudio::model::DesignDay::resetDryBulbTemperatureRangeModifierSchedule ( )

◆ resetDryBulbTemperatureRangeModifierType()

void openstudio::model::DesignDay::resetDryBulbTemperatureRangeModifierType ( )

◆ resetEnthalpyAtMaximumDryBulb()

void openstudio::model::DesignDay::resetEnthalpyAtMaximumDryBulb ( )

◆ resetHumidityConditionDaySchedule()

void openstudio::model::DesignDay::resetHumidityConditionDaySchedule ( )

◆ resetHumidityConditionType()

void openstudio::model::DesignDay::resetHumidityConditionType ( )

◆ resetHumidityIndicatingConditionsAtMaximumDryBulb()

OS_DEPRECATED void openstudio::model::DesignDay::resetHumidityIndicatingConditionsAtMaximumDryBulb ( )

◆ resetHumidityIndicatingDaySchedule()

OS_DEPRECATED void openstudio::model::DesignDay::resetHumidityIndicatingDaySchedule ( )

◆ resetHumidityIndicatingType()

OS_DEPRECATED void openstudio::model::DesignDay::resetHumidityIndicatingType ( )

◆ resetHumidityRatioAtMaximumDryBulb()

void openstudio::model::DesignDay::resetHumidityRatioAtMaximumDryBulb ( )

◆ resetMaximumDryBulbTemperature()

void openstudio::model::DesignDay::resetMaximumDryBulbTemperature ( )

◆ resetMaximumNumberWarmupDays()

void openstudio::model::DesignDay::resetMaximumNumberWarmupDays ( )

◆ resetMonth()

void openstudio::model::DesignDay::resetMonth ( )

◆ resetRainIndicator()

void openstudio::model::DesignDay::resetRainIndicator ( )

◆ resetSkyClearness()

void openstudio::model::DesignDay::resetSkyClearness ( )

◆ resetSnowIndicator()

void openstudio::model::DesignDay::resetSnowIndicator ( )

◆ resetSolarModelIndicator()

void openstudio::model::DesignDay::resetSolarModelIndicator ( )

◆ resetWetBulbOrDewPointAtMaximumDryBulb()

void openstudio::model::DesignDay::resetWetBulbOrDewPointAtMaximumDryBulb ( )

◆ resetWindDirection()

void openstudio::model::DesignDay::resetWindDirection ( )

◆ resetWindSpeed()

void openstudio::model::DesignDay::resetWindSpeed ( )

◆ setAshraeClearSkyOpticalDepthForBeamIrradiance()

bool openstudio::model::DesignDay::setAshraeClearSkyOpticalDepthForBeamIrradiance ( double ashraeClearSkyOpticalDepthForBeamIrradiance)

◆ setAshraeClearSkyOpticalDepthForDiffuseIrradiance()

bool openstudio::model::DesignDay::setAshraeClearSkyOpticalDepthForDiffuseIrradiance ( double ashraeClearSkyOpticalDepthForDiffuseIrradiance)

◆ setAshraeTaub()

OS_DEPRECATED bool openstudio::model::DesignDay::setAshraeTaub ( double ashraeTaub)

◆ setAshraeTaud()

OS_DEPRECATED bool openstudio::model::DesignDay::setAshraeTaud ( double ashraeTaud)

◆ setBarometricPressure()

bool openstudio::model::DesignDay::setBarometricPressure ( double barometricPressure)

◆ setBeamSolarDaySchedule()

bool openstudio::model::DesignDay::setBeamSolarDaySchedule ( const ScheduleDay & schedule)

◆ setBeginEnvironmentResetMode()

bool openstudio::model::DesignDay::setBeginEnvironmentResetMode ( const std::string & beginEnvironmentResetMode)

◆ setDailyDryBulbTemperatureRange()

bool openstudio::model::DesignDay::setDailyDryBulbTemperatureRange ( double dailyDryBulbTemperatureRange)

◆ setDailyWetBulbTemperatureRange()

bool openstudio::model::DesignDay::setDailyWetBulbTemperatureRange ( double dailyWetBulbTemperatureRange)

◆ setDaylightSavingTimeIndicator()

bool openstudio::model::DesignDay::setDaylightSavingTimeIndicator ( bool daylightSavingTimeIndicator)

◆ setDayOfMonth()

bool openstudio::model::DesignDay::setDayOfMonth ( int dayOfMonth)

◆ setDayType()

bool openstudio::model::DesignDay::setDayType ( const std::string & dayType)

◆ setDiffuseSolarDaySchedule()

bool openstudio::model::DesignDay::setDiffuseSolarDaySchedule ( const ScheduleDay & schedule)

◆ setDryBulbTemperatureRangeModifierDaySchedule()

bool openstudio::model::DesignDay::setDryBulbTemperatureRangeModifierDaySchedule ( const ScheduleDay & schedule)

◆ setDryBulbTemperatureRangeModifierSchedule()

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.

◆ setDryBulbTemperatureRangeModifierType()

bool openstudio::model::DesignDay::setDryBulbTemperatureRangeModifierType ( const std::string & dryBulbTemperatureRangeModifierType)

◆ setEnthalpyAtMaximumDryBulb()

bool openstudio::model::DesignDay::setEnthalpyAtMaximumDryBulb ( double enthalpyAtMaximumDryBulb)

◆ setHumidityConditionDaySchedule()

bool openstudio::model::DesignDay::setHumidityConditionDaySchedule ( const ScheduleDay & schedule)

◆ setHumidityConditionType()

bool openstudio::model::DesignDay::setHumidityConditionType ( const std::string & humidityConditionType)

◆ setHumidityIndicatingConditionsAtMaximumDryBulb()

OS_DEPRECATED bool openstudio::model::DesignDay::setHumidityIndicatingConditionsAtMaximumDryBulb ( double humidityIndicatingConditionsAtMaximumDryBulb)

◆ setHumidityIndicatingDaySchedule()

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.

◆ setHumidityIndicatingType()

OS_DEPRECATED bool openstudio::model::DesignDay::setHumidityIndicatingType ( const std::string & humidityIndicatingType)

◆ setHumidityRatioAtMaximumDryBulb()

bool openstudio::model::DesignDay::setHumidityRatioAtMaximumDryBulb ( double humidityRatioAtMaximumDryBulb)

◆ setMaximumDryBulbTemperature()

bool openstudio::model::DesignDay::setMaximumDryBulbTemperature ( double maximumDryBulbTemperature)

◆ setMaximumNumberWarmupDays()

bool openstudio::model::DesignDay::setMaximumNumberWarmupDays ( int maximumNumberWarmupDays)

◆ setMonth()

bool openstudio::model::DesignDay::setMonth ( int month)

◆ setRainIndicator()

bool openstudio::model::DesignDay::setRainIndicator ( bool rainIndicator)

◆ setSkyClearness()

bool openstudio::model::DesignDay::setSkyClearness ( double skyClearness)

◆ setSnowIndicator()

bool openstudio::model::DesignDay::setSnowIndicator ( bool snowIndicator)

◆ setSolarModelIndicator()

bool openstudio::model::DesignDay::setSolarModelIndicator ( const std::string & solarModelIndicator)

◆ setWetBulbOrDewPointAtMaximumDryBulb()

bool openstudio::model::DesignDay::setWetBulbOrDewPointAtMaximumDryBulb ( double wetBulbOrDewPointAtMaximumDryBulb)

◆ setWindDirection()

bool openstudio::model::DesignDay::setWindDirection ( double windDirection)

◆ setWindSpeed()

bool openstudio::model::DesignDay::setWindSpeed ( double windSpeed)

◆ skyClearness()

double openstudio::model::DesignDay::skyClearness ( ) const

◆ snowIndicator()

bool openstudio::model::DesignDay::snowIndicator ( ) const

◆ solarModelIndicator()

std::string openstudio::model::DesignDay::solarModelIndicator ( ) const

◆ validBeginEnvironmentResetModeValues()

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

◆ validDayTypeValues()

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

◆ validDryBulbTemperatureRangeModifierTypeValues()

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

◆ validHumidityConditionTypeValues()

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

◆ validHumidityIndicatingTypeValues()

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

◆ validSolarModelIndicatorValues()

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

◆ wetBulbOrDewPointAtMaximumDryBulb()

boost::optional< double > openstudio::model::DesignDay::wetBulbOrDewPointAtMaximumDryBulb ( ) const

◆ windDirection()

double openstudio::model::DesignDay::windDirection ( ) const

◆ windSpeed()

double openstudio::model::DesignDay::windSpeed ( ) const

Friends And Related Symbol Documentation

◆ DesignDayVector

using DesignDayVector = std::vector<DesignDay>
related

◆ OptionalDesignDay

using OptionalDesignDay = boost::optional<DesignDay>
related