#include <CelsiusUnit.hpp>

Inheritance diagram for openstudio::CelsiusUnit:

Related Symbols
(Note that these are not member symbols.)
using	CelsiusUnitVector = std::vector<CelsiusUnit>

using	OptionalCelsiusUnit = boost::optional<CelsiusUnit>

Create Functions Used by UnitFactory
CelsiusUnit	createCelsiusTemperature ()

Related Symbols inherited from openstudio::TemperatureUnit
using	OptionalTemperatureUnit = boost::optional<TemperatureUnit>

using	TemperatureUnitVector = std::vector<TemperatureUnit>

Related Symbols inherited from openstudio::Unit
using	OptionalUnit = boost::optional<Unit>

using	UnitVector = std::vector<Unit>

Constructors and Destructors
	CelsiusUnit (int CExp=0, int scaleExponent=0, const std::string &prettyString="")
	Default constructor creates an absolute temperature.

	CelsiusUnit (const std::string &scaleAbbreviation, int CExp=0, const std::string &prettyString="")
	Alternate constructor creates an absolute temperature.

virtual	~CelsiusUnit () override=default

Additional Inherited Members
Public Member Functions inherited from openstudio::TemperatureUnit
virtual	~TemperatureUnit () override=default

bool	isAbsolute () const

void	setAsAbsolute ()

void	setAsRelative ()

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

CelsiusUnit is a TemperatureUnit that supports absolute temperatures in degrees Celsius.

Kelvin and Celsius are the same in situations of relative temperature, that is, when it is the difference in temperatures that matter, rather than the absolute value. This is normally the case when the temperature base unit shows up in combination with other units, and that is not the situation being addressed here. This class is for reporting actual temperatures in degrees Celsius. Printing out K's as C's in the former situation is a feature that may be added to this library at a later date.

Constructor & Destructor Documentation

◆ CelsiusUnit() [1/2]

openstudio::CelsiusUnit::CelsiusUnit	(	int	CExp = 0,
		int	scaleExponent = 0,
		const std::string &	prettyString = "" )

Default constructor creates an absolute temperature.

Parameters

[in]	CExp	exponent on baseUnit C.
[in]	scaleExponent	exponent for scale. For instance 3 for kilo.
[in]	prettyString	optional string to use in place of standardString.

◆ CelsiusUnit() [2/2]

openstudio::CelsiusUnit::CelsiusUnit	(	const std::string &	scaleAbbreviation,
		int	CExp = 0,
		const std::string &	prettyString = "" )

Alternate constructor creates an absolute temperature.

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]	CExp	exponent on baseUnit C.
[in]	prettyString	optional string to use in place of standardString.

◆ ~CelsiusUnit()

virtual openstudio::CelsiusUnit::~CelsiusUnit ( )

overridevirtualdefault

Friends And Related Symbol Documentation

◆ CelsiusUnitVector

using CelsiusUnitVector = std::vector<CelsiusUnit>

CelsiusUnit createCelsiusTemperature ( )

using OptionalCelsiusUnit = boost::optional<CelsiusUnit>

Related Symbols

Constructors and Destructors

Additional Inherited Members