openstudio::contam::DaySchedule Class Reference

#include <PrjObjects.hpp>

Public Member Functions
Constructors and Destructors
	DaySchedule ()
	Create a new object with default values.
	DaySchedule (int nr, int shape, int utyp, int ucnv, std::string name, std::string desc, std::vector< SchedulePoint > points)
	Create a new object.
	DaySchedule (const DaySchedule &other)
	Create a new object from another object.
	~DaySchedule ()=default
	Destroy the object.
Operators
DaySchedule &	operator= (const DaySchedule &other)
	Copy operator.
bool	operator== (const DaySchedule &other) const
	Equality operator.
bool	operator!= (const DaySchedule &other) const
	Inequality operator.
Input and Output
void	read (Reader &input)
	Read an object from a Reader.
std::string	write ()
	Write the object to a string.
Getters and Setters
int	nr () const
	Returns the schedule number, in order from 1 to the number of schedules.
void	setNr (const int nr)
	Sets the schedule number.
int	shape () const
	Returns the schedule shape: 0 = rectangular, 1 = trapezoidal.
void	setShape (const int shape)
	Sets the schedule shape: 0 = rectangular, 1 = trapezoidal.
int	utyp () const
	Returns the type of units.
void	setUtyp (const int utyp)
	Sets the type of units.
int	ucnv () const
	Returns the schedule unit conversion.
void	setUcnv (const int ucnv)
	Sets the schedule unit conversion.
std::string	name () const
	Returns the schedule name.
void	setName (const std::string &name)
	Sets the schedule name.
std::string	desc () const
	Returns the schedule description.
void	setDesc (const std::string &desc)
	Sets the schedule description.
std::vector< SchedulePoint >	points () const
	Returns the schedule points as a vector.
void	setPoints (const std::vector< SchedulePoint > &points)
	Sets the schedule point vector.

Detailed Description

The DaySchedule object contains schedule data for a single day.

Constructor & Destructor Documentation

DaySchedule() [1/3]

openstudio::contam::DaySchedule::DaySchedule

(

)

Create a new object with default values.

DaySchedule() [2/3]

openstudio::contam::DaySchedule::DaySchedule	(	int	nr,
		int	shape,
		int	utyp,
		int	ucnv,
		std::string	name,
		std::string	desc,
		std::vector< SchedulePoint >	points )

Create a new object.

DaySchedule() [3/3]

openstudio::contam::DaySchedule::DaySchedule

(

const DaySchedule &

other

)

Create a new object from another object.

~DaySchedule()

openstudio::contam::DaySchedule::~DaySchedule ( )

default

Destroy the object.

Member Function Documentation

desc()

std::string openstudio::contam::DaySchedule::desc

(

)

const

Returns the schedule description.

name()

std::string openstudio::contam::DaySchedule::name

(

)

const

Returns the schedule name.

nr()

int openstudio::contam::DaySchedule::nr

(

)

const

Returns the schedule number, in order from 1 to the number of schedules.

operator!=()

bool openstudio::contam::DaySchedule::operator!=

(

const DaySchedule &

other

)

const

Inequality operator.

operator=()

DaySchedule & openstudio::contam::DaySchedule::operator=

(

const DaySchedule &

other

)

Copy operator.

operator==()

bool openstudio::contam::DaySchedule::operator==

(

const DaySchedule &

other

)

const

Equality operator.

points()

std::vector< SchedulePoint > openstudio::contam::DaySchedule::points

(

)

const

Returns the schedule points as a vector.

read()

void openstudio::contam::DaySchedule::read

(

Reader &

input

)

Read an object from a Reader.

setDesc()

void openstudio::contam::DaySchedule::setDesc

(

const std::string &

desc

)

Sets the schedule description.

setName()

void openstudio::contam::DaySchedule::setName

(

const std::string &

name

)

Sets the schedule name.

setNr()

void openstudio::contam::DaySchedule::setNr

(

const int

nr

)

Sets the schedule number.

This should only be done with care.

setPoints()

void openstudio::contam::DaySchedule::setPoints

(

const std::vector< SchedulePoint > &

points

)

Sets the schedule point vector.

setShape()

void openstudio::contam::DaySchedule::setShape

(

const int

shape

)

Sets the schedule shape: 0 = rectangular, 1 = trapezoidal.

setUcnv()

void openstudio::contam::DaySchedule::setUcnv

(

const int

ucnv

)

Sets the schedule unit conversion.

setUtyp()

void openstudio::contam::DaySchedule::setUtyp

(

const int

utyp

)

Sets the type of units.

shape()

int openstudio::contam::DaySchedule::shape

(

)

const

Returns the schedule shape: 0 = rectangular, 1 = trapezoidal.

ucnv()

int openstudio::contam::DaySchedule::ucnv

(

)

const

Returns the schedule unit conversion.

utyp()

int openstudio::contam::DaySchedule::utyp

(

)

const

Returns the type of units.

write()

std::string openstudio::contam::DaySchedule::write

(

)

Write the object to a string.