RunPeriod Class Reference

#include "RunPeriod.hpp"

Inheritance diagram for openstudio::model::RunPeriod:

Public Member Functions
bool	isAnnual () const
bool	isPartialYear () const
bool	isRepeated () const
virtual	~RunPeriod ()
int	getBeginMonth () const
int	getBeginDayOfMonth () const
int	getEndMonth () const
int	getEndDayOfMonth () const
bool	getUseWeatherFileHolidays () const
bool	getUseWeatherFileDaylightSavings () const
bool	getApplyWeekendHolidayRule () const
bool	getUseWeatherFileRainInd () const
bool	getUseWeatherFileSnowInd () const
int	getNumTimePeriodRepeats () const
bool	setBeginMonth (int month)
bool	setBeginDayOfMonth (int day)
bool	setEndMonth (int month)
bool	setEndDayOfMonth (int day)
bool	setUseWeatherFileHolidays (bool use)
bool	setUseWeatherFileDaylightSavings (bool use)
bool	setApplyWeekendHolidayRule (bool apply)
bool	setUseWeatherFileRainInd (bool rainInd)
bool	setUseWeatherFileSnowInd (bool snowInd)
bool	setNumTimePeriodRepeats (int numRepeats)
void	ensureNoLeapDays ()

Static Public Member Functions
static IddObjectType	iddObjectType ()

Related Functions
typedef boost::optional < RunPeriod >	OptionalRunPeriod
typedef std::vector< RunPeriod >	RunPeriodVector

Detailed Description

RunPeriod derives from ParentObject and is an interface to the unique OpenStudio IDD object named "RunPeriod".

RunPeriod defines a period of time over which to run an EnergyPlus weather file simulation. Some applications require a full annual EnergyPlus simulation, others do not.

Constructor & Destructor Documentation

virtual openstudio::model::RunPeriod::~RunPeriod ( )

inlinevirtual

Member Function Documentation

void openstudio::model::RunPeriod::ensureNoLeapDays

(

)

bool openstudio::model::RunPeriod::getApplyWeekendHolidayRule

(

)

const

int openstudio::model::RunPeriod::getBeginDayOfMonth

(

)

const

int openstudio::model::RunPeriod::getBeginMonth

(

)

const

int openstudio::model::RunPeriod::getEndDayOfMonth

(

)

const

int openstudio::model::RunPeriod::getEndMonth

(

)

const

int openstudio::model::RunPeriod::getNumTimePeriodRepeats

(

)

const

bool openstudio::model::RunPeriod::getUseWeatherFileDaylightSavings

(

)

const

bool openstudio::model::RunPeriod::getUseWeatherFileHolidays

(

)

const

bool openstudio::model::RunPeriod::getUseWeatherFileRainInd

(

)

const

bool openstudio::model::RunPeriod::getUseWeatherFileSnowInd

(

)

const

static IddObjectType openstudio::model::RunPeriod::iddObjectType ( )

static

Returns the IddObjectType.

bool openstudio::model::RunPeriod::isAnnual

(

)

const

Returns true if RunPeriod specifies run between 1/1-12/31.

bool openstudio::model::RunPeriod::isPartialYear

(

)

const

Returns true if not annual simulation.

bool openstudio::model::RunPeriod::isRepeated

(

)

const

Returns true if numTimePeriodRepeats is greater than 1.

bool openstudio::model::RunPeriod::setApplyWeekendHolidayRule

(

bool

apply

)

bool openstudio::model::RunPeriod::setBeginDayOfMonth

(

int

day

)

bool openstudio::model::RunPeriod::setBeginMonth

(

int

month

)

bool openstudio::model::RunPeriod::setEndDayOfMonth

(

int

day

)

bool openstudio::model::RunPeriod::setEndMonth

(

int

month

)

bool openstudio::model::RunPeriod::setNumTimePeriodRepeats

(

int

numRepeats

)

bool openstudio::model::RunPeriod::setUseWeatherFileDaylightSavings

(

bool

use

)

bool openstudio::model::RunPeriod::setUseWeatherFileHolidays

(

bool

use

)

bool openstudio::model::RunPeriod::setUseWeatherFileRainInd

(

bool

rainInd

)

bool openstudio::model::RunPeriod::setUseWeatherFileSnowInd

(

bool

snowInd

)

Friends And Related Function Documentation

typedef boost::optional<RunPeriod> OptionalRunPeriod

related

typedef std::vector<RunPeriod> RunPeriodVector

related