OpenStudioCore:airflow
 All Classes Namespaces Functions Enumerations Enumerator
List of all members
openstudio::contam::DaySchedule Class Reference

#include <PrjObjects.hpp>

Public Member Functions

Constructors and Destructors
 DaySchedule ()
 Create a new object with default values. More...
 
 DaySchedule (int nr, int shape, int utyp, int ucnv, std::string name, std::string desc, std::vector< SchedulePoint > points)
 Create a new object. More...
 
 DaySchedule (const DaySchedule &other)
 Create a new object from another object. More...
 
 ~DaySchedule ()
 Destroy the object. More...
 
Operators
DayScheduleoperator= (const DaySchedule &other)
 Copy operator. More...
 
bool operator== (const DaySchedule &other) const
 Equality operator. More...
 
bool operator!= (const DaySchedule &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 shape () const
 Returns the schedule shape: 0 = rectangular, 1 = trapezoidal. More...
 
void setShape (const int shape)
 Sets the schedule shape: 0 = rectangular, 1 = trapezoidal. 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< SchedulePointpoints () const
 Returns the schedule points as a vector. More...
 
void setPoints (const std::vector< SchedulePoint > &points)
 Sets the schedule point vector. More...
 

Detailed Description

The DaySchedule object contains schedule data for a single day.

Constructor & Destructor Documentation

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

Create a new object with default values.

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.

openstudio::contam::DaySchedule::DaySchedule ( const DaySchedule other)

Create a new object from another object.

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

Destroy the object.

Member Function Documentation

std::string openstudio::contam::DaySchedule::desc ( ) const

Returns the schedule description.

std::string openstudio::contam::DaySchedule::name ( ) const

Returns the schedule name.

int openstudio::contam::DaySchedule::nr ( ) const

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

bool openstudio::contam::DaySchedule::operator!= ( const DaySchedule other) const

Inequality operator.

DaySchedule& openstudio::contam::DaySchedule::operator= ( const DaySchedule other)

Copy operator.

bool openstudio::contam::DaySchedule::operator== ( const DaySchedule other) const

Equality operator.

std::vector<SchedulePoint> openstudio::contam::DaySchedule::points ( ) const

Returns the schedule points as a vector.

void openstudio::contam::DaySchedule::read ( Reader input)

Read an object from a Reader.

void openstudio::contam::DaySchedule::setDesc ( const std::string &  desc)

Sets the schedule description.

void openstudio::contam::DaySchedule::setName ( const std::string &  name)

Sets the schedule name.

void openstudio::contam::DaySchedule::setNr ( const int  nr)

Sets the schedule number.

This should only be done with care.

void openstudio::contam::DaySchedule::setPoints ( const std::vector< SchedulePoint > &  points)

Sets the schedule point vector.

void openstudio::contam::DaySchedule::setShape ( const int  shape)

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

void openstudio::contam::DaySchedule::setUcnv ( const int  ucnv)

Sets the schedule unit conversion.

void openstudio::contam::DaySchedule::setUtyp ( const int  utyp)

Sets the type of units.

int openstudio::contam::DaySchedule::shape ( ) const

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

int openstudio::contam::DaySchedule::ucnv ( ) const

Returns the schedule unit conversion.

int openstudio::contam::DaySchedule::utyp ( ) const

Returns the type of units.

std::string openstudio::contam::DaySchedule::write ( )

Write the object to a string.