#include <BTUUnit.hpp>

Inheritance diagram for openstudio::BTUUnit:

Public Member Functions
Constructors and Destructors
	BTUUnit (const BTUExpnt &exponents=BTUExpnt(), int scaleExponent=0, const std::string &prettyString="")
	Default constructor. More...

	BTUUnit (const std::string &scaleAbbreviation, const BTUExpnt &exponents=BTUExpnt(), const std::string &prettyString="")
	Alternate constructor. More...

virtual	~BTUUnit () override=default

Public Member Functions inherited from openstudio::Unit
	Unit (int scaleExponent=0, const std::string &prettyString="")
	Default constructor. More...

	Unit (const std::string &scaleAbbreviation, const std::string &prettyString="")
	Constructor using scale abbreviations registered in ScaleFactory. More...

virtual	~Unit ()=default

Unit	clone () const
	Deep copy constructor. More...

Unit	cloneToMixed () const
	Deep copy constructor that discards system designation. More...

std::vector< std::string >	baseUnits () const
	Returns base units already available in Unit. More...

bool	isBaseUnit (const std::string &baseUnit) const
	Returns true if baseUnit is available in Unit. More...

int	baseUnitExponent (const std::string &baseUnit) const
	Base unit exponent getter. Returns 0 if baseUnit not present. */. More...

void	setBaseUnitExponent (const std::string &baseUnit, int exponent)
	Sets baseUnit^exponent. If baseUnit not yet present, is added and return value is true. More...

Scale	scale () const
	Scale getter. More...

bool	setScale (int scaleExponent)
	Sets the scale to the one registered in ScaleFactory for 10^scaleExponent. More...

bool	setScale (const std::string &scaleAbbreviation)
	Sets the scale to the one registered in ScaleFactory under scaleAbbreviation. More...

std::string	standardString (bool withScale=true) const
	Returns the standard output string for this unit. More...

std::string	prettyString (bool withScale=true) const
	Returns the preferred output string for this unit. More...

void	setPrettyString (const std::string &str)
	Setter for prettyString (do not include scale abbreviation). More...

std::string	print (bool withScale=true) const
	Returns prettyString(withScale) if it exists; otherwise returns standardString(withScale). More...

UnitSystem	system () const
	Getter for this Unit's system. More...

bool	operator== (const Unit &rUnit) const
	Equality for units. More...

Unit &	operator*= (const Unit &rUnit)
	Multiply-assign operator. More...

Unit &	operator/= (const Unit &rUnit)
	Divide-assign operator. More...

Unit &	pow (int expNum, int expDenom=1, bool okToCallFactory=true)
	Raise Unit to a rational power. More...

template<typename T >
T	cast () const
	Cast to type T. More...

template<typename T >
boost::optional< T >	optionalCast () const
	Cast to boost::optional<T>. More...

Related Functions
(Note that these are not member functions.)
using	BTUUnitVector = std::vector< BTUUnit >

using	OptionalBTUUnit = boost::optional< BTUUnit >

Create Functions Used by UnitFactory
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 ()
	Btu/h. More...

BTUUnit	createBTULuminousFlux ()
	Lumen (lm) = cd*sr. More...

BTUUnit	createBTUIlluminance ()
	Foot-candles (fc) = lm/ft^2 = cd*sr/ft^2. More...

Related Functions inherited from openstudio::Unit
using	OptionalUnit = boost::optional< Unit >

using	UnitVector = std::vector< Unit >

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 ( )

overridevirtualdefault

Friends And Related Function Documentation

using BTUUnitVector = std::vector<BTUUnit>

BTUUnit createBTULength ( )

BTUUnit createBTULuminousIntensity ( )

BTUUnit createBTUSolidAngle ( )

Public Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

Friends And Related Function Documentation