openstudio::contam::WeekSchedule Class Reference

#include <PrjObjects.hpp>

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

Detailed Description

The WeekSchedule object represents a complete week with 12 possible day schedules.

Constructor & Destructor Documentation

openstudio::contam::WeekSchedule::WeekSchedule

(

)

Create a new object with default values.

openstudio::contam::WeekSchedule::WeekSchedule	(	int	nr,
		int	utyp,
		int	ucnv,
		std::string	name,
		std::string	desc,
		std::vector< int >	j
	)

Create a new object.

openstudio::contam::WeekSchedule::WeekSchedule

(

const WeekSchedule &

other

)

Create a new object from another object.

openstudio::contam::WeekSchedule::~WeekSchedule ( )

default

Destroy the object.

Member Function Documentation

std::string openstudio::contam::WeekSchedule::desc

(

)

const

Returns the schedule description.

std::vector<int> openstudio::contam::WeekSchedule::j

(

)

const

Returns the vector of 12 day schedule indices.

std::string openstudio::contam::WeekSchedule::name

(

)

const

Returns the schedule name.

int openstudio::contam::WeekSchedule::nr

(

)

const

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

bool openstudio::contam::WeekSchedule::operator!=

(

const WeekSchedule &

other

)

const

Inequality operator.

WeekSchedule& openstudio::contam::WeekSchedule::operator=

(

const WeekSchedule &

other

)

Copy operator.

bool openstudio::contam::WeekSchedule::operator==

(

const WeekSchedule &

other

)

const

Equality operator.

void openstudio::contam::WeekSchedule::read

(

Reader &

input

)

Read an object from a Reader.

void openstudio::contam::WeekSchedule::setDesc

(

const std::string &

desc

)

Sets the schedule description.

void openstudio::contam::WeekSchedule::setJ

(

const std::vector< int > &

j

)

Sets the vector of day schedule indices.

There should be 12 indices.

void openstudio::contam::WeekSchedule::setName

(

const std::string &

name

)

Sets the schedule name.

void openstudio::contam::WeekSchedule::setNr

(

const int

nr

)

Sets the schedule number.

This should only be done with care.

void openstudio::contam::WeekSchedule::setUcnv

(

const int

ucnv

)

Sets the schedule unit conversion.

void openstudio::contam::WeekSchedule::setUtyp

(

const int

utyp

)

Sets the type of units.

int openstudio::contam::WeekSchedule::ucnv

(

)

const

Returns the schedule unit conversion.

int openstudio::contam::WeekSchedule::utyp

(

)

const

Returns the type of units.

std::string openstudio::contam::WeekSchedule::write

(

)

Write the object to a string.