cloudy  trunk
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends
Flux Class Reference

#include <flux.h>

Collaboration diagram for Flux:
Collaboration graph
[legend]

Public Member Functions

 Flux ()
 
 Flux (Energy e, double flux)
 
 Flux (Energy e, double flux, const string &unit)
 
void set (Energy e, double flux)
 
void set (Energy e, double flux, const string &unit)
 
double get () const
 
double get (const string &unit) const
 
Energy E () const
 
string uu () const
 

Private Types

enum  fu_flag {
  FU_NONE, FU_ERG_S, FU_W, FU_JY,
  FU_MJY, FU_MJY_SR, FU_CM2, FU_M2,
  FU_A, FU_NM, FU_MU, FU_HZ,
  FU_SR, FU_SQAS, FU_TOP
}
 
typedef bitset< FU_TOP > fu_bits
 

Private Member Functions

fu_bits p_InternalFluxUnitNoCheck (const string &unit, size_t &len) const
 
fu_bits p_InternalFluxUnit (const string &unit) const
 
bool p_ValidFluxUnit (fu_bits) const
 
void p_set (Energy e, double value, fu_bits bits)
 
double p_get (fu_bits bits) const
 

Private Attributes

Energy p_energy
 
double p_flux
 
fu_bits p_userunits
 

Friends

bool ValidFluxUnit (const string &unit)
 

Detailed Description

Definition at line 9 of file flux.h.

Member Typedef Documentation

typedef bitset<FU_TOP> Flux::fu_bits
private

Definition at line 15 of file flux.h.

Member Enumeration Documentation

enum Flux::fu_flag
private
Enumerator
FU_NONE 
FU_ERG_S 
FU_W 
FU_JY 
FU_MJY 
FU_MJY_SR 
FU_CM2 
FU_M2 
FU_A 
FU_NM 
FU_MU 
FU_HZ 
FU_SR 
FU_SQAS 
FU_TOP 

Definition at line 11 of file flux.h.

Constructor & Destructor Documentation

Flux::Flux ( )
inline

Definition at line 28 of file flux.h.

References p_userunits, and set().

Here is the call graph for this function:

Flux::Flux ( Energy  e,
double  flux 
)
inline

Definition at line 33 of file flux.h.

References set().

Here is the call graph for this function:

Flux::Flux ( Energy  e,
double  flux,
const string &  unit 
)
inline

Definition at line 37 of file flux.h.

References set().

Here is the call graph for this function:

Member Function Documentation

Energy Flux::E ( ) const
inline

Definition at line 59 of file flux.h.

References p_energy.

double Flux::get ( ) const
inline

Definition at line 51 of file flux.h.

References p_flux.

double Flux::get ( const string &  unit) const
inline

Definition at line 55 of file flux.h.

References p_get(), and p_InternalFluxUnit().

Here is the call graph for this function:

double Flux::p_get ( fu_bits  bits) const
private

Definition at line 142 of file flux.cpp.

References Energy::Angstrom(), DEBUG_ENTRY, FU_A, FU_HZ, FU_JY, FU_M2, FU_MJY, FU_MJY_SR, FU_MU, FU_NM, FU_SQAS, FU_SR, FU_W, Energy::Hz(), Energy::micron(), Energy::nm(), p_energy, and p_flux.

Referenced by get().

Here is the call graph for this function:

Flux::fu_bits Flux::p_InternalFluxUnit ( const string &  unit) const
private

Definition at line 85 of file flux.cpp.

References cdEXIT, DEBUG_ENTRY, EXIT_FAILURE, fprintf(), ioQQQ, p_InternalFluxUnitNoCheck(), and p_ValidFluxUnit().

Referenced by get(), and set().

Here is the call graph for this function:

Flux::fu_bits Flux::p_InternalFluxUnitNoCheck ( const string &  unit,
size_t &  len 
) const
private

Definition at line 8 of file flux.cpp.

References DEBUG_ENTRY, FU_A, FU_CM2, FU_ERG_S, FU_HZ, FU_JY, FU_M2, FU_MJY, FU_MJY_SR, FU_MU, FU_NM, FU_SQAS, FU_SR, and FU_W.

Referenced by p_InternalFluxUnit(), and ValidFluxUnit().

void Flux::p_set ( Energy  e,
double  value,
fu_bits  bits 
)
private

Definition at line 173 of file flux.cpp.

References Energy::Angstrom(), DEBUG_ENTRY, FU_A, FU_HZ, FU_JY, FU_M2, FU_MJY, FU_MJY_SR, FU_MU, FU_NM, FU_SQAS, FU_SR, FU_W, Energy::Hz(), Energy::micron(), Energy::nm(), p_energy, p_flux, and p_userunits.

Referenced by set().

Here is the call graph for this function:

bool Flux::p_ValidFluxUnit ( fu_bits  bits) const
private

Definition at line 99 of file flux.cpp.

References DEBUG_ENTRY, FU_A, FU_CM2, FU_ERG_S, FU_HZ, FU_JY, FU_M2, FU_MJY, FU_MJY_SR, FU_MU, FU_NM, FU_SQAS, FU_SR, and FU_W.

Referenced by p_InternalFluxUnit(), uu(), and ValidFluxUnit().

void Flux::set ( Energy  e,
double  flux 
)
inline

Definition at line 42 of file flux.h.

Referenced by Flux().

void Flux::set ( Energy  e,
double  flux,
const string &  unit 
)
inline

Definition at line 46 of file flux.h.

References p_InternalFluxUnit(), and p_set().

Here is the call graph for this function:

string Flux::uu ( ) const

Definition at line 255 of file flux.cpp.

References ASSERT, DEBUG_ENTRY, FU_A, FU_CM2, FU_ERG_S, FU_HZ, FU_JY, FU_M2, FU_MJY, FU_MJY_SR, FU_MU, FU_NM, FU_SQAS, FU_SR, FU_W, p_userunits, and p_ValidFluxUnit().

Here is the call graph for this function:

Friends And Related Function Documentation

bool ValidFluxUnit ( const string &  unit)
friend

Definition at line 71 of file flux.h.

Field Documentation

Energy Flux::p_energy
private

Definition at line 17 of file flux.h.

Referenced by E(), p_get(), and p_set().

double Flux::p_flux
private

Definition at line 18 of file flux.h.

Referenced by get(), p_get(), and p_set().

fu_bits Flux::p_userunits
private

Definition at line 19 of file flux.h.

Referenced by Flux(), p_set(), and uu().

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.5