OpenStudio:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Related Functions | List of all members
openstudio::WhUnit Class Reference

#include <WhUnit.hpp>

+ Inheritance diagram for openstudio::WhUnit:

Public Member Functions

Constructors and Destructors
 WhUnit (const WhExpnt &exponents=WhExpnt(), int scaleExponent=0, const std::string &prettyString="")
 Default constructor. More...
 
 WhUnit (const std::string &scaleAbbreviation, const WhExpnt &exponents=WhExpnt(), const std::string &prettyString="")
 Alternate constructor. More...
 
virtual ~WhUnit ()=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...
 
Unitoperator*= (const Unit &rUnit)
 Multiply-assign operator. More...
 
Unitoperator/= (const Unit &rUnit)
 Divide-assign operator. More...
 
Unitpow (int expNum, int expDenom=1, bool okToCallFactory=true)
 Raise Unit to a rational power. More...
 
template<typename 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 OptionalWhUnit = boost::optional< WhUnit >
 
using WhUnitVector = std::vector< WhUnit >
 
Create Functions Used by UnitFactory
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 ()
 Volt (V) = W/A. More...
 
WhUnit createWhElectricResistance ()
 Ohm (ohm) = V/A = W/A^2. More...
 
WhUnit createWhLuminousFlux ()
 Lumen (lm) = cd*sr. More...
 
WhUnit createWhIlluminance ()
 Lux (lux or lx) = lm/m^2 = cd*sr/m^2. More...
 

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