OpenStudio:utilities
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "WhUnit.hpp"

Inheritance diagram for openstudio::WhUnit:

Public Member Functions

 WhUnit (const WhExpnt &exponents=WhExpnt(), int scaleExponent=0, const std::string &prettyString="")
 WhUnit (const std::string &scaleAbbreviation, const WhExpnt &exponents=WhExpnt(), const std::string &prettyString="")
virtual ~WhUnit ()=default

Related Functions

using OptionalWhUnit = boost::optional< WhUnit >
using WhUnitVector = std::vector< WhUnit >
WhUnit createWhPower ()
WhUnit createWhTime ()
WhUnit createWhLength ()
WhUnit createWhTemperature ()
WhUnit createWhElectricCurrent ()
WhUnit createWhLuminousIntensity ()
WhUnit createWhAmountOfSubstance ()
WhUnit createWhAngle ()
WhUnit createWhSolidAngle ()
WhUnit createWhPeople ()
WhUnit createWhCycle ()
WhUnit createWhCurrency ()
WhUnit createWhEnergy ()
WhUnit createWhElectricalPotential ()
WhUnit createWhElectricResistance ()
WhUnit createWhLuminousFlux ()
WhUnit createWhIlluminance ()

Detailed Description

WhUnit is a Unit with baseUnits W, h, m, K, and people.

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

Constructor & Destructor Documentation

openstudio::WhUnit::WhUnit ( const WhExpnt exponents = WhExpnt(),
int  scaleExponent = 0,
const std::string &  prettyString = "" 
)

Default constructor.

Example:

WhUnit myEnergy(WhExpnt(1,1),3,"Wh");
std::cout << myEnergy; // produces "kWh" 
Parameters
[in]exponentsholds the exponents for each base unit.
[in]scaleExponentexponent for scale. For instance 3 for kilo.
[in]prettyStringoptional string to use in place of standardString.
openstudio::WhUnit::WhUnit ( const std::string &  scaleAbbreviation,
const WhExpnt exponents = WhExpnt(),
const std::string &  prettyString = "" 
)

Alternate constructor.

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

WhUnit myEnergy("k",WhExpnt(1,1),"Wh");
std::cout << myEnergy; // produces "kWh" 
Parameters
[in]scaleAbbreviationis string equal to a scale abbreviation. For instance "k" for kilo.
[in]exponentsholds the exponents for each base unit.
[in]prettyStringoptional string to use in place of standardString.
virtual openstudio::WhUnit::~WhUnit ( )
virtualdefault

Friends And Related Function Documentation

WhUnit createWhAmountOfSubstance ( )
related
WhUnit createWhAngle ( )
related
WhUnit createWhCurrency ( )
related
WhUnit createWhCycle ( )
related
WhUnit createWhElectricalPotential ( )
related

Volt (V) = W/A.

WhUnit createWhElectricCurrent ( )
related
WhUnit createWhElectricResistance ( )
related

Ohm (ohm) = V/A = W/A^2.

WhUnit createWhEnergy ( )
related
WhUnit createWhIlluminance ( )
related

Lux (lux or lx) = lm/m^2 = cd*sr/m^2.

WhUnit createWhLength ( )
related
WhUnit createWhLuminousFlux ( )
related

Lumen (lm) = cd*sr.

WhUnit createWhLuminousIntensity ( )
related
WhUnit createWhPeople ( )
related
WhUnit createWhPower ( )
related
WhUnit createWhSolidAngle ( )
related
WhUnit createWhTemperature ( )
related
WhUnit createWhTime ( )
related
using OptionalWhUnit = boost::optional<WhUnit>
related
using WhUnitVector = std::vector<WhUnit>
related