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

#include <transition.h>

Collaboration diagram for TransitionConstProxy:
Collaboration graph
[legend]

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 >
 

Detailed Description

Definition at line 145 of file transition.h.

Member Typedef Documentation

Definition at line 150 of file transition.h.

Definition at line 149 of file transition.h.

Definition at line 148 of file transition.h.

Constructor & Destructor Documentation

TransitionConstProxy::TransitionConstProxy ( )
inlineexplicit

Definition at line 161 of file transition.h.

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

Definition at line 162 of file transition.h.

Member Function Documentation

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

Definition at line 171 of file transition.h.

References m_index, and m_list.

void TransitionConstProxy::check ( ) const
inline

Definition at line 179 of file transition.h.

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

Definition at line 204 of file transition.h.

References EnergyWN().

Here is the call graph for this function:

realnum TransitionConstProxy::EnergyErg ( ) const
inline

transition energy in ergs

Definition at line 194 of file transition.h.

References EnergyWN().

Here is the call graph for this function:

realnum TransitionConstProxy::EnergyK ( ) const
inline

transition energy in degrees kelvin

Definition at line 189 of file transition.h.

References EnergyWN().

Here is the call graph for this function:

double TransitionConstProxy::EnergyRyd ( ) const
inline

transition energy in Ryd

Definition at line 199 of file transition.h.

References EnergyWN().

Here is the call graph for this function:

realnum TransitionConstProxy::EnergyWN ( ) const
inline

transition energy in wavenumbers

Definition at line 481 of file transition.h.

References TransitionListImpl::EnergyWN, m_index, and m_list.

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

string TransitionConstProxy::getComment ( ) const
inline

Definition at line 535 of file transition.h.

References TransitionListImpl::chComment, m_index, and m_list.

bool TransitionConstProxy::hasEmis ( ) const
inline

Definition at line 175 of file transition.h.

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

Definition at line 493 of file transition.h.

References TransitionListImpl::ipCont, m_index, and m_list.

int TransitionConstProxy::ipEmis ( ) const
inline

Definition at line 459 of file transition.h.

References TransitionListImpl::ipEmis, m_index, and m_list.

Referenced by hasEmis().

int TransitionConstProxy::ipHi ( ) const
inline

Definition at line 509 of file transition.h.

References TransitionListImpl::ipHi, m_index, and m_list.

int TransitionConstProxy::ipLo ( ) const
inline

Definition at line 501 of file transition.h.

References TransitionListImpl::ipLo, m_index, and m_list.

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

Definition at line 472 of file transition.h.

References m_index, m_list, and TransitionListImpl::WLAng.

Friends And Related Function Documentation

Definition at line 152 of file transition.h.

Field Documentation

int TransitionConstProxy::m_index
private

Definition at line 154 of file transition.h.

Referenced by associated(), check(), EnergyWN(), getComment(), ipCont(), ipEmis(), ipHi(), ipLo(), and WLAng().

const list_type* TransitionConstProxy::m_list
private

Definition at line 153 of file transition.h.

Referenced by associated(), EnergyWN(), getComment(), ipCont(), ipEmis(), ipHi(), ipLo(), and WLAng().


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