m_ignore.h File Reference

Implementation of Ignore. More...

#include "exceptions.h"
#include "messages.h"
#include "mystring.h"
#include "workspace_ng.h"
#include "agenda_class.h"

Include dependency graph for m_ignore.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	Ignore (Workspace &ws, const Agenda &in)
template<class T>
void	Ignore (const T &in)
	WORKSPACE METHOD: Ignore.
void	DoNothing (Workspace &ws, Agenda &out, Agenda &in)
template<class T>
void	DoNothing (T &out, T &in)

---

Detailed Description

Implementation of Ignore.

Author:

Stefan Buehler <sbuehler@ltu.se>

Date:

Fri Jun 14 17:09:05 2002

This file contains the implementation of the supergeneric method Ignore.

Definition in file m_ignore.h.

---

Function Documentation

template<class T>

void DoNothing	(	T &	out,
		T &	in
	)			[inline]

Definition at line 68 of file m_ignore.h.

void DoNothing	(	Workspace &	ws,
		Agenda &	out,
		Agenda &	in
	)

Definition at line 55 of file m_ignore.h.

template<class T>

void Ignore

(

const T &

gin1

)

[inline]

WORKSPACE METHOD: Ignore.

Ignore a workspace variable.

This method is handy for use in agendas in order to suppress warnings about unused input workspace variables. What it does is: Nothing! In other words, it just ignores the variable it is called on.

This is a supergeneric method. It can ignore any workspace variable you want.

Usage example:

AgendaSet(els_agenda){ <br> Ignore(ls_sigma){} <br> elsLorentz{} }

Without Ignore you would get an error message, because els_agenda is supposed to use the Doppler width *ls_sigma*, but the Lorentz lineshape elsLorentz* does not need it.

Supergeneric input: <br> Any : The input variable.

Author:

Stefan Buehler

Parameters:

[in]

gin1

Generic Input

Definition at line 48 of file m_ignore.h.

Referenced by Ignore_sg_Agenda_g(), Ignore_sg_ArrayOfArrayOfArrayOfArrayOfGridPos_g(), Ignore_sg_ArrayOfArrayOfGField1_g(), Ignore_sg_ArrayOfArrayOfGField3_g(), Ignore_sg_ArrayOfArrayOfIndex_g(), Ignore_sg_ArrayOfArrayOfLineRecord_g(), Ignore_sg_ArrayOfArrayOfMatrix_g(), Ignore_sg_ArrayOfArrayOfSpeciesTag_g(), Ignore_sg_ArrayOfArrayOfTensor3_g(), Ignore_sg_ArrayOfArrayOfTensor6_g(), Ignore_sg_ArrayOfGField1_g(), Ignore_sg_ArrayOfGField2_g(), Ignore_sg_ArrayOfGField3_g(), Ignore_sg_ArrayOfGField4_g(), Ignore_sg_ArrayOfIndex_g(), Ignore_sg_ArrayOfLineRecord_g(), Ignore_sg_ArrayOfLineshapeSpec_g(), Ignore_sg_ArrayOfMatrix_g(), Ignore_sg_ArrayOfPpath_g(), Ignore_sg_ArrayOfRetrievalQuantity_g(), Ignore_sg_ArrayOfSingleScatteringData_g(), Ignore_sg_ArrayOfString_g(), Ignore_sg_ArrayOfTensor3_g(), Ignore_sg_ArrayOfTensor4_g(), Ignore_sg_ArrayOfTensor6_g(), Ignore_sg_ArrayOfTensor7_g(), Ignore_sg_ArrayOfVector_g(), Ignore_sg_GasAbsLookup_g(), Ignore_sg_GField1_g(), Ignore_sg_GField2_g(), Ignore_sg_GField3_g(), Ignore_sg_GField4_g(), Ignore_sg_GridPos_g(), Ignore_sg_Index_g(), Ignore_sg_Matrix_g(), Ignore_sg_MCAntenna_g(), Ignore_sg_Numeric_g(), Ignore_sg_Ppath_g(), Ignore_sg_SingleScatteringData_g(), Ignore_sg_SLIData2_g(), Ignore_sg_Sparse_g(), Ignore_sg_String_g(), Ignore_sg_Tensor3_g(), Ignore_sg_Tensor4_g(), Ignore_sg_Tensor5_g(), Ignore_sg_Tensor6_g(), Ignore_sg_Tensor7_g(), Ignore_sg_Timer_g(), and Ignore_sg_Vector_g().

void Ignore	(	Workspace &	ws,
		const Agenda &	in
	)

Definition at line 39 of file m_ignore.h.