openstudio::model::ScheduleFile Class Reference

#include <ScheduleFile.hpp>

Inheritance diagram for openstudio::model::ScheduleFile:

Public Member Functions
Constructors and Destructors
	ScheduleFile (const ExternalFile &externalfile, int column=1, int rowsToSkip=0)
	ScheduleFile (const Model &model, const openstudio::path &filePath, int column=1, int rowsToSkip=0)
virtual	~ScheduleFile ()=default
	ScheduleFile (const ScheduleFile &other)=default
	ScheduleFile (ScheduleFile &&other)=default
ScheduleFile &	operator= (const ScheduleFile &)=default
ScheduleFile &	operator= (ScheduleFile &&)=default
Getters
boost::optional < ScheduleTypeLimits >	scheduleTypeLimits () const
ExternalFile	externalFile () const
int	columnNumber () const
int	rowstoSkipatTop () const
boost::optional< int >	numberofHoursofData () const
bool	isNumberofHoursofDataDefaulted () const
std::string	columnSeparator () const
bool	isColumnSeparatorDefaulted () const
bool	interpolatetoTimestep () const
bool	isInterpolatetoTimestepDefaulted () const
boost::optional< std::string >	minutesperItem () const
bool	isMinutesperItemDefaulted () const
bool	adjustScheduleforDaylightSavings () const
bool	isAdjustScheduleforDaylightSavingsDefaulted () const
boost::optional< CSVFile >	csvFile () const
Setters
bool	setScheduleTypeLimits (const ScheduleTypeLimits &scheduleTypeLimits)
bool	resetScheduleTypeLimits ()
bool	setColumnNumber (int columnNumber)
bool	setRowstoSkipatTop (int rowstoSkipatTop)
bool	setNumberofHoursofData (int numberofHours)
bool	setColumnSeparator (const std::string &columnSeparator)
void	resetColumnSeparator ()
bool	setInterpolatetoTimestep (bool interpolatetoTimestep)
void	resetInterpolatetoTimestep ()
OS_DEPRECATED bool	setMinutesperItem (const std::string &minutesperItem)
bool	setMinutesperItem (int minutesperItem)
void	resetMinutesperItem ()
bool	setAdjustScheduleforDaylightSavings (bool adjustScheduleforDaylightSavings)
void	resetAdjustScheduleforDaylightSavings ()
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 std::vector< std::string >	minutesperItemValues ()
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	OptionalScheduleFile = boost::optional< ScheduleFile >
using	ScheduleFileVector = std::vector< ScheduleFile >
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)

Detailed Description

ScheduleFile is a ScheduleInterval that wraps the OpenStudio IDD object 'OS:Schedule:File'.

Constructor & Destructor Documentation

openstudio::model::ScheduleFile::ScheduleFile	(	const ExternalFile &	externalfile,
		int	column = 1,
		int	rowsToSkip = 0
	)

openstudio::model::ScheduleFile::ScheduleFile	(	const Model &	model,
		const openstudio::path &	filePath,
		int	column = 1,
		int	rowsToSkip = 0
	)

virtual openstudio::model::ScheduleFile::~ScheduleFile ( )

virtualdefault

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

default

openstudio::model::ScheduleFile::ScheduleFile ( ScheduleFile &&  other )

default

Member Function Documentation

bool openstudio::model::ScheduleFile::adjustScheduleforDaylightSavings

(

)

const

int openstudio::model::ScheduleFile::columnNumber

(

)

const

std::string openstudio::model::ScheduleFile::columnSeparator

(

)

const

boost::optional<CSVFile> openstudio::model::ScheduleFile::csvFile

(

)

const

ExternalFile openstudio::model::ScheduleFile::externalFile

(

)

const

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

static

bool openstudio::model::ScheduleFile::interpolatetoTimestep

(

)

const

bool openstudio::model::ScheduleFile::isAdjustScheduleforDaylightSavingsDefaulted

(

)

const

bool openstudio::model::ScheduleFile::isColumnSeparatorDefaulted

(

)

const

bool openstudio::model::ScheduleFile::isInterpolatetoTimestepDefaulted

(

)

const

bool openstudio::model::ScheduleFile::isMinutesperItemDefaulted

(

)

const

bool openstudio::model::ScheduleFile::isNumberofHoursofDataDefaulted

(

)

const

boost::optional<std::string> openstudio::model::ScheduleFile::minutesperItem

(

)

const

static std::vector<std::string> openstudio::model::ScheduleFile::minutesperItemValues ( )

static

boost::optional<int> openstudio::model::ScheduleFile::numberofHoursofData

(

)

const

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

default

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

default

void openstudio::model::ScheduleFile::resetAdjustScheduleforDaylightSavings

(

)

void openstudio::model::ScheduleFile::resetColumnSeparator

(

)

void openstudio::model::ScheduleFile::resetInterpolatetoTimestep

(

)

void openstudio::model::ScheduleFile::resetMinutesperItem

(

)

bool openstudio::model::ScheduleFile::resetScheduleTypeLimits

(

)

int openstudio::model::ScheduleFile::rowstoSkipatTop

(

)

const

boost::optional<ScheduleTypeLimits> openstudio::model::ScheduleFile::scheduleTypeLimits

(

)

const

bool openstudio::model::ScheduleFile::setAdjustScheduleforDaylightSavings

(

bool

adjustScheduleforDaylightSavings

)

bool openstudio::model::ScheduleFile::setColumnNumber

(

int

columnNumber

)

bool openstudio::model::ScheduleFile::setColumnSeparator

(

const std::string &

columnSeparator

)

bool openstudio::model::ScheduleFile::setInterpolatetoTimestep

(

bool

interpolatetoTimestep

)

OS_DEPRECATED bool openstudio::model::ScheduleFile::setMinutesperItem

(

const std::string &

minutesperItem

)

bool openstudio::model::ScheduleFile::setMinutesperItem

(

int

minutesperItem

)

bool openstudio::model::ScheduleFile::setNumberofHoursofData

(

int

numberofHours

)

bool openstudio::model::ScheduleFile::setRowstoSkipatTop

(

int

rowstoSkipatTop

)

bool openstudio::model::ScheduleFile::setScheduleTypeLimits

(

const ScheduleTypeLimits &

scheduleTypeLimits

)

Friends And Related Function Documentation

using OptionalScheduleFile = boost::optional<ScheduleFile>

related

using ScheduleFileVector = std::vector<ScheduleFile>

related