Cloudy
Spectral Synthesis Code for Astrophysics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
TransitionConstProxy Class Reference

#include <transition.h>

Collaboration diagram for TransitionConstProxy:

Public Types

typedef const TransitionListImpl list_type
 
typedef ProxyIterator
< TransitionConstProxy,
TransitionConstProxy
iterator
 
typedef ProxyIterator
< TransitionConstProxy,
TransitionConstProxy
const_iterator
 

Public Member Functions

 TransitionConstProxy ()
 
 TransitionConstProxy (const TransitionListImpl *list, int index)
 
void copy (const TransitionConstProxy &other) const
 
qList::iterator Lo () const
 
qList::iterator Hi () const
 
void AddLine2Stack () const
 
EmissionList::reference Emis () const
 
int ipEmis () const
 
string getComment () const
 
bool associated () const
 
bool hasEmis () const
 
void check () const
 
CollisionProxy Coll () const
 
realnum WLAng () const
 
realnum EnergyK () const
 
realnum EnergyErg () const
 
double EnergyRyd () const
 
realnum EnergyAng () const
 
realnum EnergyWN () const
 
long ipCont () const
 
void outline (double nonScatteredFraction, bool lgDoChecks) const
 
void outline_resonance () const
 
int ipLo () const
 
int ipHi () const
 

Private Attributes

const list_typem_list
 
int m_index
 

Friends

class ProxyIterator< TransitionConstProxy, TransitionConstProxy >
 

Member Typedef Documentation

Constructor & Destructor Documentation

TransitionConstProxy::TransitionConstProxy ( )
inlineexplicit
TransitionConstProxy::TransitionConstProxy ( const TransitionListImpl list,
int  index 
)
inlineexplicit

Member Function Documentation

void TransitionConstProxy::AddLine2Stack ( ) const
bool TransitionConstProxy::associated ( ) const
inline

References m_index, m_list, and NULL.

void TransitionConstProxy::check ( ) const
inline

References ASSERT, Emis(), hasEmis(), and m_index.

Referenced by EmissionConstProxy::Tran().

Here is the call graph for this function:

CollisionProxy TransitionConstProxy::Coll ( ) const
void TransitionConstProxy::copy ( const TransitionConstProxy other) const
EmissionList::reference TransitionConstProxy::Emis ( ) const

Referenced by check().

realnum TransitionConstProxy::EnergyAng ( ) const
inline

vacuum wavelength in Angstroms

References EnergyWN().

Here is the call graph for this function:

realnum TransitionConstProxy::EnergyErg ( ) const
inline

transition energy in ergs

References EnergyWN().

Here is the call graph for this function:

realnum TransitionConstProxy::EnergyK ( ) const
inline

transition energy in degrees kelvin

References EnergyWN().

Here is the call graph for this function:

double TransitionConstProxy::EnergyRyd ( ) const
inline

transition energy in Ryd

References EnergyWN().

Here is the call graph for this function:

realnum TransitionConstProxy::EnergyWN ( ) const
inline

transition energy in wavenumbers

References TransitionListImpl::EnergyWN, m_index, and m_list.

Referenced by EnergyAng(), EnergyErg(), EnergyK(), and EnergyRyd().

string TransitionConstProxy::getComment ( ) const
inline
bool TransitionConstProxy::hasEmis ( ) const
inline

References ipEmis().

Referenced by check().

Here is the call graph for this function:

qList::iterator TransitionConstProxy::Hi ( ) const
long TransitionConstProxy::ipCont ( ) const
inline

index for line within continuum array, this is on the f, not c, scale, negative ipCont means this is not a radiative transition, and is used as a sentnecl

References TransitionListImpl::ipCont, m_index, and m_list.

int TransitionConstProxy::ipEmis ( ) const
inline

References TransitionListImpl::ipEmis, m_index, and m_list.

Referenced by hasEmis().

int TransitionConstProxy::ipHi ( ) const
inline
int TransitionConstProxy::ipLo ( ) const
inline
qList::iterator TransitionConstProxy::Lo ( ) const
void TransitionConstProxy::outline ( double  nonScatteredFraction,
bool  lgDoChecks 
) const

outline - adds line photons to reflin and outlin

void TransitionConstProxy::outline_resonance ( ) const

outline_resonance - adds line photons to reflin and outlin, setting nonScatteredFraction as default for resonance lines

realnum TransitionConstProxy::WLAng ( ) const
inline

wavelength, usually in Angstroms, used for printout, can be any units

References m_index, m_list, and TransitionListImpl::WLAng.

Friends And Related Function Documentation

Member Data Documentation

int TransitionConstProxy::m_index
private
const list_type* TransitionConstProxy::m_list
private

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