AgRecord Class Reference

Lookup information for one agenda. More...

#include <agenda_record.h>

Public Member Functions
	AgRecord ()
	Default constructor.
	AgRecord (const char *name, const char *description, const ArrayOfString &output, const ArrayOfString &input)
	The only non-trivial constructor for AgRecord, which sets all the fields.
	AgRecord (const AgRecord &)=default
AgRecord &	operator= (const AgRecord &)=default
const String &	Name () const
const String &	Description () const
const ArrayOfIndex &	Out () const
const ArrayOfIndex &	In () const

Private Attributes
String	mname
	The name of this agenda.
String	mdescription
	A text string describing this agenda.
ArrayOfIndex	moutput
	Workspace Output.
ArrayOfIndex	minput
	Workspace Input.

Friends
ostream &	operator<< (ostream &os, const AgRecord &agr)
	Output operator for AgRecord.

Detailed Description

Lookup information for one agenda.

An object of this class contains the documentation for an agenda, plus the list of output and input variables.

This cannot be set in the workspace lookup data, since we need to use the handles for the WSVs.

Definition at line 26 of file agenda_record.h.

Constructor & Destructor Documentation

AgRecord() [1/3]

AgRecord::AgRecord ( )

inline

Default constructor.

Definition at line 29 of file agenda_record.h.

AgRecord() [2/3]

AgRecord::AgRecord	(	const char *	name,
		const char *	description,
		const ArrayOfString &	output,
		const ArrayOfString &	input
	)

The only non-trivial constructor for AgRecord, which sets all the fields.

We work on the assumption, that the workspace lookup data has been defined before. So, what we have to do here is make sure that this agenda exists.

Parameters

name	Agenda name.
description	Agenda documentation.
output	List of output WSVs.
input	List of input WSVs.

Overwrite description in wsv data with agenda data

Definition at line 39 of file agenda_record.cc.

References ARTS_USER_ERROR_IF, mdescription, minput, mname, moutput, Array< base >::nelem(), global_data::wsv_data, and global_data::WsvMap.

AgRecord() [3/3]

AgRecord::AgRecord ( const AgRecord &  )

default

Member Function Documentation

Description()

const String & AgRecord::Description ( ) const

inline

Definition at line 43 of file agenda_record.h.

References mdescription.

In()

const ArrayOfIndex & AgRecord::In ( ) const

inline

Definition at line 45 of file agenda_record.h.

References minput.

Referenced by Agenda::check(), dobatch_calc_agendaExecute(), doit_conv_test_agendaExecute(), doit_mono_agendaExecute(), doit_rte_agendaExecute(), doit_scat_field_agendaExecute(), forloop_agendaExecute(), g0_agendaExecute(), gas_scattering_agendaExecute(), Agenda::get_global_inout(), inversion_iterate_agendaExecute(), iy_cloudbox_agendaExecute(), iy_independent_beam_approx_agendaExecute(), iy_loop_freqs_agendaExecute(), iy_main_agendaExecute(), iy_radar_agendaExecute(), iy_space_agendaExecute(), iy_surface_agendaExecute(), jacobian_agendaExecute(), main(), met_profile_calc_agendaExecute(), pha_mat_spt_agendaExecute(), pnd_agenda_arrayExecute(), ppath_agendaExecute(), ppath_step_agendaExecute(), propmat_clearsky_agendaExecute(), refr_index_air_agendaExecute(), sensor_response_agendaExecute(), spt_calc_agendaExecute(), surface_rtprop_agenda_arrayExecute(), surface_rtprop_agendaExecute(), test_agenda_arrayExecute(), water_p_eq_agendaExecute(), write_agenda_wrapper_header(), and ybatch_calc_agendaExecute().

Name()

const String & AgRecord::Name ( ) const

inline

Definition at line 42 of file agenda_record.h.

References mname.

Referenced by main(), and write_agenda_wrapper_header().

operator=()

AgRecord & AgRecord::operator= ( const AgRecord &  )

default

Out()

const ArrayOfIndex & AgRecord::Out ( ) const

inline

Definition at line 44 of file agenda_record.h.

References moutput.

Referenced by Agenda::check(), dobatch_calc_agendaExecute(), doit_conv_test_agendaExecute(), doit_mono_agendaExecute(), doit_rte_agendaExecute(), doit_scat_field_agendaExecute(), g0_agendaExecute(), gas_scattering_agendaExecute(), Agenda::get_global_inout(), inversion_iterate_agendaExecute(), iy_cloudbox_agendaExecute(), iy_independent_beam_approx_agendaExecute(), iy_loop_freqs_agendaExecute(), iy_main_agendaExecute(), iy_radar_agendaExecute(), iy_space_agendaExecute(), iy_surface_agendaExecute(), jacobian_agendaExecute(), main(), met_profile_calc_agendaExecute(), pha_mat_spt_agendaExecute(), pnd_agenda_arrayExecute(), ppath_agendaExecute(), ppath_step_agendaExecute(), propmat_clearsky_agendaExecute(), refr_index_air_agendaExecute(), sensor_response_agendaExecute(), spt_calc_agendaExecute(), surface_rtprop_agenda_arrayExecute(), surface_rtprop_agendaExecute(), water_p_eq_agendaExecute(), write_agenda_wrapper_header(), and ybatch_calc_agendaExecute().

Friends And Related Symbol Documentation

operator<<

ostream & operator<< ( ostream &  os, const AgRecord &  agr  )

friend

Output operator for AgRecord.

Parameters

os	Output stream.
agr	Agenda record.

Returns

Output stream.

Definition at line 182 of file agenda_record.cc.

Member Data Documentation

mdescription

String AgRecord::mdescription

private

A text string describing this agenda.

Definition at line 54 of file agenda_record.h.

Referenced by AgRecord(), and Description().

minput

ArrayOfIndex AgRecord::minput

private

Workspace Input.

Definition at line 60 of file agenda_record.h.

Referenced by AgRecord(), and In().

mname

String AgRecord::mname

private

The name of this agenda.

Definition at line 51 of file agenda_record.h.

Referenced by AgRecord(), and Name().

moutput

ArrayOfIndex AgRecord::moutput

private

Workspace Output.

Definition at line 57 of file agenda_record.h.

Referenced by AgRecord(), and Out().

---

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

• agenda_record.h
• agenda_record.cc