roo_quantity
API Documentation for roo_quantity
Loading...
Searching...
No Matches
Public Member Functions | Friends
roo_quantity::TemperatureDelta Class Reference

#include <temperature.h>

Public Member Functions

 TemperatureDelta ()
 Creates a temperature delta object representing an 'unknown' temperature delta.
 
float degCelcius () const
 Returns the temperature delta in degrees Celcius.
 
float degKelvin () const
 Returns the temperature delta in degrees Kelvin.
 
float degFahrenheit () const
 Returns the temperature delta in degrees Fahrenheit.
 
bool isUnknown () const
 Returns whether the object represents an unknown temperature delta.
 
bool operator< (const TemperatureDelta &other) const
 
bool operator== (const TemperatureDelta &other) const
 
bool operator> (const TemperatureDelta &other) const
 
bool operator<= (const TemperatureDelta &other) const
 
bool operator>= (const TemperatureDelta &other) const
 
bool operator!= (const TemperatureDelta &other) const
 
TemperatureDelta & operator+= (const TemperatureDelta &other)
 
TemperatureDelta & operator-= (const TemperatureDelta &other)
 
TemperatureDelta & operator*= (float multi)
 
TemperatureDelta & operator/= (float div)
 

Friends

TemperatureDelta UnknownTemperatureDelta ()
 Returns a temperature object representing an unknown temperature delta.
 
TemperatureDelta TemperatureDeltaDegCelcius (float)
 Returns a temperature delta object equivalent to the specified temperature expressed in Celcius degrees.
 
TemperatureDelta TemperatureDeltaDegKelvin (float)
 Returns a temperature delta object equivalent to the specified temperature delta expressed in Kelvin degrees. It is in fact equivalent to TemperatureDeltaDegCelcius.
 
TemperatureDelta TemperatureDeltaDegFahrenheit (float)
 Returns a temperature delta object approximately equal to the specified temperature delta expressed in Fahrenheit degrees.
 

Detailed Description

Definition at line 94 of file temperature.h.

Constructor & Destructor Documentation

◆ TemperatureDelta()

roo_quantity::TemperatureDelta::TemperatureDelta ( )
inline

Creates a temperature delta object representing an 'unknown' temperature delta.

Definition at line 98 of file temperature.h.

Member Function Documentation

◆ degCelcius()

float roo_quantity::TemperatureDelta::degCelcius ( ) const
inline

Returns the temperature delta in degrees Celcius.

Definition at line 101 of file temperature.h.

Referenced by roo_quantity::operator*(), roo_quantity::operator*(), roo_quantity::operator+(), roo_quantity::operator+(), roo_quantity::operator+(), roo_quantity::Temperature::operator+=(), operator+=(), roo_quantity::operator-(), roo_quantity::operator-(), roo_quantity::operator-(), roo_quantity::Temperature::operator-=(), operator-=(), and roo_quantity::operator/().

◆ degFahrenheit()

float roo_quantity::TemperatureDelta::degFahrenheit ( ) const
inline

Returns the temperature delta in degrees Fahrenheit.

Definition at line 107 of file temperature.h.

◆ degKelvin()

float roo_quantity::TemperatureDelta::degKelvin ( ) const
inline

Returns the temperature delta in degrees Kelvin.

Definition at line 104 of file temperature.h.

◆ isUnknown()

bool roo_quantity::TemperatureDelta::isUnknown ( ) const
inline

Returns whether the object represents an unknown temperature delta.

Definition at line 110 of file temperature.h.

◆ operator!=()

bool roo_quantity::TemperatureDelta::operator!= ( const TemperatureDelta &  other) const
inline

Definition at line 132 of file temperature.h.

◆ operator*=()

TemperatureDelta & roo_quantity::TemperatureDelta::operator*= ( float  multi)
inline

Definition at line 146 of file temperature.h.

◆ operator+=()

TemperatureDelta & roo_quantity::TemperatureDelta::operator+= ( const TemperatureDelta &  other)
inline

Definition at line 136 of file temperature.h.

References degCelcius().

◆ operator-=()

TemperatureDelta & roo_quantity::TemperatureDelta::operator-= ( const TemperatureDelta &  other)
inline

Definition at line 141 of file temperature.h.

References degCelcius().

◆ operator/=()

TemperatureDelta & roo_quantity::TemperatureDelta::operator/= ( float  div)
inline

Definition at line 151 of file temperature.h.

◆ operator<()

bool roo_quantity::TemperatureDelta::operator< ( const TemperatureDelta &  other) const
inline

Definition at line 112 of file temperature.h.

◆ operator<=()

bool roo_quantity::TemperatureDelta::operator<= ( const TemperatureDelta &  other) const
inline

Definition at line 124 of file temperature.h.

◆ operator==()

bool roo_quantity::TemperatureDelta::operator== ( const TemperatureDelta &  other) const
inline

Definition at line 116 of file temperature.h.

◆ operator>()

bool roo_quantity::TemperatureDelta::operator> ( const TemperatureDelta &  other) const
inline

Definition at line 120 of file temperature.h.

◆ operator>=()

bool roo_quantity::TemperatureDelta::operator>= ( const TemperatureDelta &  other) const
inline

Definition at line 128 of file temperature.h.

Friends And Related Symbol Documentation

◆ TemperatureDeltaDegCelcius

TemperatureDelta TemperatureDeltaDegCelcius ( float  tempC)
friend

Returns a temperature delta object equivalent to the specified temperature expressed in Celcius degrees.

Definition at line 218 of file temperature.h.

◆ TemperatureDeltaDegFahrenheit

TemperatureDelta TemperatureDeltaDegFahrenheit ( float  tempF)
friend

Returns a temperature delta object approximately equal to the specified temperature delta expressed in Fahrenheit degrees.

Due to floating-point rounding errors, and since the temperature is internally stored in Celcius degrees, generally, DegFahrenheit(x).degFahrenheit() != x.

Definition at line 235 of file temperature.h.

◆ TemperatureDeltaDegKelvin

TemperatureDelta TemperatureDeltaDegKelvin ( float  tempK)
friend

Returns a temperature delta object equivalent to the specified temperature delta expressed in Kelvin degrees. It is in fact equivalent to TemperatureDeltaDegCelcius.

Definition at line 225 of file temperature.h.

◆ UnknownTemperatureDelta

TemperatureDelta UnknownTemperatureDelta ( )
friend

Returns a temperature object representing an unknown temperature delta.

Definition at line 214 of file temperature.h.

The documentation for this class was generated from the following file: