CARMA C++
carma::services::FluxDensity Class Reference

The FluxDensity class is used to represent a flux density in any units. More...

#include <carma/services/FluxDensity.h>

Inheritance diagram for carma::services::FluxDensity:
carma::services::ConformableQuantity

Public Member Functions

 FluxDensity (double value, const std::string &units)
 Construct a FluxDensity object. More...
 
double jansky () const
 Convenience method to return the value of this FluxDensity in Janskys. More...
 
double megajansky () const
 
double millijansky () const
 
const FluxDensity operator+ (const FluxDensity &flux) const
 Add two FluxDensities. More...
 
const FluxDensity operator+= (const FluxDensity &flux)
 Increment FluxDensity. More...
 
const FluxDensity operator- (const FluxDensity &flux) const
 Subtract two FluxDensities. More...
 
const FluxDensity operator-= (const FluxDensity &flux)
 Decrement FluxDensity. More...
 
bool operator< (const FluxDensity &flux) const
 Compare two FluxDensityes. More...
 
- Public Member Functions inherited from carma::services::ConformableQuantity
 ConformableQuantity (double value, const std::string &units)
 Construct an ConformableQuantity given a value and units. More...
 
virtual double convert (const std::string &convertTo) const
 Converts this quantity to any conformable units. More...
 
virtual std::string getUnits () const
 
double getValue () const
 
virtual const ConformableQuantity operator+ (const ConformableQuantity &quantity) const
 Add two ConformableQuantities. More...
 
virtual ConformableQuantityoperator+= (const ConformableQuantity &quantity)
 Add ConformableQuantity to itself. More...
 
virtual const ConformableQuantity operator- (const ConformableQuantity &quantity) const
 Subtract two ConformableQuantities. More...
 
virtual ConformableQuantityoperator-= (const ConformableQuantity &quantity)
 Subtract ConformableQuantity from itself. More...
 
virtual void reset (double value, const std::string &units)
 Reset method to change value and/or units. More...
 
virtual ~ConformableQuantity ()
 Destructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from carma::services::ConformableQuantity
Units u_
 Used for converting between units. More...
 

Detailed Description

The FluxDensity class is used to represent a flux density in any units.

It uses the Units class to internally deal with conversions.

Definition at line 20 of file FluxDensity.h.

Constructor & Destructor Documentation

carma::services::FluxDensity::FluxDensity ( double  value,
const std::string &  units 
)

Construct a FluxDensity object.

Parameters
valueflux value
unitsflux units
Exceptions
carma::util::IllegalArgumentException

Member Function Documentation

double carma::services::FluxDensity::jansky ( ) const

Convenience method to return the value of this FluxDensity in Janskys.

Returns
the flux value in Janskys
double carma::services::FluxDensity::megajansky ( ) const
Returns
the flux value in megaJy
double carma::services::FluxDensity::millijansky ( ) const
Returns
the flux value in mJy
const FluxDensity carma::services::FluxDensity::operator+ ( const FluxDensity flux) const

Add two FluxDensities.

Returns
FluxDensity object in units Jy
Exceptions
ConformabilityException
const FluxDensity carma::services::FluxDensity::operator+= ( const FluxDensity flux)

Increment FluxDensity.

Returns
FluxDensity object in units Jy
Exceptions
ConformabilityException
const FluxDensity carma::services::FluxDensity::operator- ( const FluxDensity flux) const

Subtract two FluxDensities.

Returns
FluxDensity object in units Jy
Exceptions
ConformabilityException
const FluxDensity carma::services::FluxDensity::operator-= ( const FluxDensity flux)

Decrement FluxDensity.

Returns
FluxDensity object in units Jy
Exceptions
ConformabilityException
bool carma::services::FluxDensity::operator< ( const FluxDensity flux) const

Compare two FluxDensityes.

Exceptions
ConformabilityException

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