#include <ScheduleFixedInterval.hpp>
Public Member Functions | |
Constructors and Destructors | |
ScheduleFixedInterval (const Model &model) | |
virtual | ~ScheduleFixedInterval () |
Getters | |
bool | interpolatetoTimestep () const |
bool | isInterpolatetoTimestepDefaulted () const |
bool | translatetoScheduleFile () const |
bool | isTranslatetoScheduleFileDefaulted () const |
double | 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 (double 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 () |
openstudio::TimeSeries | timeSeries () const |
bool | setTimeSeries (const openstudio::TimeSeries &timeSeries) |
Public Member Functions inherited from openstudio::model::Schedule | |
virtual | ~Schedule () |
Public Member Functions inherited from openstudio::model::ScheduleBase | |
virtual | ~ScheduleBase () |
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... | |
virtual | ~ResourceObject () |
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... | |
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 () |
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.) | |
typedef boost::optional < ScheduleFixedInterval > | OptionalScheduleFixedInterval |
typedef std::vector < ScheduleFixedInterval > | ScheduleFixedIntervalVector |
Related Functions inherited from openstudio::model::ScheduleInterval | |
typedef boost::optional < ScheduleInterval > | OptionalScheduleInterval |
typedef std::vector < ScheduleInterval > | ScheduleIntervalVector |
Related Functions inherited from openstudio::model::ScheduleBase | |
typedef boost::optional < ScheduleBase > | OptionalScheduleBase |
typedef std::vector< ScheduleBase > | ScheduleBaseVector |
Related Functions inherited from openstudio::model::ResourceObject | |
typedef boost::optional < ResourceObject > | OptionalResourceObject |
typedef std::vector < ResourceObject > | ResourceObjectVector |
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 | |
typedef detail::ScheduleInterval_Impl | ImplType |
Protected Types inherited from openstudio::model::ModelObject | |
typedef detail::ModelObject_Impl | ImplType |
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 |
|
inlinevirtual |
|
static |
bool openstudio::model::ScheduleFixedInterval::interpolatetoTimestep | ( | ) | const |
double openstudio::model::ScheduleFixedInterval::intervalLength | ( | ) | const |
bool openstudio::model::ScheduleFixedInterval::isInterpolatetoTimestepDefaulted | ( | ) | const |
bool openstudio::model::ScheduleFixedInterval::isOutOfRangeValueDefaulted | ( | ) | const |
bool openstudio::model::ScheduleFixedInterval::isTranslatetoScheduleFileDefaulted | ( | ) | const |
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 | ( | double | 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 |