#include "ThermUnit.hpp"

Inheritance diagram for openstudio::ThermUnit:

Public Member Functions
	ThermUnit (const ThermExpnt &exponents=ThermExpnt(), int scaleExponent=0, const std::string &prettyString="")
	ThermUnit (const std::string &scaleAbbreviation, const ThermExpnt &exponents=ThermExpnt(), const std::string &prettyString="")
virtual	~ThermUnit ()

Related Functions
typedef boost::optional < ThermUnit >	OptionalThermUnit
typedef std::vector< ThermUnit >	ThermUnitVector
ThermUnit	createThermEnergy ()
ThermUnit	createThermLength ()
ThermUnit	createThermTime ()
ThermUnit	createThermTemperature ()
ThermUnit	createThermElectricCurrent ()
ThermUnit	createThermLuminousIntensity ()
ThermUnit	createThermAmountOfSubstance ()
ThermUnit	createThermAngle ()
ThermUnit	createThermSolidAngle ()
ThermUnit	createThermPeople ()
ThermUnit	createThermCycle ()
ThermUnit	createThermCurrency ()
ThermUnit	createThermLuminousFlux ()

Detailed Description

ThermUnit is a Unit with baseUnits Btu, ft, h, R, and people.

setBaseUnitExponent throws and exception if any other string is passed in as a baseUnit. ThermUnit.hpp declares related operators and UnitFactory callback functions.

Constructor & Destructor Documentation

openstudio::ThermUnit::ThermUnit	(	const ThermExpnt &	exponents = `ThermExpnt()`,
		int	scaleExponent = `0`,
		const std::string &	prettyString = `""`
	)

Default constructor.

Example:

ThermUnit myEnergy(ThermExpnt(1));
std::cout << myEnergy; // produces "therm"

Parameters

[in]	exponents	holds the exponents for each base unit.
[in]	scaleExponent	exponent for scale. For instance 3 for kilo.
[in]	prettyString	optional string to use in place of standardString.

openstudio::ThermUnit::ThermUnit	(	const std::string &	scaleAbbreviation,
		const ThermExpnt &	exponents = `ThermExpnt()`,
		const std::string &	prettyString = `""`
	)

Alternate constructor.

Specify the abbreviation of the scale, rather than its exponent.

Parameters

[in]	scaleAbbreviation	is string equal to a scale abbreviation. For instance "k" for kilo.
[in]	exponents	holds the exponents for each base unit.
[in]	prettyString	optional string to use in place of standardString.

virtual openstudio::ThermUnit::~ThermUnit ( )

inlinevirtual

Friends And Related Function Documentation

ThermUnit createThermAmountOfSubstance ( )

ThermUnit createThermLuminousIntensity ( )

Public Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

Friends And Related Function Documentation