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

#include "MPHUnit.hpp"

Inheritance diagram for openstudio::MPHUnit:

Public Member Functions

 MPHUnit (const MPHExpnt &exponents=MPHExpnt(), int scaleExponent=0, const std::string &prettyString="")
 MPHUnit (const std::string &scaleAbbreviation, const MPHExpnt &exponents=MPHExpnt(), const std::string &prettyString="")
virtual ~MPHUnit ()

Related Functions

typedef std::vector< MPHUnitMPHUnitVector
typedef boost::optional< MPHUnitOptionalMPHUnit
MPHUnit createMPHPressure ()
MPHUnit createMPHLength ()
MPHUnit createMPHTime ()
MPHUnit createMPHTemperature ()
MPHUnit createMPHElectricCurrent ()
MPHUnit createMPHLuminousIntensity ()
MPHUnit createMPHAmountOfSubstance ()
MPHUnit createMPHAngle ()
MPHUnit createMPHSolidAngle ()
MPHUnit createMPHPeople ()
MPHUnit createMPHCycle ()
MPHUnit createMPHCurrency ()
MPHUnit createMPHVelocity ()
MPHUnit createMPHLuminousFlux ()

Detailed Description

MPHUnit is a Unit with baseUnits fixed by its constructors, see MPHExpnt.

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

Constructor & Destructor Documentation

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

Default constructor.

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::MPHUnit::MPHUnit ( const std::string &  scaleAbbreviation,
const MPHExpnt exponents = MPHExpnt(),
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::MPHUnit::~MPHUnit ( )
inlinevirtual

Friends And Related Function Documentation

MPHUnit createMPHAmountOfSubstance ( )
related
MPHUnit createMPHAngle ( )
related
MPHUnit createMPHCurrency ( )
related
MPHUnit createMPHCycle ( )
related
MPHUnit createMPHElectricCurrent ( )
related
MPHUnit createMPHLength ( )
related
MPHUnit createMPHLuminousFlux ( )
related

Lumen (lm) = cd*sr.

MPHUnit createMPHLuminousIntensity ( )
related
MPHUnit createMPHPeople ( )
related
MPHUnit createMPHPressure ( )
related
MPHUnit createMPHSolidAngle ( )
related
MPHUnit createMPHTemperature ( )
related
MPHUnit createMPHTime ( )
related
MPHUnit createMPHVelocity ( )
related

Miles per hour (mph) = mi/h.

typedef std::vector<MPHUnit> MPHUnitVector
related
typedef boost::optional<MPHUnit> OptionalMPHUnit
related