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
MassDensity Class Reference

Mass Density value with units. More...

#include <ATMMassDensity.h>

Public Member Functions

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

Private Attributes

double valueIS_
 

Detailed Description

Mass Density value with units.

This class defines physical parameters having units of Mass Density. For example, the profiles of minor gases, such as O3, are in mass density. Default is m**-3 (International System).

Definition at line 44 of file ATMMassDensity.h.

Constructor & Destructor Documentation

MassDensity::MassDensity ( )

Default constructor.

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

MassDensity::MassDensity ( double  massdensity)

A full constructor: Mass Density value assumed by default to be in kgm**-3 (International System)

MassDensity::MassDensity ( double  massdensity,
const string &  units 
)

A full constructor: Mass Density value + unit.

Valid units are kgm**-3 [kg m**-3, KGM**-3, KG M**-3], gcm**-3 [g cm**-3, GCM**-3, G CM**-3]. If none of these implemented units is given, the SI value will be returned.

virtual MassDensity::~MassDensity ( )
virtual

Destructor.

Member Function Documentation

double MassDensity::get ( ) const
inline

Accessor to the massdensity value in International System units (kgm**-3)

Definition at line 60 of file ATMMassDensity.h.

References valueIS_.

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

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

Accessor to the massdensity value in specified units.

Valid units are kgm**-3 [kg m**-3, KGM**-3, KG M**-3], gcm**-3 [g cm**-3, GCM**-3, G CM**-3].

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

Definition at line 82 of file ATMMassDensity.h.

References get(), and valueIS_.

MassDensity MassDensity::operator* ( double  scf)
inline

Definition at line 69 of file ATMMassDensity.h.

References MassDensity(), and valueIS_.

MassDensity MassDensity::operator* ( float  scf)
inline

Definition at line 70 of file ATMMassDensity.h.

References MassDensity(), and valueIS_.

MassDensity MassDensity::operator* ( int  scf)
inline

Definition at line 71 of file ATMMassDensity.h.

References MassDensity(), and valueIS_.

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

Definition at line 72 of file ATMMassDensity.h.

References MassDensity(), and valueIS_.

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

Definition at line 67 of file ATMMassDensity.h.

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

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

Definition at line 68 of file ATMMassDensity.h.

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

MassDensity MassDensity::operator/ ( double  scf)
inline

Definition at line 73 of file ATMMassDensity.h.

References MassDensity(), and valueIS_.

MassDensity MassDensity::operator/ ( float  scf)
inline

Definition at line 74 of file ATMMassDensity.h.

References MassDensity(), and valueIS_.

MassDensity MassDensity::operator/ ( int  scf)
inline

Definition at line 75 of file ATMMassDensity.h.

References MassDensity(), and valueIS_.

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

Definition at line 76 of file ATMMassDensity.h.

References MassDensity(), and valueIS_.

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

Definition at line 77 of file ATMMassDensity.h.

References get(), and valueIS_.

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

Definition at line 79 of file ATMMassDensity.h.

References get(), and valueIS_.

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

Definition at line 65 of file ATMMassDensity.h.

References valueIS_.

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

Definition at line 66 of file ATMMassDensity.h.

References valueIS_.

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

Definition at line 81 of file ATMMassDensity.h.

References get(), and valueIS_.

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

Definition at line 78 of file ATMMassDensity.h.

References get(), and valueIS_.

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

Definition at line 80 of file ATMMassDensity.h.

References get(), and valueIS_.

Member Data Documentation

double MassDensity::valueIS_
private

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