openstudio::Misc1Unit Class Reference

#include <Misc1Unit.hpp>

Inheritance diagram for openstudio::Misc1Unit:

Related Symbols
(Note that these are not member symbols.)
using	Misc1UnitVector = std::vector<Misc1Unit>
using	OptionalMisc1Unit = boost::optional<Misc1Unit>
Create Functions Used by UnitFactory
Misc1Unit	createMisc1Pressure ()
Misc1Unit	createMisc1Length ()
Misc1Unit	createMisc1Time ()
Misc1Unit	createMisc1Temperature ()
Misc1Unit	createMisc1ElectricCurrent ()
Misc1Unit	createMisc1LuminousIntensity ()
Misc1Unit	createMisc1AmountOfSubstance ()
Misc1Unit	createMisc1Angle ()
Misc1Unit	createMisc1SolidAngle ()
Misc1Unit	createMisc1People ()
Misc1Unit	createMisc1Volume ()
	Liters (L).
Misc1Unit	createMisc1LuminousFlux ()
	Lumen (lm) = cd*sr.
Related Symbols inherited from openstudio::Unit
using	OptionalUnit = boost::optional<Unit>
using	UnitVector = std::vector<Unit>

Constructors and Destructors
	Misc1Unit (const Misc1Expnt &exponents=Misc1Expnt(), int scaleExponent=0, const std::string &prettyString="")
	Default constructor.
	Misc1Unit (const std::string &scaleAbbreviation, const Misc1Expnt &exponents=Misc1Expnt(), const std::string &prettyString="")
	Alternate constructor.
virtual	~Misc1Unit () override=default

Additional Inherited Members
Public Member Functions inherited from openstudio::Unit
	Unit (int scaleExponent=0, const std::string &prettyString="")
	Default constructor.
	Unit (const std::string &scaleAbbreviation, const std::string &prettyString="")
	Constructor using scale abbreviations registered in ScaleFactory.
virtual	~Unit ()=default
Unit	clone () const
	Deep copy constructor.
Unit	cloneToMixed () const
	Deep copy constructor that discards system designation.
std::vector< std::string >	baseUnits () const
	Returns base units already available in Unit.
bool	isBaseUnit (const std::string &baseUnit) const
	Returns true if baseUnit is available in Unit.
int	baseUnitExponent (const std::string &baseUnit) const
	Base unit exponent getter. Returns 0 if baseUnit not present. *‍/.
void	setBaseUnitExponent (const std::string &baseUnit, int exponent)
	Sets baseUnit^exponent. If baseUnit not yet present, is added and return value is true.
Scale	scale () const
	Scale getter.
bool	setScale (int scaleExponent)
	Sets the scale to the one registered in ScaleFactory for 10^scaleExponent.
bool	setScale (const std::string &scaleAbbreviation)
	Sets the scale to the one registered in ScaleFactory under scaleAbbreviation.
std::string	standardString (bool withScale=true) const
	Returns the standard output string for this unit.
std::string	prettyString (bool withScale=true) const
	Returns the preferred output string for this unit.
void	setPrettyString (const std::string &str)
	Setter for prettyString (do not include scale abbreviation).
std::string	print (bool withScale=true) const
	Returns prettyString(withScale) if it exists; otherwise returns standardString(withScale).
UnitSystem	system () const
	Getter for this Unit's system.
bool	operator== (const Unit &rUnit) const
	Equality for units.
Unit &	operator*= (const Unit &rUnit)
	Multiply-assign operator.
Unit &	operator/= (const Unit &rUnit)
	Divide-assign operator.
Unit &	pow (int expNum, int expDenom=1, bool okToCallFactory=true)
	Raise Unit to a rational power.
template<typename T >
T	cast () const
	Cast to type T.
template<typename T >
boost::optional< T >	optionalCast () const
	Cast to boost::optional<T>.

Detailed Description

Misc1Unit is a Unit with baseUnits fixed by its constructors, see Misc1Expnt.

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

Constructor & Destructor Documentation

Misc1Unit() [1/2]

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

Default constructor.

Parameters

[in]	exponents	holds the exponents for each base unit.
[in]	scaleExponent	exponent for scale. For instance 3 for kilo.
[in]	prettyString	optional string to use in place of standardString.

Misc1Unit() [2/2]

openstudio::Misc1Unit::Misc1Unit	(	const std::string &	scaleAbbreviation,
		const Misc1Expnt &	exponents = Misc1Expnt(),
		const std::string &	prettyString = "" )

Alternate constructor.

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

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.

~Misc1Unit()

virtual openstudio::Misc1Unit::~Misc1Unit ( )

overridevirtualdefault

Friends And Related Symbol Documentation

createMisc1AmountOfSubstance()

Misc1Unit createMisc1AmountOfSubstance ( )

related

createMisc1Angle()

Misc1Unit createMisc1Angle ( )

related

createMisc1ElectricCurrent()

Misc1Unit createMisc1ElectricCurrent ( )

related

createMisc1Length()

Misc1Unit createMisc1Length ( )

related

createMisc1LuminousFlux()

Misc1Unit createMisc1LuminousFlux ( )

related

Lumen (lm) = cd*sr.

createMisc1LuminousIntensity()

Misc1Unit createMisc1LuminousIntensity ( )

related

createMisc1People()

Misc1Unit createMisc1People ( )

related

createMisc1Pressure()

Misc1Unit createMisc1Pressure ( )

related

createMisc1SolidAngle()

Misc1Unit createMisc1SolidAngle ( )

related

createMisc1Temperature()

Misc1Unit createMisc1Temperature ( )

related

createMisc1Time()

Misc1Unit createMisc1Time ( )

related

createMisc1Volume()

Misc1Unit createMisc1Volume ( )

related

Liters (L).

Misc1UnitVector

using Misc1UnitVector = std::vector<Misc1Unit>

related

OptionalMisc1Unit

using OptionalMisc1Unit = boost::optional<Misc1Unit>

related