#include <ScheduleDay.hpp>

Inheritance diagram for openstudio::model::ScheduleDay:

Public Member Functions
Constructors and Destructors
	ScheduleDay (const Model &model)
	Initializes the schedule to a value of 0.0 until 24:00. More...

	ScheduleDay (const Model &model, double value)
	Initializes the schedule to value until 24:00. More...

virtual	~ScheduleDay ()

Getters
bool	isScheduleTypeLimitsDefaulted () const
	Returns true if this object does not specify a ScheduleTypeLimits directly, but rather inherits one from a Schedule. More...

bool	interpolatetoTimestep () const

bool	isInterpolatetoTimestepDefaulted () const

std::vector< openstudio::Time >	times () const
	Returns a vector of times marking the end value intervals. More...

std::vector< double >	values () const
	Returns a vector of values in the same order and with the same number of elements as times. More...

double	getValue (const openstudio::Time &time) const
	Returns the value in effect at the given time. If time is less than 0 days or greater than 1 day, 0 is returned. More...

Setters
bool	setInterpolatetoTimestep (bool interpolatetoTimestep)

void	resetInterpolatetoTimestep ()

bool	addValue (const openstudio::Time &untilTime, double value)
	Returns false if time is less than 0 days or greater than 1 day. More...

boost::optional< double >	removeValue (const openstudio::Time &time)
	Remove a value added by addValue at the exact time. More...

void	clearValues ()
	Clear all values from this schedule. More...

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

Related Functions
(Note that these are not member functions.)
typedef boost::optional < ScheduleDay >	OptionalScheduleDay

typedef std::vector< ScheduleDay >	ScheduleDayVector

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::ModelObject
typedef detail::ModelObject_Impl	ImplType

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)

Detailed Description

ScheduleDay is a ScheduleBase that wraps the OpenStudio IDD object 'OS_Schedule_Day'.

Constructor & Destructor Documentation

openstudio::model::ScheduleDay::ScheduleDay ( const Model & model )

explicit

Initializes the schedule to a value of 0.0 until 24:00.

openstudio::model::ScheduleDay::ScheduleDay	(	const Model &	model,
		double	value
	)

Initializes the schedule to value until 24:00.

virtual openstudio::model::ScheduleDay::~ScheduleDay ( )

inlinevirtual

Member Function Documentation

bool openstudio::model::ScheduleDay::addValue	(	const openstudio::Time &	untilTime,
		double	value
	)

Returns false if time is less than 0 days or greater than 1 day.

Replaces existing value for same time.

void openstudio::model::ScheduleDay::clearValues ( )

Clear all values from this schedule.

double openstudio::model::ScheduleDay::getValue ( const openstudio::Time & time ) const

Returns the value in effect at the given time. If time is less than 0 days or greater than 1 day, 0 is returned.

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

static

bool openstudio::model::ScheduleDay::interpolatetoTimestep ( ) const

bool openstudio::model::ScheduleDay::isInterpolatetoTimestepDefaulted ( ) const

bool openstudio::model::ScheduleDay::isScheduleTypeLimitsDefaulted ( ) const

Returns true if this object does not specify a ScheduleTypeLimits directly, but rather inherits one from a Schedule.

boost::optional<double> openstudio::model::ScheduleDay::removeValue ( const openstudio::Time & time )

Remove a value added by addValue at the exact time.

Returns the removed value if there was one.

void openstudio::model::ScheduleDay::resetInterpolatetoTimestep ( )

bool openstudio::model::ScheduleDay::setInterpolatetoTimestep ( bool interpolatetoTimestep )

std::vector<openstudio::Time> openstudio::model::ScheduleDay::times ( ) const

Returns a vector of times marking the end value intervals.

These times will be in order and have the same number of elements as values. All times will be less than or equal to 1 day.

std::vector<double> openstudio::model::ScheduleDay::values ( ) const

Returns a vector of values in the same order and with the same number of elements as times.

Friends And Related Function Documentation

typedef boost::optional<ScheduleDay> OptionalScheduleDay

Public Member Functions

Static Public Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation