|
|
| SIUnit (const SIExpnt &exponents=SIExpnt(), int scaleExponent=0, const std::string &prettyString="") |
| Default constructor. More...
|
|
| SIUnit (const std::string &scaleAbbreviation, const SIExpnt &exponents=SIExpnt(), const std::string &prettyString="") |
| Alternate constructor. More...
|
|
virtual | ~SIUnit () |
|
| 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 () |
|
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...
|
|
SIUnit is a Unit with baseUnits are fixed by its constructors, see SIExpnt.
setBaseUnitExponent throws an exception if any other string is passed in as a baseUnit. SIUnit.hpp declares related operators and UnitFactory callback functions.
openstudio::SIUnit::SIUnit |
( |
const std::string & |
scaleAbbreviation, |
|
|
const SIExpnt & |
exponents = SIExpnt() , |
|
|
const std::string & |
prettyString = "" |
|
) |
| |
Alternate constructor.
Specify the abbreviation of the scale, rather than its exponent. Example:
SIUnit myEnergy("k",SIExpnt(1,2,-2),"J");
std::cout << myEnergy; // produces "kJ
- 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. |