openstudio::YearDescription Struct Reference

#include <Date.hpp>

Public Member Functions
int	assumedYear () const
	get the assumed year
	YearDescription ()
	constructor

Public Attributes
bool	isLeapYear
	is the year a leap year, defaults to false
bool	lookInFuture
	look for year in future, defaults to false
boost::optional< DayOfWeek >	yearStartsOnDayOfWeek
	first day of the year, defaults to not set

Detailed Description

YearDescription describes a year with several optional parameters.

Constructor & Destructor Documentation

YearDescription()

openstudio::YearDescription::YearDescription

(

)

constructor

Member Function Documentation

assumedYear()

int openstudio::YearDescription::assumedYear

(

)

const

get the assumed year

Member Data Documentation

isLeapYear

bool openstudio::YearDescription::isLeapYear

is the year a leap year, defaults to false

lookInFuture

bool openstudio::YearDescription::lookInFuture

look for year in future, defaults to false

yearStartsOnDayOfWeek

boost::optional<DayOfWeek> openstudio::YearDescription::yearStartsOnDayOfWeek

first day of the year, defaults to not set