ARTS  1.0.222
Public Member Functions | Private Attributes | List of all members
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)
 Initializing constructor, used to build the lookup table. More...
 
const StringName () const
 Return the name of this lineshape. More...
 
const StringDescription () const
 Return the description text. More...
 
lsf_type Function () const
 Return pointer to lineshape function. More...
 

Private Attributes

String mname
 Name of the function (e.g., Lorentz). More...
 
String mdescription
 Short description. 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 51 of file absorption.h.

Constructor & Destructor Documentation

◆ LineshapeRecord() [1/2]

LineshapeRecord::LineshapeRecord ( )
inline

Default constructor.

Definition at line 55 of file absorption.h.

◆ LineshapeRecord() [2/2]

LineshapeRecord::LineshapeRecord ( const String name,
const String description,
lsf_type  function 
)
inline

Initializing constructor, used to build the lookup table.

Definition at line 58 of file absorption.h.

Member Function Documentation

◆ Description()

const String& LineshapeRecord::Description ( ) const
inline

Return the description text.

Definition at line 68 of file absorption.h.

◆ Function()

lsf_type LineshapeRecord::Function ( ) const
inline

Return pointer to lineshape function.

Definition at line 70 of file absorption.h.

◆ Name()

const String& LineshapeRecord::Name ( ) const
inline

Return the name of this lineshape.

Definition at line 66 of file absorption.h.

Member Data Documentation

◆ mdescription

String LineshapeRecord::mdescription
private

Short description.

Definition at line 73 of file absorption.h.

◆ mfunction

lsf_type LineshapeRecord::mfunction
private

Pointer to lineshape function.

Definition at line 74 of file absorption.h.

◆ mname

String LineshapeRecord::mname
private

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

Definition at line 72 of file absorption.h.


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