#include "BTUUnit.hpp"

Inheritance diagram for openstudio::BTUUnit:

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

Related Functions
typedef std::vector< BTUUnit >	BTUUnitVector
typedef boost::optional< BTUUnit >	OptionalBTUUnit
BTUUnit	createBTUEnergy ()
BTUUnit	createBTULength ()
BTUUnit	createBTUTime ()
BTUUnit	createBTUTemperature ()
BTUUnit	createBTUElectricCurrent ()
BTUUnit	createBTULuminousIntensity ()
BTUUnit	createBTUAmountOfSubstance ()
BTUUnit	createBTUAngle ()
BTUUnit	createBTUSolidAngle ()
BTUUnit	createBTUPeople ()
BTUUnit	createBTUCycle ()
BTUUnit	createBTUCurrency ()
BTUUnit	createBTUPower ()
BTUUnit	createBTULuminousFlux ()
BTUUnit	createBTUIlluminance ()

Detailed Description

BTUUnit is a Unit with baseUnits fixed by its constructors, see BTUExpnt.

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

Constructor & Destructor Documentation

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

Default constructor.

Example:

BTUUnit myEnergy(BtuExpnt(1),3);
std::cout << myEnergy; // produces "kBtu"

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::BTUUnit::BTUUnit	(	const std::string &	scaleAbbreviation,
		const BTUExpnt &	exponents = `BTUExpnt()`,
		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::BTUUnit::~BTUUnit ( )

inlinevirtual

Friends And Related Function Documentation

typedef std::vector<BTUUnit> BTUUnitVector

BTUUnit createBTULength ( )

BTUUnit createBTULuminousIntensity ( )

BTUUnit createBTUSolidAngle ( )

Public Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

Friends And Related Function Documentation