openstudio::MonthOfYear Class Reference

#include <Date.hpp>

Inheritance diagram for openstudio::MonthOfYear:

Public Types
enum	domain { BOOST_PP_SEQ_FOR_EACH =(OPENSTUDIO_ENUM_DOMAIN_ELEM, MonthOfYear, ((Jan)(January)(boost::date_time::Jan)) ((Feb)(February)(boost::date_time::Feb)) ((Mar)(March)(boost::date_time::Mar)) ((Apr)(April)(boost::date_time::Apr)) ((May)(May)(boost::date_time::May)) ((Jun)(June)(boost::date_time::Jun)) ((Jul)(July)(boost::date_time::Jul)) ((Aug)(August)(boost::date_time::Aug)) ((Sep)(September)(boost::date_time::Sep)) ((Oct)(October)(boost::date_time::Oct)) ((Nov)(November)(boost::date_time::Nov)) ((Dec)(December)(boost::date_time::Dec)) ((NotAMonth)(Not a month)(boost::date_time::NotAMonth)) ((NumMonths)(Number of months)(boost::date_time::NumMonths))) }

Public Member Functions
	MonthOfYear ()
	MonthOfYear (const std::string &t_name)
	MonthOfYear (int t_value)
domain	value () const
Public Member Functions inherited from EnumBase< MonthOfYear >
	EnumBase ()=delete
	Default constructor.
	EnumBase (const std::string &t_value)
	Construct from t_value.
	EnumBase (int t_value)
	Construct from t_value.
int	integer_value () const
	Returns this instance's current value (as an integer).
int	lookupValue (int t_value)
	Returns t_value if it is in the domain.
int	lookupValue (std::string t_name)
	Returns the (integer) value associated with t_name, as determined by case-insensitive comparison to the enumerated names and descriptions.
bool	operator!= (const EnumBase< MonthOfYear > &other) const
bool	operator< (const EnumBase< MonthOfYear > &other) const
bool	operator<= (const EnumBase< MonthOfYear > &other) const
bool	operator== (const EnumBase< MonthOfYear > &other) const
bool	operator> (const EnumBase< MonthOfYear > &other) const
bool	operator>= (const EnumBase< MonthOfYear > &other) const
void	setValue (int t_value)
	Set this instance's value to t_value.
std::string	valueDescription () const
	Returns the description associated with this instance's current value.
std::string	valueName () const
	Returns the name associated with this instance's current value.

Static Public Member Functions
static std::string	enumName ()
Static Public Member Functions inherited from EnumBase< MonthOfYear >
static const std::map< int, std::string > &	getDescriptions ()
static const std::map< std::string, int > &	getLookupMap ()
static const std::map< int, std::string > &	getNames ()
static const std::set< int > &	getValues ()
	Returns the set of all values in this enum's domain.
static void	initialize ()
static std::string	valueDescription (int t_value)
	Returns the description associated with t_value, if it exists.
static std::string	valueName (int t_value)
	Returns the name associated with t_value, if it exists.

Additional Inherited Members
Protected Attributes inherited from EnumBase< MonthOfYear >
int	m_value

Detailed Description

MonthOfYear is an enumeration of months: January, February, March, April, May, June, July, August, September, October, November, December.

See the OPENSTUDIO_ENUM documentation in utilities/core/Enum.hpp. The actual macro call is:

OPENSTUDIO_ENUM(MonthOfYear,
    ((Jan)(January)(boost::date_time::Jan))
    ((Feb)(February)(boost::date_time::Feb))
    ((Mar)(March)(boost::date_time::Mar))
    ((Apr)(April)(boost::date_time::Apr))
    ((May)(May)(boost::date_time::May))
    ((Jun)(June)(boost::date_time::Jun))
    ((Jul)(July)(boost::date_time::Jul))
    ((Aug)(August)(boost::date_time::Aug))
    ((Sep)(September)(boost::date_time::Sep))
    ((Oct)(October)(boost::date_time::Oct))
    ((Nov)(November)(boost::date_time::Nov))
    ((Dec)(December)(boost::date_time::Dec))
    ((NotAMonth)(Not a month)(boost::date_time::NotAMonth))
    ((NumMonths)(Number of months)(boost::date_time::NumMonths))
);

Member Enumeration Documentation

domain

enum openstudio::MonthOfYear::domain

Enumerator
BOOST_PP_SEQ_FOR_EACH

Constructor & Destructor Documentation

MonthOfYear() [1/3]

openstudio::MonthOfYear::MonthOfYear ( )

inline

MonthOfYear() [2/3]

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

inline

MonthOfYear() [3/3]

openstudio::MonthOfYear::MonthOfYear ( int t_value )

inline

Member Function Documentation

enumName()

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

inlinestatic

value()

domain openstudio::MonthOfYear::value ( ) const

inline