RetrievalQuantity Class Reference

Contains the data for one retrieval quantity. More...

#include <jacobian.h>

Collaboration diagram for RetrievalQuantity:

[legend]

List of all members.

Public Member Functions
	RetrievalQuantity ()
	Default constructor.
	RetrievalQuantity (const RetrievalQuantity &x)
	Copy constructor.
	RetrievalQuantity (const String &maintag, const String &subtag, const String &mode, const Index &analytical, const Numeric &perturbation, const MakeArray< Vector > &grids)
	Constructor that sets the values.
const String &	MainTag () const
	Main tag.
void	MainTag (const String &mt)
const String &	Subtag () const
	Subtag.
void	Subtag (const String &st)
const String &	Mode () const
	Mode of retrieval quantity.
void	Mode (const String &m)
const Index &	Analytical () const
	Boolean to make analytical calculations (if possible).
void	Analytical (const Index &m)
const Numeric &	Perturbation () const
	Size of perturbation used for perturbation calculations.
void	Perturbation (const Numeric &p)
const ArrayOfVector &	Grids () const
	Grids.
void	Grids (const ArrayOfVector &g)
Private Attributes
String	mmaintag
String	msubtag
String	mmode
Index	manalytical
Numeric	mperturbation
ArrayOfVector	mgrids

---

Detailed Description

Contains the data for one retrieval quantity.

Author:

Mattias Ekstrom

Definition at line 45 of file jacobian.h.

---

Constructor & Destructor Documentation

RetrievalQuantity::RetrievalQuantity

(

)

[inline]

Default constructor.

Needed by make_array.

Definition at line 49 of file jacobian.h.

RetrievalQuantity::RetrievalQuantity

(

const RetrievalQuantity &

x

)

[inline]

Copy constructor.

We need this, since operator= does not work correctly for Arrays. (Target Array has to be resized first.)

Definition at line 60 of file jacobian.h.

RetrievalQuantity::RetrievalQuantity	(	const String &	maintag,
		const String &	subtag,
		const String &	mode,
		const Index &	analytical,
		const Numeric &	perturbation,
		const MakeArray< Vector > &	grids
	)			[inline]

Constructor that sets the values.

Definition at line 70 of file jacobian.h.

---

Member Function Documentation

const String& RetrievalQuantity::MainTag

(

)

const [inline]

Main tag.

Definition at line 87 of file jacobian.h.

References mmaintag.

Referenced by jacobianAddAbsSpecies(), jacobianAddPointing(), jacobianAddTemperature(), operator<<(), and xml_write_to_stream().

void RetrievalQuantity::MainTag

(

const String &

mt

)

[inline]

Definition at line 88 of file jacobian.h.

References mmaintag.

const String& RetrievalQuantity::Subtag

(

)

const [inline]

Subtag.

Eg. for gas species: O3, ClO.

Definition at line 90 of file jacobian.h.

References msubtag.

Referenced by jacobianAddAbsSpecies(), jacobianAddPointing(), jacobianAddTemperature(), jacobianCalcTemperature(), operator<<(), and xml_write_to_stream().

void RetrievalQuantity::Subtag

(

const String &

st

)

[inline]

Definition at line 91 of file jacobian.h.

References msubtag.

const String& RetrievalQuantity::Mode

(

)

const [inline]

Mode of retrieval quantity.

Eg. "abs", "rel", "vmr" and "nd".

Definition at line 93 of file jacobian.h.

References mmode.

Referenced by jacobianAddAbsSpecies(), jacobianAddPointing(), jacobianAddTemperature(), jacobianCalcAbsSpecies(), jacobianCalcPointing(), and xml_write_to_stream().

void RetrievalQuantity::Mode

(

const String &

m

)

[inline]

Definition at line 94 of file jacobian.h.

References mmode.

const Index& RetrievalQuantity::Analytical

(

)

const [inline]

Boolean to make analytical calculations (if possible).

Definition at line 96 of file jacobian.h.

References manalytical.

Referenced by jacobianAddAbsSpecies(), jacobianAddPointing(), jacobianAddTemperature(), jacobianCalcAbsSpecies(), and xml_write_to_stream().

void RetrievalQuantity::Analytical

(

const Index &

m

)

[inline]

Definition at line 97 of file jacobian.h.

References manalytical.

const Numeric& RetrievalQuantity::Perturbation

(

)

const [inline]

Size of perturbation used for perturbation calculations.

Definition at line 99 of file jacobian.h.

References mperturbation.

Referenced by jacobianAddAbsSpecies(), jacobianAddPointing(), jacobianAddTemperature(), jacobianCalcPointing(), and xml_write_to_stream().

void RetrievalQuantity::Perturbation

(

const Numeric &

p

)

[inline]

Definition at line 100 of file jacobian.h.

References mperturbation.

const ArrayOfVector& RetrievalQuantity::Grids

(

)

const [inline]

Grids.

Definition grids for the jacobian, eg. p, lat and lon.

Definition at line 102 of file jacobian.h.

References mgrids.

Referenced by jacobian_from_path_to_rgrids(), jacobianAddAbsSpecies(), jacobianAddPointing(), jacobianAddTemperature(), jacobianCalcAbsSpecies(), jacobianCalcPointing(), jacobianCalcTemperature(), and xml_write_to_stream().

void RetrievalQuantity::Grids

(

const ArrayOfVector &

g

)

[inline]

Definition at line 103 of file jacobian.h.

References mgrids.

---

Member Data Documentation

String RetrievalQuantity::mmaintag [private]

Definition at line 107 of file jacobian.h.

Referenced by MainTag().

String RetrievalQuantity::msubtag [private]

Definition at line 108 of file jacobian.h.

Referenced by Subtag().

String RetrievalQuantity::mmode [private]

Definition at line 109 of file jacobian.h.

Referenced by Mode().

Index RetrievalQuantity::manalytical [private]

Definition at line 110 of file jacobian.h.

Referenced by Analytical().

Numeric RetrievalQuantity::mperturbation [private]

Definition at line 111 of file jacobian.h.

Referenced by Perturbation().

ArrayOfVector RetrievalQuantity::mgrids [private]

Definition at line 112 of file jacobian.h.

Referenced by Grids().

---

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

• jacobian.h