OpenStudio:utilities
Loading...
Searching...
No Matches
openstudio::EndUses Class Reference

#include <EndUses.hpp>

Public Member Functions

void addEndUse (double value, const EndUseFuelType &fuelType, const EndUseCategoryType &category, const std::string &subCategory="General")
 add an end use
 
Attribute attribute () const
 Returns the attribute.
 
 EndUses ()
 Constructs a new end uses attribute.
 
double getEndUse (const EndUseFuelType &fuelType, const EndUseCategoryType &category) const
 get end use value across sub categories
 
double getEndUse (const EndUseFuelType &fuelType, const EndUseCategoryType &category, const std::string &subCategory) const
 get end use value
 
double getEndUseByCategory (const EndUseCategoryType &category) const
 get end use value across fuel types and sub categories
 
double getEndUseByCategory (const EndUseCategoryType &category, const std::string &subCategory) const
 get end use value across fuel types
 
double getEndUseByFuelType (const EndUseFuelType &fuelType) const
 get end use value across categories and sub categories
 
std::vector< std::string > subCategories () const
 get list of all sub cateogories
 

Static Public Member Functions

static std::string attributeName ()
 Returns the expected name for attributes of this type, 'EndUses'.
 
static std::vector< EndUseCategoryTypecategories ()
 get list of all categories
 
static boost::optional< EndUsesfromAttribute (const Attribute &attribute)
 Creates an EndUses wrapper around attribute if it is correctly formatted.
 
static std::vector< EndUseFuelTypefuelTypes ()
 get list of all fuel types
 
static std::string getUnitsForFuelType (const EndUseFuelType &fuelType)
 get units for fuel type
 

Detailed Description

EndUses is wrapper around Attribute for storing information about end uses.

Constructor & Destructor Documentation

◆ EndUses()

openstudio::EndUses::EndUses ( )

Constructs a new end uses attribute.

Member Function Documentation

◆ addEndUse()

void openstudio::EndUses::addEndUse ( double value,
const EndUseFuelType & fuelType,
const EndUseCategoryType & category,
const std::string & subCategory = "General" )

add an end use

◆ attribute()

Attribute openstudio::EndUses::attribute ( ) const

Returns the attribute.

◆ attributeName()

static std::string openstudio::EndUses::attributeName ( )
static

Returns the expected name for attributes of this type, 'EndUses'.

◆ categories()

static std::vector< EndUseCategoryType > openstudio::EndUses::categories ( )
static

get list of all categories

◆ fromAttribute()

static boost::optional< EndUses > openstudio::EndUses::fromAttribute ( const Attribute & attribute)
static

Creates an EndUses wrapper around attribute if it is correctly formatted.

◆ fuelTypes()

static std::vector< EndUseFuelType > openstudio::EndUses::fuelTypes ( )
static

get list of all fuel types

◆ getEndUse() [1/2]

double openstudio::EndUses::getEndUse ( const EndUseFuelType & fuelType,
const EndUseCategoryType & category ) const

get end use value across sub categories

◆ getEndUse() [2/2]

double openstudio::EndUses::getEndUse ( const EndUseFuelType & fuelType,
const EndUseCategoryType & category,
const std::string & subCategory ) const

get end use value

◆ getEndUseByCategory() [1/2]

double openstudio::EndUses::getEndUseByCategory ( const EndUseCategoryType & category) const

get end use value across fuel types and sub categories

◆ getEndUseByCategory() [2/2]

double openstudio::EndUses::getEndUseByCategory ( const EndUseCategoryType & category,
const std::string & subCategory ) const

get end use value across fuel types

◆ getEndUseByFuelType()

double openstudio::EndUses::getEndUseByFuelType ( const EndUseFuelType & fuelType) const

get end use value across categories and sub categories

◆ getUnitsForFuelType()

static std::string openstudio::EndUses::getUnitsForFuelType ( const EndUseFuelType & fuelType)
static

get units for fuel type

◆ subCategories()

std::vector< std::string > openstudio::EndUses::subCategories ( ) const

get list of all sub cateogories