#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 More...

Attribute	attribute () const
	Returns the attribute. More...

	EndUses ()
	Constructs a new end uses attribute. More...

double	getEndUse (const EndUseFuelType &fuelType, const EndUseCategoryType &category, const std::string &subCategory) const
	get end use value More...

double	getEndUse (const EndUseFuelType &fuelType, const EndUseCategoryType &category) const
	get end use value across sub categories More...

double	getEndUseByCategory (const EndUseCategoryType &category, const std::string &subCategory) const
	get end use value across fuel types More...

double	getEndUseByCategory (const EndUseCategoryType &category) const
	get end use value across fuel types and sub categories More...

double	getEndUseByFuelType (const EndUseFuelType &fuelType) const
	get end use value across categories and sub categories More...

std::vector< std::string >	subCategories () const
	get list of all sub cateogories More...

Static Public Member Functions
static std::string	attributeName ()
	Returns the expected name for attributes of this type, 'EndUses'. More...

static std::vector < EndUseCategoryType >	categories ()
	get list of all categories More...

static boost::optional< EndUses >	fromAttribute (const Attribute &attribute)
	Creates an EndUses wrapper around attribute if it is correctly formatted. More...

static std::vector < EndUseFuelType >	fuelTypes ()
	get list of all fuel types More...

static std::string	getUnitsForFuelType (const EndUseFuelType &fuelType)
	get units for fuel type More...

Detailed Description

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

Constructor & Destructor Documentation

openstudio::EndUses::EndUses ( )

Constructs a new end uses attribute.

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

add an end use

Attribute openstudio::EndUses::attribute ( ) const

Returns the attribute.

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

static

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

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

static

get list of all categories

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

static

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

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

static

get list of all fuel types

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

get end use value

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

get end use value across sub categories

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

get end use value across fuel types

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

get end use value across fuel types and sub categories

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

get end use value across categories and sub categories

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

static

get units for fuel type

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

get list of all sub cateogories