ScheduleFile Class Reference

#include "ScheduleFile.hpp"

Inheritance diagram for openstudio::model::ScheduleFile:

Public Member Functions
	ScheduleFile (const ExternalFile &externalfile, int column=1, int rowsToSkip=0)
virtual	~ScheduleFile ()
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
boost::optional< CSVFile >	csvFile () const
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 ()

Static Public Member Functions
static IddObjectType	iddObjectType ()
static std::vector< std::string >	minutesperItemValues ()

Related Functions
typedef boost::optional < ScheduleFile >	OptionalScheduleFile
typedef std::vector< ScheduleFile >	ScheduleFileVector

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
	)

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

inlinevirtual

Member Function Documentation

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::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

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::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

typedef boost::optional<ScheduleFile> OptionalScheduleFile

related

typedef std::vector<ScheduleFile> ScheduleFileVector

related