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

#include "FahrenheitUnit.hpp"

Inheritance diagram for openstudio::FahrenheitUnit:

Public Member Functions

 FahrenheitUnit (int FExp=0, int scaleExponent=0, const std::string &prettyString="")
 FahrenheitUnit (const std::string &scaleAbbreviation, int FExp=0, const std::string &prettyString="")
virtual ~FahrenheitUnit ()
FahrenheitUnitoperator/= (const FahrenheitUnit &rUnit)

Related Functions

typedef std::vector
< FahrenheitUnit
FahrenheitUnitVector
typedef boost::optional
< FahrenheitUnit
OptionalFahrenheitUnit
FahrenheitUnit createFahrenheitTemperature ()

Detailed Description

FahrenheitUnit is a TemperatureUnit that supports absolute temperatures in degrees Fahrenheit.

Rankine and Fahrenheit 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 Fahrenheit. Printing out R's as F's in the former situation is a feature that may be added to this library at a later date.

Constructor & Destructor Documentation

openstudio::FahrenheitUnit::FahrenheitUnit ( int  FExp = 0,
int  scaleExponent = 0,
const std::string &  prettyString = "" 
)

Default constructor creates an absolute temperature.

Parameters
[in]FExpexponent on baseUnit F.
[in]scaleExponentexponent for scale. For instance 3 for kilo.
[in]prettyStringoptional string to use in place of standardString.
openstudio::FahrenheitUnit::FahrenheitUnit ( const std::string &  scaleAbbreviation,
int  FExp = 0,
const std::string &  prettyString = "" 
)

Alternate constructor creates an absolute temperature.

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]FExpexponent on baseUnit F.
[in]prettyStringoptional string to use in place of standardString.
virtual openstudio::FahrenheitUnit::~FahrenheitUnit ( )
inlinevirtual

Member Function Documentation

FahrenheitUnit& openstudio::FahrenheitUnit::operator/= ( const FahrenheitUnit rUnit)

Friends And Related Function Documentation

FahrenheitUnit createFahrenheitTemperature ( )
related
typedef std::vector<FahrenheitUnit> FahrenheitUnitVector
related
typedef boost::optional<FahrenheitUnit> OptionalFahrenheitUnit
related