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"

Go to the source code of this file.

Functions
void	Ignore (Workspace &, const Agenda &, const Verbosity &)
template<class T >
void	Ignore (const T &, const Verbosity &)
	WORKSPACE METHOD: Ignore. More...
void	Touch (Workspace &, Agenda &, const Verbosity &)
template<class T >
void	Touch (T &, const Verbosity &)
	WORKSPACE METHOD: Touch. More...

Detailed Description

Implementation of Ignore.

Author

Stefan Buehler sbueh.nosp@m.ler@.nosp@m.ltu.s.nosp@m.e

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

Ignore() [1/2]

template<class T >

void Ignore	(	const T &	in,
		const Verbosity &	verbosity
	)

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 method 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.

Author

Stefan Buehler

Parameters

[in]

in

Generic Input

Definition at line 49 of file m_ignore.h.

Ignore() [2/2]

void Ignore	(	Workspace &	,
		const Agenda &	,
		const Verbosity &
	)

Definition at line 39 of file m_ignore.h.

Referenced by Ignore_sg_Agenda_g(), Ignore_sg_ArrayOfArrayOfGriddedField1_g(), Ignore_sg_ArrayOfArrayOfGriddedField2_g(), Ignore_sg_ArrayOfArrayOfGriddedField3_g(), Ignore_sg_ArrayOfArrayOfIndex_g(), Ignore_sg_ArrayOfArrayOfLineMixingRecord_g(), Ignore_sg_ArrayOfArrayOfLineRecord_g(), Ignore_sg_ArrayOfArrayOfMatrix_g(), Ignore_sg_ArrayOfArrayOfSpeciesTag_g(), Ignore_sg_ArrayOfArrayOfTensor3_g(), Ignore_sg_ArrayOfArrayOfTensor6_g(), Ignore_sg_ArrayOfArrayOfVector_g(), Ignore_sg_ArrayOfCIARecord_g(), Ignore_sg_ArrayOfGriddedField1_g(), Ignore_sg_ArrayOfGriddedField2_g(), Ignore_sg_ArrayOfGriddedField3_g(), Ignore_sg_ArrayOfGriddedField4_g(), Ignore_sg_ArrayOfIndex_g(), Ignore_sg_ArrayOfLineMixingRecord_g(), Ignore_sg_ArrayOfLineRecord_g(), Ignore_sg_ArrayOfLineshapeSpec_g(), Ignore_sg_ArrayOfMatrix_g(), Ignore_sg_ArrayOfRetrievalQuantity_g(), Ignore_sg_ArrayOfScatteringMetaData_g(), Ignore_sg_ArrayOfSingleScatteringData_g(), Ignore_sg_ArrayOfSparse_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_GriddedField1_g(), Ignore_sg_GriddedField2_g(), Ignore_sg_GriddedField3_g(), Ignore_sg_GriddedField4_g(), Ignore_sg_GriddedField5_g(), Ignore_sg_GriddedField6_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_ScatteringMetaData_g(), Ignore_sg_SingleScatteringData_g(), Ignore_sg_Sparse_g(), Ignore_sg_SpeciesAuxData_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(), Ignore_sg_Vector_g(), and Ignore_sg_Verbosity_g().

Touch() [1/2]

template<class T >

void Touch	(	T &	in,
		const Verbosity &	verbosity
	)

WORKSPACE METHOD: Touch.

As Ignore but for agenda output.

This method is handy for use in agendas in order to suppress warnings about unused output workspace variables. What it does is: Nothing!

Author

Oliver Lemke

Parameters

[out]

in

Supergeneric output

Definition at line 66 of file m_ignore.h.

Touch() [2/2]

void Touch	(	Workspace &	,
		Agenda &	,
		const Verbosity &
	)

Definition at line 57 of file m_ignore.h.

Referenced by Touch_sg_Agenda_g(), Touch_sg_ArrayOfArrayOfGriddedField1_g(), Touch_sg_ArrayOfArrayOfGriddedField2_g(), Touch_sg_ArrayOfArrayOfGriddedField3_g(), Touch_sg_ArrayOfArrayOfIndex_g(), Touch_sg_ArrayOfArrayOfLineMixingRecord_g(), Touch_sg_ArrayOfArrayOfLineRecord_g(), Touch_sg_ArrayOfArrayOfMatrix_g(), Touch_sg_ArrayOfArrayOfSpeciesTag_g(), Touch_sg_ArrayOfArrayOfTensor3_g(), Touch_sg_ArrayOfArrayOfTensor6_g(), Touch_sg_ArrayOfArrayOfVector_g(), Touch_sg_ArrayOfCIARecord_g(), Touch_sg_ArrayOfGriddedField1_g(), Touch_sg_ArrayOfGriddedField2_g(), Touch_sg_ArrayOfGriddedField3_g(), Touch_sg_ArrayOfGriddedField4_g(), Touch_sg_ArrayOfIndex_g(), Touch_sg_ArrayOfLineMixingRecord_g(), Touch_sg_ArrayOfLineRecord_g(), Touch_sg_ArrayOfLineshapeSpec_g(), Touch_sg_ArrayOfMatrix_g(), Touch_sg_ArrayOfRetrievalQuantity_g(), Touch_sg_ArrayOfScatteringMetaData_g(), Touch_sg_ArrayOfSingleScatteringData_g(), Touch_sg_ArrayOfSparse_g(), Touch_sg_ArrayOfString_g(), Touch_sg_ArrayOfTensor3_g(), Touch_sg_ArrayOfTensor4_g(), Touch_sg_ArrayOfTensor6_g(), Touch_sg_ArrayOfTensor7_g(), Touch_sg_ArrayOfVector_g(), Touch_sg_GasAbsLookup_g(), Touch_sg_GriddedField1_g(), Touch_sg_GriddedField2_g(), Touch_sg_GriddedField3_g(), Touch_sg_GriddedField4_g(), Touch_sg_GriddedField5_g(), Touch_sg_GriddedField6_g(), Touch_sg_GridPos_g(), Touch_sg_Index_g(), Touch_sg_Matrix_g(), Touch_sg_MCAntenna_g(), Touch_sg_Numeric_g(), Touch_sg_Ppath_g(), Touch_sg_ScatteringMetaData_g(), Touch_sg_SingleScatteringData_g(), Touch_sg_Sparse_g(), Touch_sg_SpeciesAuxData_g(), Touch_sg_String_g(), Touch_sg_Tensor3_g(), Touch_sg_Tensor4_g(), Touch_sg_Tensor5_g(), Touch_sg_Tensor6_g(), Touch_sg_Tensor7_g(), Touch_sg_Timer_g(), Touch_sg_Vector_g(), and Touch_sg_Verbosity_g().