#include <ScheduleYear.hpp>

Inheritance diagram for openstudio::model::ScheduleYear:

Public Member Functions
Getters
std::vector< openstudio::Date >	dates () const
	Returns a vector of dates marking the end of week schedules.

std::vector< ScheduleWeek >	scheduleWeeks () const
	Returns a vector of week schedules in the same order and with the same number of elements as dates.

Setters
bool	addScheduleWeek (const openstudio::Date &untilDate, const ScheduleWeek &scheduleWeek)
	Sets the given week schedule to be in effect until (inclusive) the date given starting the day after the previous date marker or January 1st if no previous date marker exists.

void	clearScheduleWeeks ()
	Clear all week schedules from this schedule.

Public Member Functions inherited from openstudio::model::Schedule
virtual	~Schedule () override=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 () override=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.

bool	setScheduleTypeLimits (const ScheduleTypeLimits &scheduleTypeLimits)
	Returns true if scheduleTypeLimits is compatible with this object and is actually set.

bool	resetScheduleTypeLimits ()
	Returns true if the scheduleTypeLimits() of this object is successfully cleared.

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.

unsigned	nonResourceObjectUseCount (bool excludeChildren=false) const
	Returns the number of non-ResourceObjects that use this resource either directly or indirectly.

ResourceObject &	operator= (const ResourceObject &)=default

ResourceObject &	operator= (ResourceObject &&)=default

	ResourceObject (const ResourceObject &other)=default

	ResourceObject (ResourceObject &&other)=default

virtual	~ResourceObject () override=default

Public Member Functions inherited from openstudio::model::ParentObject
ParentObject &	operator= (const ParentObject &)=default

ParentObject &	operator= (ParentObject &&)=default

	ParentObject (const ParentObject &other)=default

	ParentObject (ParentObject &&other)=default

virtual	~ParentObject () override=default

std::vector< ModelObject >	children () const
	Return direct child objects in the Model.

std::vector< IddObjectType >	allowableChildTypes () 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

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

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< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one.

std::vector< ResourceObject >	resources () 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< OutputVariable >	outputVariables () const
	Get all output variables associated with this object, must run simulation to generate data.

boost::optional< openstudio::TimeSeries >	getData (const OutputVariable &variable, const std::string &envPeriod) const
	Get data associated with this output variable and this object.

std::vector< LifeCycleCost >	lifeCycleCosts () const
	Returns the list of all LifeCycleCosts that refer to this object.

std::vector< IdfObject >	removeLifeCycleCosts ()
	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< IdfObject >	removeAdditionalProperties ()
	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< ScheduleTypeKey >	getScheduleTypeKeys (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< EMSActuatorNames >	emsActuatorNames () 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< ModelObject >	connectedObject (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< WorkspaceObject >	getSources (IddObjectType type) const

std::vector< WorkspaceObject >	getSources (IddObjectType type) const

boost::optional< WorkspaceObject >	getTarget (unsigned index) const

boost::optional< WorkspaceObject >	getTarget (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)

WorkspaceObject &	operator= (const WorkspaceObject &)=default

WorkspaceObject &	operator= (const WorkspaceObject &)=default

WorkspaceObject &	operator= (WorkspaceObject &&)=default

WorkspaceObject &	operator= (WorkspaceObject &&)=default

std::vector< openstudio::IdfObject >	remove ()

std::vector< openstudio::IdfObject >	remove ()

bool	setPointer (unsigned index, const Handle &targetHandle)

bool	setPointer (unsigned index, const Handle &targetHandle)

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	targets () const

std::vector< WorkspaceObject >	targets () 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

T	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< IdfExtensibleGroup >	extensibleGroups () const

std::vector< IdfExtensibleGroup >	extensibleGroups () 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)

IdfObject &	operator= (const IdfObject &other)

IdfObject &	operator= (const IdfObject &other)

IdfObject &	operator= (IdfObject &&other) noexcept

IdfObject &	operator= (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

Related Symbols
(Note that these are not member symbols.)
using	OptionalScheduleYear = boost::optional<ScheduleYear>

using	ScheduleYearVector = std::vector<ScheduleYear>

Related Symbols inherited from openstudio::model::ScheduleBase
using	OptionalScheduleBase = boost::optional<ScheduleBase>

using	ScheduleBaseVector = std::vector<ScheduleBase>

Related Symbols inherited from openstudio::model::ResourceObject
using	OptionalResourceObject = boost::optional<ResourceObject>

using	ResourceObjectVector = std::vector<ResourceObject>

Related Symbols 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 .

std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects .

Related Symbols inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object.

Constructors and Destructors
	ScheduleYear (const Model &model)

virtual	~ScheduleYear () override=default

	ScheduleYear (const ScheduleYear &other)=default

	ScheduleYear (ScheduleYear &&other)=default

ScheduleYear &	operator= (const ScheduleYear &)=default

ScheduleYear &	operator= (ScheduleYear &&)=default

static IddObjectType	iddObjectType ()

Other
boost::optional< ScheduleWeek >	getScheduleWeek (const openstudio::Date &date) const
	Returns the week schedule in effect at the given date.

Additional Inherited Members
Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional< WorkspaceObject >	OptionalWorkspaceObject

typedef std::vector< WorkspaceObject >	WorkspaceObjectVector

Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject, IdfObject >	IdfObjectPair

typedef std::vector< IdfObject >	IdfObjectVector

typedef boost::optional< IdfObject >	OptionalIdfObject

Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObject >	load (const std::string &text)

static boost::optional< IdfObject >	load (const std::string &text, const IddObject &iddObject)

static int	printedFieldSpace ()

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::ResourceObject
	ResourceObject (IddObjectType type, const Model &model)
	Constructs a new PlanarSurface object in the model.

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)

Detailed Description

ScheduleYear is a Schedule that wraps the OpenStudio IDD object 'OS_Schedule_Year'.

Constructor & Destructor Documentation

◆ ScheduleYear() [1/3]

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

explicit

◆ ~ScheduleYear()

virtual openstudio::model::ScheduleYear::~ScheduleYear ( )

overridevirtualdefault

◆ ScheduleYear() [2/3]

openstudio::model::ScheduleYear::ScheduleYear ( const ScheduleYear & other )

default

◆ ScheduleYear() [3/3]

openstudio::model::ScheduleYear::ScheduleYear ( ScheduleYear && other )

default

Member Function Documentation

◆ addScheduleWeek()

bool openstudio::model::ScheduleYear::addScheduleWeek	(	const openstudio::Date &	untilDate,
		const ScheduleWeek &	scheduleWeek )

Sets the given week schedule to be in effect until (inclusive) the date given starting the day after the previous date marker or January 1st if no previous date marker exists.

Replaces existing scheduleWeek for same date if it exists.

◆ clearScheduleWeeks()

void openstudio::model::ScheduleYear::clearScheduleWeeks ( )

Clear all week schedules from this schedule.

◆ dates()

std::vector< openstudio::Date > openstudio::model::ScheduleYear::dates ( ) const

Returns a vector of dates marking the end of week schedules.

These dates will be in order and have the same number of elements as scheduleWeeks.

◆ getScheduleWeek()

boost::optional< ScheduleWeek > openstudio::model::ScheduleYear::getScheduleWeek ( const openstudio::Date & date ) const

Returns the week schedule in effect at the given date.

◆ iddObjectType()

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

static

◆ operator=() [1/2]

ScheduleYear & openstudio::model::ScheduleYear::operator= ( const ScheduleYear & )

default

◆ operator=() [2/2]

ScheduleYear & openstudio::model::ScheduleYear::operator= ( ScheduleYear && )

default

◆ scheduleWeeks()

std::vector< ScheduleWeek > openstudio::model::ScheduleYear::scheduleWeeks ( ) const

Returns a vector of week schedules in the same order and with the same number of elements as dates.

Friends And Related Symbol Documentation

◆ OptionalScheduleYear

using OptionalScheduleYear = boost::optional<ScheduleYear>

using ScheduleYearVector = std::vector<ScheduleYear>

Public Member Functions

Related Symbols

Constructors and Destructors

Other

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ScheduleYear() [1/3]

◆ ~ScheduleYear()

◆ ScheduleYear() [2/3]

◆ ScheduleYear() [3/3]

Member Function Documentation

◆ addScheduleWeek()

◆ clearScheduleWeeks()

◆ dates()

◆ getScheduleWeek()

◆ iddObjectType()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ scheduleWeeks()

Friends And Related Symbol Documentation

◆ OptionalScheduleYear

◆ ScheduleYearVector