 |
OpenStudio:model |
#include <ScheduleFixedInterval.hpp>
Inheritance diagram for openstudio::model::ScheduleFixedInterval:Public Member Functions | |
Constructors and Destructors | |
| ScheduleFixedInterval (const Model &model) | |
| virtual | ~ScheduleFixedInterval ()=default |
| ScheduleFixedInterval (const ScheduleFixedInterval &other)=default | |
| ScheduleFixedInterval (ScheduleFixedInterval &&other)=default | |
| ScheduleFixedInterval & | operator= (const ScheduleFixedInterval &)=default |
| ScheduleFixedInterval & | operator= (ScheduleFixedInterval &&)=default |
Getters | |
| bool | interpolatetoTimestep () const |
| bool | isInterpolatetoTimestepDefaulted () const |
| bool | translatetoScheduleFile () const |
| bool | isTranslatetoScheduleFileDefaulted () const |
| int | intervalLength () const |
| double | outOfRangeValue () const |
| bool | isOutOfRangeValueDefaulted () const |
| int | startMonth () const |
| int | startDay () const |
Setters | |
| bool | setInterpolatetoTimestep (bool interpolatetoTimestep) |
| void | resetInterpolatetoTimestep () |
| bool | setTranslatetoScheduleFile (bool translatetoScheduleFile) |
| void | resetTranslatetoScheduleFile () |
| bool | setIntervalLength (int intervalLength) |
| bool | setOutOfRangeValue (double outOfRangeValue) |
| void | resetOutOfRangeValue () |
| bool | setStartMonth (int startMonth) |
| bool | setStartDay (int startDay) |
| Public Member Functions inherited from openstudio::model::ScheduleInterval | |
| virtual | ~ScheduleInterval ()=default |
| ScheduleInterval (const ScheduleInterval &other)=default | |
| ScheduleInterval (ScheduleInterval &&other)=default | |
| ScheduleInterval & | operator= (const ScheduleInterval &)=default |
| ScheduleInterval & | operator= (ScheduleInterval &&)=default |
| openstudio::TimeSeries | timeSeries () const |
| bool | setTimeSeries (const openstudio::TimeSeries &timeSeries) |
| Public Member Functions inherited from openstudio::model::Schedule | |
| virtual | ~Schedule ()=default |
| Schedule (const Schedule &other)=default | |
| Schedule (Schedule &&other)=default | |
| Schedule & | operator= (const Schedule &)=default |
| Schedule & | operator= (Schedule &&)=default |
| Public Member Functions inherited from openstudio::model::ScheduleBase | |
| virtual | ~ScheduleBase ()=default |
| ScheduleBase (const ScheduleBase &other)=default | |
| ScheduleBase (ScheduleBase &&other)=default | |
| ScheduleBase & | operator= (const ScheduleBase &)=default |
| ScheduleBase & | operator= (ScheduleBase &&)=default |
| boost::optional < ScheduleTypeLimits > | scheduleTypeLimits () const |
| Returns the ScheduleTypeLimits of this object, if set. More... | |
| bool | setScheduleTypeLimits (const ScheduleTypeLimits &scheduleTypeLimits) |
| Returns true if scheduleTypeLimits is compatible with this object and is actually set. More... | |
| bool | resetScheduleTypeLimits () |
| Returns true if the scheduleTypeLimits() of this object is successfully cleared. More... | |
| void | ensureNoLeapDays () |
| Public Member Functions inherited from openstudio::model::ResourceObject | |
| unsigned | directUseCount (bool excludeChildren=false) const |
| Returns the number of objects that use this resource directly. More... | |
| unsigned | nonResourceObjectUseCount (bool excludeChildren=false) const |
| Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More... | |
| ResourceObject & | operator= (const ResourceObject &)=default |
| ResourceObject & | operator= (ResourceObject &&)=default |
| ResourceObject (const ResourceObject &other)=default | |
| ResourceObject (ResourceObject &&other)=default | |
| virtual | ~ResourceObject ()=default |
| 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... | |
| ParentObject & | operator= (const ParentObject &)=default |
| ParentObject & | operator= (ParentObject &&)=default |
| ParentObject (const ParentObject &other)=default | |
| ParentObject (ParentObject &&other)=default | |
| virtual | ~ParentObject ()=default |
| Public Member Functions inherited from openstudio::model::ModelObject | |
| virtual | ~ModelObject ()=default |
| ModelObject (const ModelObject &other)=default | |
| ModelObject (ModelObject &&other)=default | |
| ModelObject & | operator= (const ModelObject &)=default |
| ModelObject & | operator= (ModelObject &&)=default |
| 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 (const std::string &valueName, const std::string &units) 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 () |
| Static Public Member Functions inherited from openstudio::model::ScheduleInterval | |
| static boost::optional < ScheduleInterval > | fromTimeSeries (const openstudio::TimeSeries &timeSeries, Model &model) |
Related Functions | |
(Note that these are not member functions.) | |
| using | OptionalScheduleFixedInterval = boost::optional< ScheduleFixedInterval > |
| using | ScheduleFixedIntervalVector = std::vector< ScheduleFixedInterval > |
| Related Functions inherited from openstudio::model::ScheduleInterval | |
| using | OptionalScheduleInterval = boost::optional< ScheduleInterval > |
| using | ScheduleIntervalVector = std::vector< ScheduleInterval > |
| Related Functions inherited from openstudio::model::ScheduleBase | |
| using | OptionalScheduleBase = boost::optional< ScheduleBase > |
| using | ScheduleBaseVector = std::vector< ScheduleBase > |
| Related Functions inherited from openstudio::model::ResourceObject | |
| using | OptionalResourceObject = boost::optional< ResourceObject > |
| using | ResourceObjectVector = std::vector< ResourceObject > |
| 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::ScheduleInterval | |
| using | ImplType = detail::ScheduleInterval_Impl |
| Protected Types inherited from openstudio::model::ModelObject | |
| using | ImplType = detail::ModelObject_Impl |
| Protected Member Functions inherited from openstudio::model::ScheduleInterval | |
| ScheduleInterval (IddObjectType type, const Model &model) | |
| ScheduleInterval (std::shared_ptr< detail::ScheduleInterval_Impl > impl) | |
| Protected Member Functions inherited from openstudio::model::ResourceObject | |
| ResourceObject (IddObjectType type, const Model &model) | |
| Constructs a new PlanarSurface object in the model. More... | |
| 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) | |
ScheduleFixedInterval is a ScheduleInterval that wraps the OpenStudio IDD object 'OS_Schedule_FixedInterval'.
|
explicit |
|
virtualdefault |
|
default |
|
default |
|
static |
| bool openstudio::model::ScheduleFixedInterval::interpolatetoTimestep | ( | ) | const |
| int openstudio::model::ScheduleFixedInterval::intervalLength | ( | ) | const |
| bool openstudio::model::ScheduleFixedInterval::isInterpolatetoTimestepDefaulted | ( | ) | const |
| bool openstudio::model::ScheduleFixedInterval::isOutOfRangeValueDefaulted | ( | ) | const |
| bool openstudio::model::ScheduleFixedInterval::isTranslatetoScheduleFileDefaulted | ( | ) | const |
|
default |
|
default |
| double openstudio::model::ScheduleFixedInterval::outOfRangeValue | ( | ) | const |
| void openstudio::model::ScheduleFixedInterval::resetInterpolatetoTimestep | ( | ) |
| void openstudio::model::ScheduleFixedInterval::resetOutOfRangeValue | ( | ) |
| void openstudio::model::ScheduleFixedInterval::resetTranslatetoScheduleFile | ( | ) |
| bool openstudio::model::ScheduleFixedInterval::setInterpolatetoTimestep | ( | bool | interpolatetoTimestep | ) |
| bool openstudio::model::ScheduleFixedInterval::setIntervalLength | ( | int | intervalLength | ) |
| bool openstudio::model::ScheduleFixedInterval::setOutOfRangeValue | ( | double | outOfRangeValue | ) |
| bool openstudio::model::ScheduleFixedInterval::setStartDay | ( | int | startDay | ) |
| bool openstudio::model::ScheduleFixedInterval::setStartMonth | ( | int | startMonth | ) |
| bool openstudio::model::ScheduleFixedInterval::setTranslatetoScheduleFile | ( | bool | translatetoScheduleFile | ) |
| int openstudio::model::ScheduleFixedInterval::startDay | ( | ) | const |
| int openstudio::model::ScheduleFixedInterval::startMonth | ( | ) | const |
| bool openstudio::model::ScheduleFixedInterval::translatetoScheduleFile | ( | ) | const |
|
related |
|
related |