LineshapeRecord Class Reference

Lineshape related information. More...

#include <absorption.h>

Public Member Functions
	LineshapeRecord ()
	Default constructor. More...
	LineshapeRecord (const String &name, const String &description, lsf_type function, const bool phase)
	Initializing constructor, used to build the lookup table. More...
const String &	Name () const
	Return the name of this lineshape. More...
const String &	Description () const
	Return the description text. More...
lsf_type	Function () const
	Return pointer to lineshape function. More...
bool	Phase () const
	Returns true if lineshape function calculates phase information. More...

Private Attributes
String	mname
	Name of the function (e.g., Lorentz). More...
String	mdescription
	Short description. More...
bool	mphase
	Does this lineshape calculate phase information? More...
lsf_type	mfunction
	Pointer to lineshape function. More...

Detailed Description

Lineshape related information.

There is one LineshapeRecord for each available lineshape function.

Author

Stefan Buehler

Date

2000-08-21

Definition at line 58 of file absorption.h.

Constructor & Destructor Documentation

LineshapeRecord() [1/2]

LineshapeRecord::LineshapeRecord ( )

inline

Default constructor.

Definition at line 62 of file absorption.h.

LineshapeRecord() [2/2]

LineshapeRecord::LineshapeRecord ( const String &  name, const String &  description, lsf_type  function, const bool  phase  )

inline

Initializing constructor, used to build the lookup table.

Definition at line 69 of file absorption.h.

Member Function Documentation

Description()

const String& LineshapeRecord::Description ( ) const

inline

Return the description text.

Definition at line 81 of file absorption.h.

References mdescription.

Function()

lsf_type LineshapeRecord::Function ( ) const

inline

Return pointer to lineshape function.

Definition at line 83 of file absorption.h.

References mfunction.

Name()

const String& LineshapeRecord::Name ( ) const

inline

Return the name of this lineshape.

Definition at line 79 of file absorption.h.

References mname.

Phase()

bool LineshapeRecord::Phase ( ) const

inline

Returns true if lineshape function calculates phase information.

Definition at line 85 of file absorption.h.

References mphase.

Member Data Documentation

mdescription

String LineshapeRecord::mdescription

private

Short description.

Definition at line 88 of file absorption.h.

Referenced by Description().

mfunction

lsf_type LineshapeRecord::mfunction

private

Pointer to lineshape function.

Definition at line 90 of file absorption.h.

Referenced by Function().

mname

String LineshapeRecord::mname

private

Name of the function (e.g., Lorentz).

Definition at line 87 of file absorption.h.

Referenced by Name().

mphase

bool LineshapeRecord::mphase

private

Does this lineshape calculate phase information?

Definition at line 89 of file absorption.h.

Referenced by Phase().

---

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

• absorption.h