 |
OpenStudio:model |
#include <RunPeriod.hpp>
Inheritance diagram for openstudio::model::RunPeriod:Public Member Functions | |
| bool | isAnnual () const |
| Returns true if RunPeriod specifies run between 1/1-12/31. More... | |
| bool | isPartialYear () const |
| Returns true if not annual simulation. More... | |
| bool | isRepeated () const |
| Returns true if numTimePeriodRepeats is greater than 1. More... | |
Constructors and Destructors | |
| virtual | ~RunPeriod () |
Getters | |
| int | getBeginMonth () const |
| int | getBeginDayOfMonth () const |
| int | getEndMonth () const |
| int | getEndDayOfMonth () const |
| bool | getUseWeatherFileHolidays () const |
| bool | getUseWeatherFileDaylightSavings () const |
| bool | getApplyWeekendHolidayRule () const |
| bool | getUseWeatherFileRainInd () const |
| bool | getUseWeatherFileSnowInd () const |
| int | getNumTimePeriodRepeats () const |
Setters | |
| bool | setBeginMonth (int month) |
| bool | setBeginDayOfMonth (int day) |
| bool | setEndMonth (int month) |
| bool | setEndDayOfMonth (int day) |
| bool | setUseWeatherFileHolidays (bool use) |
| bool | setUseWeatherFileDaylightSavings (bool use) |
| bool | setApplyWeekendHolidayRule (bool apply) |
| bool | setUseWeatherFileRainInd (bool rainInd) |
| bool | setUseWeatherFileSnowInd (bool snowInd) |
| bool | setNumTimePeriodRepeats (int numRepeats) |
| void | ensureNoLeapDays () |
| Public Member Functions inherited from openstudio::model::ParentObject | |
| std::vector< IddObjectType > | allowableChildTypes () const |
| Returns a vector of allowable children types. More... | |
| std::vector< ModelObject > | children () 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< ParentObject > | parent () const |
| Return this object's parent in the hierarchy, if it has one. More... | |
| std::vector< ResourceObject > | resources () 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< OutputVariable > | outputVariables () const |
| Get all output variables associated with this object, must run simulation to generate data. More... | |
| boost::optional < openstudio::TimeSeries > | getData (const OutputVariable &variable, const std::string &envPeriod) const |
| Get data associated with this output variable and this object. More... | |
| std::vector< LifeCycleCost > | lifeCycleCosts () const |
| Returns the list of all LifeCycleCosts that refer to this object. More... | |
| std::vector< IdfObject > | removeLifeCycleCosts () |
| 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< IdfObject > | removeAdditionalProperties () |
| Removes all additional properties that refer to this object. More... | |
| 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 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< ScheduleTypeKey > | getScheduleTypeKeys (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< ModelObject > | connectedObject (unsigned port) const |
| boost::optional< unsigned > | connectedObjectPort (unsigned port) const |
Static Public Member Functions | |
| static IddObjectType | iddObjectType () |
| Returns the IddObjectType. More... | |
Related Functions | |
(Note that these are not member functions.) | |
| typedef boost::optional < RunPeriod > | OptionalRunPeriod |
| typedef std::vector< RunPeriod > | RunPeriodVector |
| Related Functions inherited from openstudio::model::ParentObject | |
| std::vector< ModelObject > | getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true) |
| Returns object and all other objects accessible by calling children() on encountered ParentObjects . More... | |
| std::vector< ModelObject > | getRecursiveChildrenAndResources (const ModelObject &object) |
| Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More... | |
| Related Functions inherited from openstudio::model::ModelObject | |
| std::vector< ResourceObject > | getRecursiveResources (const ModelObject &object) |
| Returns all ResourceObjects accessible by recursively calling .resources() starting from object. More... | |
Additional Inherited Members | |
| Protected Types inherited from openstudio::model::ModelObject | |
| typedef detail::ModelObject_Impl | ImplType |
| 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) | |
RunPeriod derives from ParentObject and is an interface to the unique OpenStudio IDD object named "RunPeriod".
RunPeriod defines a period of time over which to run an EnergyPlus weather file simulation. Some applications require a full annual EnergyPlus simulation, others do not.
|
inlinevirtual |
| void openstudio::model::RunPeriod::ensureNoLeapDays | ( | ) |
| bool openstudio::model::RunPeriod::getApplyWeekendHolidayRule | ( | ) | const |
| int openstudio::model::RunPeriod::getBeginDayOfMonth | ( | ) | const |
| int openstudio::model::RunPeriod::getBeginMonth | ( | ) | const |
| int openstudio::model::RunPeriod::getEndDayOfMonth | ( | ) | const |
| int openstudio::model::RunPeriod::getEndMonth | ( | ) | const |
| int openstudio::model::RunPeriod::getNumTimePeriodRepeats | ( | ) | const |
| bool openstudio::model::RunPeriod::getUseWeatherFileDaylightSavings | ( | ) | const |
| bool openstudio::model::RunPeriod::getUseWeatherFileHolidays | ( | ) | const |
| bool openstudio::model::RunPeriod::getUseWeatherFileRainInd | ( | ) | const |
| bool openstudio::model::RunPeriod::getUseWeatherFileSnowInd | ( | ) | const |
|
static |
Returns the IddObjectType.
| bool openstudio::model::RunPeriod::isAnnual | ( | ) | const |
Returns true if RunPeriod specifies run between 1/1-12/31.
| bool openstudio::model::RunPeriod::isPartialYear | ( | ) | const |
Returns true if not annual simulation.
| bool openstudio::model::RunPeriod::isRepeated | ( | ) | const |
Returns true if numTimePeriodRepeats is greater than 1.
| bool openstudio::model::RunPeriod::setApplyWeekendHolidayRule | ( | bool | apply | ) |
| bool openstudio::model::RunPeriod::setBeginDayOfMonth | ( | int | day | ) |
| bool openstudio::model::RunPeriod::setBeginMonth | ( | int | month | ) |
| bool openstudio::model::RunPeriod::setEndDayOfMonth | ( | int | day | ) |
| bool openstudio::model::RunPeriod::setEndMonth | ( | int | month | ) |
| bool openstudio::model::RunPeriod::setNumTimePeriodRepeats | ( | int | numRepeats | ) |
| bool openstudio::model::RunPeriod::setUseWeatherFileDaylightSavings | ( | bool | use | ) |
| bool openstudio::model::RunPeriod::setUseWeatherFileHolidays | ( | bool | use | ) |
| bool openstudio::model::RunPeriod::setUseWeatherFileRainInd | ( | bool | rainInd | ) |
| bool openstudio::model::RunPeriod::setUseWeatherFileSnowInd | ( | bool | snowInd | ) |
|
related |
|
related |