casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
Temperature Class Reference

Temperature value with units. More...

#include <ATMTemperature.h>

Public Member Functions

 Temperature ()
 Default constructor. More...
 
 Temperature (double temperature)
 A full constructor: Temperature value assumed by default to be in K (International System) More...
 
 Temperature (double temperature, const string &units)
 A full constructor: Temperature value + unit. More...
 
virtual ~Temperature ()
 Destructor. More...
 
Temperatureoperator= (const Temperature &rhs)
 
Temperatureoperator= (double rhs)
 
Temperature operator+ (const Temperature &rhs)
 
Temperature operator- (const Temperature &rhs)
 
Temperature operator* (double scf)
 
Temperature operator* (float scf)
 
Temperature operator* (int scf)
 
Temperature operator* (unsigned int scf)
 
Temperature operator/ (double scf)
 
Temperature operator/ (float scf)
 
Temperature operator/ (int scf)
 
Temperature operator/ (unsigned int scf)
 
bool operator< (const Temperature &rhs) const
 
bool operator> (const Temperature &rhs) const
 
bool operator<= (const Temperature &rhs) const
 
bool operator>= (const Temperature &rhs) const
 
bool operator== (const Temperature &rhs) const
 
bool operator!= (const Temperature &rhs) const
 
double get () const
 Accessor to the temperature value in International System units (K) More...
 
double get (const string &units) const
 Accessor to the temperature value in specified units. More...
 

Private Attributes

double valueIS_
 

Detailed Description

Temperature value with units.

This class defines physical parameters having units of Temperature. For example, the Radiance can be converted into Brightness Temperature. Default is K (International System), also used by the ATM library.

Definition at line 46 of file ATMTemperature.h.

Constructor & Destructor Documentation

Temperature::Temperature ( )

Default constructor.

Referenced by operator*(), operator+(), operator-(), and operator/().

Temperature::Temperature ( double  temperature)

A full constructor: Temperature value assumed by default to be in K (International System)

Temperature::Temperature ( double  temperature,
const string &  units 
)

A full constructor: Temperature value + unit.

Valid units are K [k], mK [mk], and C [c]. If none of these implemented units is given, the SI value will be returned.

virtual Temperature::~Temperature ( )
inlinevirtual

Destructor.

Definition at line 58 of file ATMTemperature.h.

Member Function Documentation

double Temperature::get ( ) const
inline

Accessor to the temperature value in International System units (K)

Definition at line 62 of file ATMTemperature.h.

References valueIS_.

Referenced by operator!=(), operator+(), operator-(), operator<(), operator<=(), operator==(), operator>(), operator>=(), and SkyStatus::setSkyBackgroundTemperature().

double Temperature::get ( const string &  units) const

Accessor to the temperature value in specified units.

Valid units are K [k], mK [mk], and C [c]

bool Temperature::operator!= ( const Temperature rhs) const
inline

Definition at line 84 of file ATMTemperature.h.

References get(), and valueIS_.

Temperature Temperature::operator* ( double  scf)
inline

Definition at line 71 of file ATMTemperature.h.

References Temperature(), and valueIS_.

Temperature Temperature::operator* ( float  scf)
inline

Definition at line 72 of file ATMTemperature.h.

References Temperature(), and valueIS_.

Temperature Temperature::operator* ( int  scf)
inline

Definition at line 73 of file ATMTemperature.h.

References Temperature(), and valueIS_.

Temperature Temperature::operator* ( unsigned int  scf)
inline

Definition at line 74 of file ATMTemperature.h.

References Temperature(), and valueIS_.

Temperature Temperature::operator+ ( const Temperature rhs)
inline

Definition at line 69 of file ATMTemperature.h.

References get(), Temperature(), and valueIS_.

Temperature Temperature::operator- ( const Temperature rhs)
inline

Definition at line 70 of file ATMTemperature.h.

References get(), Temperature(), and valueIS_.

Temperature Temperature::operator/ ( double  scf)
inline

Definition at line 75 of file ATMTemperature.h.

References Temperature(), and valueIS_.

Temperature Temperature::operator/ ( float  scf)
inline

Definition at line 76 of file ATMTemperature.h.

References Temperature(), and valueIS_.

Temperature Temperature::operator/ ( int  scf)
inline

Definition at line 77 of file ATMTemperature.h.

References Temperature(), and valueIS_.

Temperature Temperature::operator/ ( unsigned int  scf)
inline

Definition at line 78 of file ATMTemperature.h.

References Temperature(), and valueIS_.

bool Temperature::operator< ( const Temperature rhs) const
inline

Definition at line 79 of file ATMTemperature.h.

References get(), and valueIS_.

bool Temperature::operator<= ( const Temperature rhs) const
inline

Definition at line 81 of file ATMTemperature.h.

References get(), and valueIS_.

Temperature& Temperature::operator= ( const Temperature rhs)
inline

Definition at line 67 of file ATMTemperature.h.

References valueIS_.

Temperature& Temperature::operator= ( double  rhs)
inline

Definition at line 68 of file ATMTemperature.h.

References valueIS_.

bool Temperature::operator== ( const Temperature rhs) const
inline

Definition at line 83 of file ATMTemperature.h.

References get(), and valueIS_.

bool Temperature::operator> ( const Temperature rhs) const
inline

Definition at line 80 of file ATMTemperature.h.

References get(), and valueIS_.

bool Temperature::operator>= ( const Temperature rhs) const
inline

Definition at line 82 of file ATMTemperature.h.

References get(), and valueIS_.

Member Data Documentation

double Temperature::valueIS_
private

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