openstudio::UnitSystem Class Reference

#include <Unit.hpp>

Inheritance diagram for openstudio::UnitSystem:

Public Types
enum	domain { BOOST_PP_SEQ_FOR_EACH =(OPENSTUDIO_ENUM_DOMAIN_ELEM, UnitSystem , ((Mixed)) ((SI)) ((IP)) ((BTU)) ((CFM)) ((GPD)) ((MPH)) ((Wh)) ((Therm)) ((Misc1)) ((Celsius)) ((Fahrenheit)) ) }

Public Member Functions
	UnitSystem ()
	UnitSystem (const std::string &t_name)
	UnitSystem (int t_value)
domain	value () const
Public Member Functions inherited from EnumBase< UnitSystem >
	EnumBase ()=delete
	Default constructor. More...
	EnumBase (int t_value)
	Construct from t_value. More...
	EnumBase (const std::string &t_value)
	Construct from t_value. More...
int	integer_value () const
	Returns this instance's current value (as an integer). More...
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. More...
int	lookupValue (int t_value)
	Returns t_value if it is in the domain. More...
bool	operator!= (const EnumBase< UnitSystem > &other) const
bool	operator< (const EnumBase< UnitSystem > &other) const
bool	operator<= (const EnumBase< UnitSystem > &other) const
bool	operator== (const EnumBase< UnitSystem > &other) const
bool	operator> (const EnumBase< UnitSystem > &other) const
bool	operator>= (const EnumBase< UnitSystem > &other) const
void	setValue (int t_value)
	Set this instance's value to t_value. More...
std::string	valueDescription () const
	Returns the description associated with this instance's current value. More...
std::string	valueName () const
	Returns the name associated with this instance's current value. More...
Public Member Functions inherited from StaticInitializer< UnitSystem >
	StaticInitializer ()

Static Public Member Functions
static std::string	enumName ()
Static Public Member Functions inherited from EnumBase< UnitSystem >
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. More...
static void	initialize ()
static std::string	valueDescription (int t_value)
	Returns the description associated with t_value, if it exists. More...
static std::string	valueName (int t_value)
	Returns the name associated with t_value, if it exists. More...
Static Public Member Functions inherited from StaticInitializer< UnitSystem >
static void	do_initialize ()

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

Detailed Description

Unit systems supported by OpenStudio's runtime units utility.

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

OPENSTUDIO_ENUM(UnitSystem,
  ((Mixed))
  ((SI))
  ((IP))
  ((BTU))
  ((CFM))
  ((GPD))
  ((MPH))
  ((Wh))
  ((Therm))
  ((Misc1))
  ((Celsius))
  ((Fahrenheit))
);

Member Enumeration Documentation

enum openstudio::UnitSystem::domain

Enumerator
BOOST_PP_SEQ_FOR_EACH

Constructor & Destructor Documentation

openstudio::UnitSystem::UnitSystem ( )

inline

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

inline

openstudio::UnitSystem::UnitSystem ( int  t_value )

inline

Member Function Documentation

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

inlinestatic

domain openstudio::UnitSystem::value ( ) const

inline