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

#include <CFMUnit.hpp>

+ Inheritance diagram for openstudio::CFMUnit:

Public Member Functions

Constructors and Destructors
 CFMUnit (const CFMExpnt &exponents=CFMExpnt(), int scaleExponent=0, const std::string &prettyString="")
 Default constructor. More...
 
 CFMUnit (const std::string &scaleAbbreviation, const CFMExpnt &exponents=CFMExpnt(), const std::string &prettyString="")
 Alternate constructor. More...
 
virtual ~CFMUnit ()=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 CFMUnitVector = std::vector< CFMUnit >
 
using OptionalCFMUnit = boost::optional< CFMUnit >
 
Create Functions Used by UnitFactory
CFMUnit createCFMLength ()
 
CFMUnit createCFMTime ()
 
CFMUnit createCFMPower ()
 
CFMUnit createCFMTemperature ()
 
CFMUnit createCFMElectricCurrent ()
 
CFMUnit createCFMLuminousIntensity ()
 
CFMUnit createCFMAmountOfSubstance ()
 
CFMUnit createCFMAngle ()
 
CFMUnit createCFMSolidAngle ()
 
CFMUnit createCFMPeople ()
 
CFMUnit createCFMCycle ()
 
CFMUnit createCFMCurrency ()
 
CFMUnit createCFMVolumetricFlowrate ()
 Cubic feet per minute (cfm) = ft^3/min. More...
 
CFMUnit createCFMLuminousFlux ()
 Lumen (lm) = cd*sr. More...
 
CFMUnit createCFMIlluminance ()
 Foot-candles (fc) = lm/ft^2 = cd*sr/ft^2. More...
 
CFMUnit createCFMFrequency ()
 Rotations per minute (rpm) = cycles/min. More...
 

Detailed Description

CFMUnit is a Unit with baseUnits fixed by its constructors, see CFMExpnt.

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

Constructor & Destructor Documentation

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

Default constructor.

Example:

CFMUnit myPower(CFMExpnt(0,0,1));
std::cout << myPower; // produces "ton" 
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::CFMUnit::CFMUnit ( const std::string &  scaleAbbreviation,
const CFMExpnt exponents = CFMExpnt(),
const std::string &  prettyString = "" 
)

Alternate constructor.

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

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::CFMUnit::~CFMUnit ( )
virtualdefault

Friends And Related Function Documentation

using CFMUnitVector = std::vector<CFMUnit>
related
CFMUnit createCFMAmountOfSubstance ( )
related
CFMUnit createCFMAngle ( )
related
CFMUnit createCFMCurrency ( )
related
CFMUnit createCFMCycle ( )
related
CFMUnit createCFMElectricCurrent ( )
related
CFMUnit createCFMFrequency ( )
related

Rotations per minute (rpm) = cycles/min.

CFMUnit createCFMIlluminance ( )
related

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

CFMUnit createCFMLength ( )
related
CFMUnit createCFMLuminousFlux ( )
related

Lumen (lm) = cd*sr.

CFMUnit createCFMLuminousIntensity ( )
related
CFMUnit createCFMPeople ( )
related
CFMUnit createCFMPower ( )
related
CFMUnit createCFMSolidAngle ( )
related
CFMUnit createCFMTemperature ( )
related
CFMUnit createCFMTime ( )
related
CFMUnit createCFMVolumetricFlowrate ( )
related

Cubic feet per minute (cfm) = ft^3/min.

using OptionalCFMUnit = boost::optional<CFMUnit>
related