openstudio::RunPeriodFields Class Reference

#include <RunPeriod_FieldEnums.hxx>

Inheritance diagram for openstudio::RunPeriodFields:

Public Types
enum	domain {   Name , BeginMonth , BeginDayofMonth , BeginYear ,   EndMonth , EndDayofMonth , EndYear , DayofWeekforStartDay ,   UseWeatherFileHolidaysandSpecialDays , UseWeatherFileDaylightSavingPeriod , ApplyWeekendHolidayRule , UseWeatherFileRainIndicators ,   UseWeatherFileSnowIndicators , TreatWeatherasActual , FirstHourInterpolationStartingValues }

Public Member Functions
	RunPeriodFields ()
	RunPeriodFields (const std::string &t_name)
	RunPeriodFields (int t_value)
domain	value () const

Static Public Member Functions
static std::string	enumName ()

Detailed Description

Enumeration of RunPeriod's Idd and Idf non-extensible fields.

This enumeration provides readable, and semi-robust tags to use instead of bare unsigned integer field indices. (The enumeration value names are more likely to be valid across EnergyPlus and OpenStudio releases, and will break if they become invalid.) See the OPENSTUDIO_ENUM documentation in utilities/core/Enum.hpp. The actual macro call is:

Member Enumeration Documentation

domain

enum openstudio::RunPeriodFields::domain

Enumerator
Name
BeginMonth
BeginDayofMonth
BeginYear
EndMonth
EndDayofMonth
EndYear
DayofWeekforStartDay
UseWeatherFileHolidaysandSpecialDays
UseWeatherFileDaylightSavingPeriod
ApplyWeekendHolidayRule
UseWeatherFileRainIndicators
UseWeatherFileSnowIndicators
TreatWeatherasActual
FirstHourInterpolationStartingValues

Constructor & Destructor Documentation

RunPeriodFields() [1/3]

openstudio::RunPeriodFields::RunPeriodFields ( )

inline

RunPeriodFields() [2/3]

openstudio::RunPeriodFields::RunPeriodFields ( const std::string & t_name )

inline

RunPeriodFields() [3/3]

openstudio::RunPeriodFields::RunPeriodFields ( int t_value )

inline

Member Function Documentation

enumName()

static std::string openstudio::RunPeriodFields::enumName ( )

inlinestatic

value()

domain openstudio::RunPeriodFields::value ( ) const

inline