OpenStudioCore:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Public Attributes | List of all members
openstudio::YearDescription Struct Reference

#include <Date.hpp>

Public Member Functions

int assumedYear () const
 get the assumed year More...
 
 YearDescription ()
 constructor More...
 

Public Attributes

bool isLeapYear
 is the year a leap year, defaults to false More...
 
bool lookInFuture
 look for year in future, defaults to false More...
 
boost::optional< DayOfWeekyearStartsOnDayOfWeek
 first day of the year, defaults to not set More...
 

Detailed Description

YearDescription describes a year with several optional parameters.

Constructor & Destructor Documentation

openstudio::YearDescription::YearDescription ( )

constructor

Member Function Documentation

int openstudio::YearDescription::assumedYear ( ) const

get the assumed year

Member Data Documentation

bool openstudio::YearDescription::isLeapYear

is the year a leap year, defaults to false

bool openstudio::YearDescription::lookInFuture

look for year in future, defaults to false

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

first day of the year, defaults to not set