m_agenda.cc File Reference

Workspace methods for Agenda. More...

#include <map>
#include "agenda_class.h"
#include "messages.h"
#include "wsv_aux.h"
#include "agenda_record.h"
#include "workspace_ng.h"

Include dependency graph for m_agenda.cc:

Go to the source code of this file.

Functions
void	AgendaExecute (Workspace &ws, const Agenda &this_agenda)
	WORKSPACE METHOD: AgendaExecute.
void	AgendaSet (Workspace &ws, Agenda &output_agenda, const String &agenda_name, const Agenda &input_agenda)
	WORKSPACE METHOD: AgendaSet.
void	AgendaAppend (Workspace &ws, Agenda &output_agenda, const String &output_agenda_name, const Agenda &in_agenda, const String &in_agenda_name, const Agenda &input_agenda)
	WORKSPACE METHOD: AgendaAppend.
void	Arts (Workspace &ws, const Agenda &input_agenda)
	WORKSPACE METHOD: Arts.

---

Detailed Description

Workspace methods for Agenda.

Author:

Stefan Buehler <sbuehler@ltu.se>

Date:

Fri Mar 15 09:12:46 2002

Definition in file m_agenda.cc.

---

Function Documentation

void AgendaAppend	(	Workspace &	ws,
		Agenda &	gout1,
		const String &	gout1_wsvname,
		const Agenda &	gin1,
		const String &	gin1_wsvname,
		const Agenda &	input_agenda
	)

WORKSPACE METHOD: AgendaAppend.

Append methods to an agenda.

An agenda is used to store a list of methods that are meant to be executed sequentially.

This method takes the methods given in the body (in the curly braces) and appends them to the agenda given by the output argument (in the round braces).

It also uses the agenda lookup data (defined in file agendas.cc) to check, whether the given methods use the right input WSVs and produce the right output WSVs.

Author:

Oliver Lemke

Parameters:

[in,out]	ws	Workspace
[out]	gout1	Generic output
[in]	gout1_wsvname	Generic Output Name
[in]	gin1	Generic Input
[in]	gin1_wsvname	Generic Input Name
[in]	input_agenda	Agenda from controlfile

Definition at line 61 of file m_agenda.cc.

References Agenda::check(), Agenda::Methods(), Array< base >::nelem(), and Agenda::set_methods().

Referenced by AgendaAppend_g(), and Agenda::append().

void AgendaExecute	(	Workspace &	ws,
		const Agenda &	gin1
	)

WORKSPACE METHOD: AgendaExecute.

Execute an agenda.

Generic input: <br> Agenda : The agenda.

Author:

Oliver Lemke

Parameters:

[in,out]	ws	Workspace
[in]	gin1	Generic Input

Definition at line 35 of file m_agenda.cc.

References Agenda::execute(), and out3.

Referenced by AgendaExecute_g().

void AgendaSet	(	Workspace &	ws,
		Agenda &	gout1,
		const String &	gout1_wsvname,
		const Agenda &	input_agenda
	)

WORKSPACE METHOD: AgendaSet.

Set up an agenda.

An agenda is used to store a list of methods that are meant to be executed sequentially.

This method takes the methods given in the body (in the curly braces) and puts them in the agenda given by the output argument (in the round braces).

It also uses the agenda lookup data (defined in file agendas.cc) to check, whether the given methods use the right input WSVs and produce the right output WSVs. <br> Generic output: <br> Agenda : The new agenda.

Keywords: <br> No keywords, but other methods can appear in the method body.

Author:

Oliver Lemke

Parameters:

[in,out]	ws	Workspace
[out]	gout1	Generic output
[in]	gout1_wsvname	Generic Output Name
[in]	input_agenda	Agenda from controlfile

Definition at line 45 of file m_agenda.cc.

References Agenda::check(), and Agenda::set_name().

Referenced by AgendaSet_g().

void Arts	(	Workspace &	ws,
		const Agenda &	input_agenda
	)

WORKSPACE METHOD: Arts.

Run the agenda that is specified inside the curly braces. ARTS controlfiles must define this method. It is executed automatically when ARTS is run on the controlfile.

Author:

Stefan Buehler

Parameters:

[in,out]	ws	Workspace
[in]	input_agenda	Agenda from controlfile

Definition at line 92 of file m_agenda.cc.

References Agenda::execute().

Referenced by Arts_g(), and main().