OpenStudio:airflow
Loading...
Searching...
No Matches
openstudio::contam::SchedulePoint Class Reference

#include <PrjSubobjects.hpp>

Public Member Functions

Constructors
 SchedulePoint ()
 Create a new object with default values.
 
 SchedulePoint (std::string time, double ctrl)
 Create a new object.
 
 SchedulePoint (std::string time, std::string ctrl)
 Create a new object.
 
Input and Output
void read (Reader &reader)
 Read an object from a Reader.
 
std::string write ()
 Write the object to a string.
 

Getters and Setters

std::string time () const
 Returns the time-of-day (hh:mm:ss).
 
void setTime (const std::string &time)
 Sets the time-of-day (hh:mm:ss).
 
double ctrl () const
 Returns the control value.
 
bool setCtrl (const double ctrl)
 Sets the control value.
 
bool setCtrl (const std::string &ctrl)
 Sets the control value.
 

Detailed Description

SchedulePoint stores the time (in hh:mm:ss format) and control value for a day schedule data point.

Constructor & Destructor Documentation

◆ SchedulePoint() [1/3]

openstudio::contam::SchedulePoint::SchedulePoint ( )

Create a new object with default values.

◆ SchedulePoint() [2/3]

openstudio::contam::SchedulePoint::SchedulePoint ( std::string time,
double ctrl )

Create a new object.

◆ SchedulePoint() [3/3]

openstudio::contam::SchedulePoint::SchedulePoint ( std::string time,
std::string ctrl )

Create a new object.

Member Function Documentation

◆ ctrl()

double openstudio::contam::SchedulePoint::ctrl ( ) const

Returns the control value.

◆ read()

void openstudio::contam::SchedulePoint::read ( Reader & reader)

Read an object from a Reader.

◆ setCtrl() [1/2]

bool openstudio::contam::SchedulePoint::setCtrl ( const double ctrl)

Sets the control value.

◆ setCtrl() [2/2]

bool openstudio::contam::SchedulePoint::setCtrl ( const std::string & ctrl)

Sets the control value.

◆ setTime()

void openstudio::contam::SchedulePoint::setTime ( const std::string & time)

Sets the time-of-day (hh:mm:ss).

◆ time()

std::string openstudio::contam::SchedulePoint::time ( ) const

Returns the time-of-day (hh:mm:ss).

◆ write()

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

Write the object to a string.