 |
OpenStudio:utilities |
|
OpenStudio:utilities |
#include "UnitFactory.hpp"
Public Types | |
| typedef boost::function< Unit()> | CreateUnitCallback |
Public Member Functions | |
| boost::optional< Unit > | createUnit (const std::string &unitString, UnitSystem system=UnitSystem::Mixed) const |
| std::string | lookupPrettyString (const std::string &standardString) const |
| bool | registerEquivalentString (const std::string &equivalentString, const std::string &standardString) |
| bool | registerUnit (CreateUnitCallback createFn, UnitSystem system=UnitSystem::Mixed) |
Related Functions | |
| bool | containsRegisteredBaseUnit (const std::string &unitString) |
| std::string | convertToStandardForm (const std::string &unitString) |
| Unit | createDimensionlessUnit (UnitSystem system) |
| Unit | createGPMVolumetricFlowrate () |
| Unit | createIPPowerDensity () |
| Unit | createIPPressure () |
| boost::optional< Unit > | createUnit (const std::string &unitString, UnitSystem system) |
| boost::optional< Unit > | createUnit (const std::string &unitString) |
| std::string | extractUnitString (const std::string &text) |
| UnitSystem | getSystem (const std::string &unitString) |
| bool | isInSystem (const std::string &unitString, UnitSystem system) |
| bool | isUnitString (const std::string &unitString) |
| std::string | replaceUnitString (const std::string &text, const std::string &newUnitString) |
| typedef openstudio::Singleton < UnitFactorySingleton > | UnitFactory |
| bool | unitStringsEqual (const std::string &uStr1, const std::string &uStr2) |
Singleton that creates units based on std::string representation.
Access using UnitFactory::instance(). The class keeps up with standard unit strings, pseudonyms for those strings, and pretty strings.
Standard unit strings use base units like kg, m, s, ft, etc. and follow LaTeX formatting. For example, the standard unit std::string for SI energy is
kg*m^2/s^2
.
Also provides a function for looking up pretty units without having to create a unit.
| typedef boost::function<Unit ()> openstudio::UnitFactorySingleton::CreateUnitCallback |
Units are created by functions that accept no arguments and return something that can be converted into a Unit::Ptr.
| boost::optional<Unit> openstudio::UnitFactorySingleton::createUnit | ( | const std::string & | unitString, |
| UnitSystem | system = UnitSystem::Mixed |
||
| ) | const |
Parses unitStr to create a unit based on the internal factory maps.
The maps are populated using the functions registerUnit and registerEquivalentString. Specify system to alert the factory of your preferred unit system. The returned pointer is not guaranteed to be from that system, but if there is a conflict, it will be preferred.
| std::string openstudio::UnitFactorySingleton::lookupPrettyString | ( | const std::string & | standardString | ) | const |
Returns the prettyString registered for standardString.
Returns the empty std::string for unregistered standardStrings.
| bool openstudio::UnitFactorySingleton::registerEquivalentString | ( | const std::string & | equivalentString, |
| const std::string & | standardString | ||
| ) |
Register alternative symbols for standardString.
For instance, J is a pseudonym for kg*m^2/s^2. Returns false if equivalentString is already used as a key in the internal map.
| bool openstudio::UnitFactorySingleton::registerUnit | ( | CreateUnitCallback | createFn, |
| UnitSystem | system = UnitSystem::Mixed |
||
| ) |
Associate a unit creation function with a standard string.
Also registers the pretty string if one exists. Returns false if standardString or prettyString is already used as a key in one or more internal maps.
Option to specify a unit system is for conflict resolution. For instance, seconds is a base unit in SI and IP. For efficiency, only specify system if you expect a conflict.
|
related |
Returns true if any of unitString's baseUnits are registered in the factory.
|
related |
Converts unitString to standard form.
Right now, does conversion like people/100 m^2 –> c(people/m^2).
|
related |
Returns a Unit of the type that corresponds to system.
|
related |
Make sure crgal^3/min shows up as gal/min.
|
related |
In IP units, power density is often expressed as W/ft^2, which is actually a mixed unit.
|
related |
In IP units, pressure is often expressed as lb_f/in^2, which is actually a mixed unit.
|
related |
Creates a Unit corresponding to unitString (using UnitFactory).
User may specify preferred UnitSystem, and can cast the result to the appropriate class, as desired.
|
related |
Creates a Unit corresponding to unitString (using UnitFactory).
Attempts to find the best UnitSystem for unitString, in priority order SI, IP, ..., Mixed.
|
related |
Extracts a unitString from text, if possible.
Only returns strings that contain at least one registered base unit.
|
related |
Returns the best match UnitSystem for unitString, in priority order SI, IP, ..., Mixed.
|
related |
Returns true if unitString can be created as a unit in system.
|
related |
Returns true if unitString can be turned into a Unit.
|
related |
Replaces unitString in text, using same finder algorithm as extractUnitString.
|
related |
Typedef for accessing the UnitFactorySingleton as UnitFactory::instance().
|
related |
Returns true if uStr1 and uStr2 evaluate to the same unit.