RunPeriodControlSpecialDays Class Reference

#include "RunPeriodControlSpecialDays.hpp"

Inheritance diagram for openstudio::model::RunPeriodControlSpecialDays:

Public Member Functions
	RunPeriodControlSpecialDays (const std::string &startDate, Model &model)
	RunPeriodControlSpecialDays (const openstudio::MonthOfYear &monthOfYear, unsigned day, Model &model)
	RunPeriodControlSpecialDays (const openstudio::NthDayOfWeekInMonth &nth, const openstudio::DayOfWeek &dayOfWeek, const openstudio::MonthOfYear &monthOfYear, Model &model)
virtual	~RunPeriodControlSpecialDays ()
openstudio::Date	startDate () const
unsigned	duration () const
std::string	specialDayType () const
bool	setStartDate (const std::string &startDate)
bool	setStartDate (const openstudio::MonthOfYear &monthOfYear, unsigned day)
bool	setStartDate (const openstudio::NthDayOfWeekInMonth &nth, const openstudio::DayOfWeek &dayOfWeek, const openstudio::MonthOfYear &monthOfYear)
bool	setDuration (unsigned duration)
bool	setSpecialDayType (const std::string &specialDayType)
void	ensureNoLeapDays ()

Static Public Member Functions
static IddObjectType	iddObjectType ()

Related Functions
typedef boost::optional < RunPeriodControlSpecialDays >	OptionalRunPeriodControlSpecialDays
typedef std::vector < RunPeriodControlSpecialDays >	RunPeriodControlSpecialDaysVector

Detailed Description

RunPeriodControlSpecialDays derives from ModelObject and is an interface to the OpenStudio IDD object named "OS:RunPeriodControl:SpecialDays".

Constructor & Destructor Documentation

openstudio::model::RunPeriodControlSpecialDays::RunPeriodControlSpecialDays	(	const std::string &	startDate,
		Model &	model
	)

Constructor with string, will throw if incorrect format.

openstudio::model::RunPeriodControlSpecialDays::RunPeriodControlSpecialDays	(	const openstudio::MonthOfYear &	monthOfYear,
		unsigned	day,
		Model &	model
	)

Constructor with month of year and day, e.g.

Jan, 1.

openstudio::model::RunPeriodControlSpecialDays::RunPeriodControlSpecialDays	(	const openstudio::NthDayOfWeekInMonth &	nth,
		const openstudio::DayOfWeek &	dayOfWeek,
		const openstudio::MonthOfYear &	monthOfYear,
		Model &	model
	)

Constructor from nth day in month, e.g.

1st Friday in January.

virtual openstudio::model::RunPeriodControlSpecialDays::~RunPeriodControlSpecialDays ( )

inlinevirtual

Member Function Documentation

unsigned openstudio::model::RunPeriodControlSpecialDays::duration

(

)

const

void openstudio::model::RunPeriodControlSpecialDays::ensureNoLeapDays

(

)

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

static

Returns the IddObjectType.

bool openstudio::model::RunPeriodControlSpecialDays::setDuration

(

unsigned

duration

)

bool openstudio::model::RunPeriodControlSpecialDays::setSpecialDayType

(

const std::string &

specialDayType

)

bool openstudio::model::RunPeriodControlSpecialDays::setStartDate

(

const std::string &

startDate

)

bool openstudio::model::RunPeriodControlSpecialDays::setStartDate	(	const openstudio::MonthOfYear &	monthOfYear,
		unsigned	day
	)

bool openstudio::model::RunPeriodControlSpecialDays::setStartDate	(	const openstudio::NthDayOfWeekInMonth &	nth,
		const openstudio::DayOfWeek &	dayOfWeek,
		const openstudio::MonthOfYear &	monthOfYear
	)

std::string openstudio::model::RunPeriodControlSpecialDays::specialDayType

(

)

const

openstudio::Date openstudio::model::RunPeriodControlSpecialDays::startDate

(

)

const

Friends And Related Function Documentation

typedef boost::optional<RunPeriodControlSpecialDays> OptionalRunPeriodControlSpecialDays

related

typedef std::vector<RunPeriodControlSpecialDays> RunPeriodControlSpecialDaysVector

related