OpenStudio:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | Static Public Member Functions | Related Functions | List of all members
openstudio::FuelType Class Reference

#include <DataEnums.hpp>

+ Inheritance diagram for openstudio::FuelType:

Public Types

enum  domain { BOOST_PP_SEQ_FOR_EACH =(OPENSTUDIO_ENUM_DOMAIN_ELEM, FuelType , ((Electricity)) ((Gas)(NaturalGas)) ((Gasoline)) ((Diesel)) ((FuelOil_1)) ((FuelOil_2)) ((Propane)) ((Water)) ((Steam)) ((DistrictCooling)) ((DistrictHeating)) ((EnergyTransfer)) ) }
 

Public Member Functions

 FuelType ()
 
 FuelType (const std::string &t_name)
 
 FuelType (int t_value)
 
domain value () const
 
- Public Member Functions inherited from EnumBase< FuelType >
 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 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 FuelType &other) const
 
bool operator< (const FuelType &other) const
 
bool operator<= (const FuelType &other) const
 
bool operator== (const FuelType &other) const
 
bool operator> (const FuelType &other) const
 
bool operator>= (const FuelType &other) const
 
void setValue (int t_value)
 Set this instance's value to t_value. More...
 
int value () const
 Returns this instance's current value (as an integer). 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< FuelType >
 StaticInitializer ()
 

Static Public Member Functions

static std::string enumName ()
 
- Static Public Member Functions inherited from EnumBase< FuelType >
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< FuelType >
static void do_initialize ()
 

Related Functions

(Note that these are not member functions.)

typedef std::vector< FuelTypeFuelTypeVector
 
typedef boost::optional< FuelTypeOptionalFuelType
 

Additional Inherited Members

- Protected Attributes inherited from EnumBase< FuelType >
int m_value
 

Detailed Description

EnergyPlus meterable fuel types.

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

OPENSTUDIO_ENUM(FuelType,
((Electricity))
((Gas)(NaturalGas))
((Gasoline))
((Diesel))
((FuelOil_1))
((FuelOil_2))
((Propane))
((Water))
((Steam))
((DistrictCooling))
((DistrictHeating))
((EnergyTransfer)));

Member Enumeration Documentation

Enumerator
BOOST_PP_SEQ_FOR_EACH 

Constructor & Destructor Documentation

openstudio::FuelType::FuelType ( )
inline
openstudio::FuelType::FuelType ( const std::string &  t_name)
inline
openstudio::FuelType::FuelType ( int  t_value)
inline

Member Function Documentation

static std::string openstudio::FuelType::enumName ( )
inlinestatic
domain openstudio::FuelType::value ( ) const
inline

Friends And Related Function Documentation

typedef std::vector<FuelType> FuelTypeVector
related
typedef boost::optional<FuelType> OptionalFuelType
related