#include <ScheduleRule.hpp>

Inheritance diagram for openstudio::model::ScheduleRule:

Public Member Functions
Constructors and Destructors
	ScheduleRule (ScheduleRuleset &scheduleRuleset)
	Constructor associates this rule with the given ruleset. More...

	ScheduleRule (ScheduleRuleset &scheduleRuleset, const ScheduleDay &daySchedule)
	Constructor associates this rule with the given ruleset. More...

virtual	~ScheduleRule ()

Getters
ScheduleRuleset	scheduleRuleset () const

int	ruleIndex () const

ScheduleDay	daySchedule () const

bool	applySunday () const

bool	applyMonday () const

bool	applyTuesday () const

bool	applyWednesday () const

bool	applyThursday () const

bool	applyFriday () const

bool	applySaturday () const

std::string	dateSpecificationType () const

boost::optional< openstudio::Date >	startDate () const
	Returns the start date of the date range if set. More...

boost::optional< openstudio::Date >	endDate () const
	Returns the end date of the date range if set. More...

std::vector< openstudio::Date >	specificDates () const
	Returns the specific dates specified if any. More...

Setters
bool	setApplySunday (bool applySunday)

void	setApplySundayNoFail (bool applySunday)

bool	setApplyMonday (bool applyMonday)

void	setApplyMondayNoFail (bool applyMonday)

bool	setApplyTuesday (bool applyTuesday)

void	setApplyTuesdayNoFail (bool applyTuesday)

bool	setApplyWednesday (bool applyWednesday)

void	setApplyWednesdayNoFail (bool applyWednesday)

bool	setApplyThursday (bool applyThursday)

void	setApplyThursdayNoFail (bool applyThursday)

bool	setApplyFriday (bool applyFriday)

void	setApplyFridayNoFail (bool applyFriday)

bool	setApplySaturday (bool applySaturday)

void	setApplySaturdayNoFail (bool applySaturday)

bool	setStartDate (const openstudio::Date &date)
	Sets the start date of the date range, will delete any specific dates specified. More...

bool	setEndDate (const openstudio::Date &date)
	Sets the end date of the date range, will delete any specific dates specified. More...

bool	addSpecificDate (const openstudio::Date &date)
	Adds a specific date, will delete start and end dates. More...

void	ensureNoLeapDays ()

Other
bool	containsDate (const openstudio::Date &date)
	Returns true if this rule covers the given date. More...

std::vector< bool >	containsDates (const std::vector< openstudio::Date > &dates)
	Returns whether or not this rule covers each given date. More...

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

Public Member Functions inherited from openstudio::WorkspaceObject
bool	canBeSource () const

bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const

std::vector< std::string >	canBeTarget () const

std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const

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

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

IdfObject	idfObject ()

IdfObject	idfObject () const

bool	initialized () const

bool	isSource () const

bool	isTarget () const

unsigned	numSources () const

bool	objectListFieldsEqual (const WorkspaceObject &other) const

bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const

bool	operator< (const WorkspaceObject &right) const

std::ostream &	operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)

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

bool	setPointer (unsigned index, const Handle &targetHandle)

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	targets () const

Workspace	workspace () const

virtual	~WorkspaceObject ()

Public Member Functions inherited from openstudio::IdfObject
std::string	briefDescription () const

T	cast () const

std::vector< T >	castVector (const std::vector< U > &objects)

std::vector< std::vector < std::string > >	clearExtensibleGroups ()

IdfObject	clone (bool keepHandle=false) const

std::string	comment () const

boost::optional< std::string >	createName (bool overwrite=true)

std::vector< unsigned >	dataFields () const

bool	dataFieldsEqual (const IdfObject &other) const

std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)

std::vector< IdfExtensibleGroup >	extensibleGroups () const

boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const

boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const

IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const

std::vector< Handle >	getHandles (const std::vector< T > &objects)

boost::optional< int >	getInt (unsigned index, bool returnDefault=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< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const

boost::optional< QUrl >	getURL (unsigned index, bool returnDefault=false) const

Handle	handle () const

IddObject	iddObject () const

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (const IdfObject &other)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)

bool	isDataField (unsigned index) const

bool	isEmpty (unsigned index) const

bool	isObjectListField (unsigned index) const

bool	isValid (StrictnessLevel level, bool checkNames=false) const

boost::optional< unsigned >	maxExtensibleGroups () const

boost::optional< unsigned >	maxFields () const

unsigned	minExtensibleGroups () const

unsigned	minFields () const

boost::optional< std::string >	name (bool returnDefault=false) const

std::string	nameString (bool returnDefault=false) const

unsigned	numExtensibleGroups () const

unsigned	numFields () const

unsigned	numNonextensibleFields () const

std::vector< unsigned >	objectListFields () const

bool	objectListFieldsEqual (const IdfObject &other) const

bool	objectListFieldsNonConflicting (const IdfObject &other) const

bool	operator!= (const IdfObject &other) const

std::ostream &	operator<< (std::ostream &os, const IdfObject &IdfObject)

bool	operator== (const IdfObject &other) const

boost::optional< T >	optionalCast () const

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 (const std::vector< std::string > &values)

std::vector< unsigned >	requiredFields () const

void	setComment (const std::string &msg)

bool	setDouble (unsigned index, double value)

bool	setFieldComment (unsigned index, const std::string &cmnt)

bool	setInt (unsigned index, int value)

boost::optional< std::string >	setName (const std::string &newName)

bool	setQuantity (unsigned index, const Quantity &q)

bool	setString (unsigned index, const std::string &value)

bool	setUnsigned (unsigned index, unsigned value)

std::vector< T >	subsetCastVector (const std::vector< U > &original)

ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const

virtual	~IdfObject ()

Static Public Member Functions
static IddObjectType	iddObjectType ()

static std::vector< std::string >	validDateSpecificationTypeValues ()

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 Member Functions
bool	setRuleIndex (int index)

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)

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)

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

typedef std::vector< ScheduleRule >	ScheduleRuleVector

Related Functions inherited from openstudio::model::ParentObject
std::vector< ModelObject >	getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false)
	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...

typedef std::pair< std::string, std::string >	ScheduleTypeKey
	Typedef for ScheduleTypeRegistry key. More...

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

Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl	ImplType

Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl	ImplType

Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl	ImplType

Detailed Description

ScheduleRule is a ParentObject that wraps the OpenStudio IDD object 'OS:Schedule:Rule'.

Constructor & Destructor Documentation

openstudio::model::ScheduleRule::ScheduleRule ( ScheduleRuleset & scheduleRuleset )

explicit

Constructor associates this rule with the given ruleset.

This rule is made to be the highest priority rule. A new ScheduleDay is created which is owned by (a child of) this rule.

openstudio::model::ScheduleRule::ScheduleRule	(	ScheduleRuleset &	scheduleRuleset,
		const ScheduleDay &	daySchedule
	)

explicit

Constructor associates this rule with the given ruleset.

This rule is made to be the highest priority rule. The given daySchedule is cloned and the new object is owned by (a child of) this rule.

virtual openstudio::model::ScheduleRule::~ScheduleRule ( )

inlinevirtual

Member Function Documentation

bool openstudio::model::ScheduleRule::addSpecificDate ( const openstudio::Date & date )

Adds a specific date, will delete start and end dates.

bool openstudio::model::ScheduleRule::applyFriday ( ) const

bool openstudio::model::ScheduleRule::applyMonday ( ) const

bool openstudio::model::ScheduleRule::applySaturday ( ) const

bool openstudio::model::ScheduleRule::applySunday ( ) const

bool openstudio::model::ScheduleRule::applyThursday ( ) const

bool openstudio::model::ScheduleRule::applyTuesday ( ) const

bool openstudio::model::ScheduleRule::applyWednesday ( ) const

bool openstudio::model::ScheduleRule::containsDate ( const openstudio::Date & date )

Returns true if this rule covers the given date.

std::vector<bool> openstudio::model::ScheduleRule::containsDates ( const std::vector< openstudio::Date > & dates )

Returns whether or not this rule covers each given date.

std::string openstudio::model::ScheduleRule::dateSpecificationType ( ) const

ScheduleDay openstudio::model::ScheduleRule::daySchedule ( ) const

boost::optional<openstudio::Date> openstudio::model::ScheduleRule::endDate ( ) const

Returns the end date of the date range if set.

A start date > end date indicates that the range wraps around the year.

void openstudio::model::ScheduleRule::ensureNoLeapDays ( )

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

static

int openstudio::model::ScheduleRule::ruleIndex ( ) const

ScheduleRuleset openstudio::model::ScheduleRule::scheduleRuleset ( ) const

bool openstudio::model::ScheduleRule::setApplyFriday ( bool applyFriday )

void openstudio::model::ScheduleRule::setApplyFridayNoFail ( bool applyFriday )

bool openstudio::model::ScheduleRule::setApplyMonday ( bool applyMonday )

void openstudio::model::ScheduleRule::setApplyMondayNoFail ( bool applyMonday )

bool openstudio::model::ScheduleRule::setApplySaturday ( bool applySaturday )

void openstudio::model::ScheduleRule::setApplySaturdayNoFail ( bool applySaturday )

bool openstudio::model::ScheduleRule::setApplySunday ( bool applySunday )

void openstudio::model::ScheduleRule::setApplySundayNoFail ( bool applySunday )

bool openstudio::model::ScheduleRule::setApplyThursday ( bool applyThursday )

void openstudio::model::ScheduleRule::setApplyThursdayNoFail ( bool applyThursday )

bool openstudio::model::ScheduleRule::setApplyTuesday ( bool applyTuesday )

void openstudio::model::ScheduleRule::setApplyTuesdayNoFail ( bool applyTuesday )

bool openstudio::model::ScheduleRule::setApplyWednesday ( bool applyWednesday )

void openstudio::model::ScheduleRule::setApplyWednesdayNoFail ( bool applyWednesday )

bool openstudio::model::ScheduleRule::setEndDate ( const openstudio::Date & date )

Sets the end date of the date range, will delete any specific dates specified.

A start date > end date indicates that the range wraps around the year.

bool openstudio::model::ScheduleRule::setRuleIndex ( int index )

protected

bool openstudio::model::ScheduleRule::setStartDate ( const openstudio::Date & date )

Sets the start date of the date range, will delete any specific dates specified.

A start date > end date indicates that the range wraps around the year.

std::vector<openstudio::Date> openstudio::model::ScheduleRule::specificDates ( ) const

Returns the specific dates specified if any.

boost::optional<openstudio::Date> openstudio::model::ScheduleRule::startDate ( ) const

Returns the start date of the date range if set.

A start date > end date indicates that the range wraps around the year.

static std::vector<std::string> openstudio::model::ScheduleRule::validDateSpecificationTypeValues ( )

static

Friends And Related Function Documentation

typedef boost::optional<ScheduleRule> OptionalScheduleRule

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation