wsv_aux.h File Reference

Auxiliary header stuff related to workspace variable groups. More...

#include "arts.h"
#include "array.h"
#include "exceptions.h"

Include dependency graph for wsv_aux.h:

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

Go to the source code of this file.

Classes
class	WsvRecord
	This class contains all static information for one workspace variable. More...
Functions
void	get_wsv_group_ids (ArrayOfIndex &ids, String name)
Index	get_wsv_group_id (const String &name)
String	get_array_groups_as_string ()
ostream &	operator<< (ostream &os, const WsvRecord &wr)
	Output operator for WsvRecord.
template<typename OutputStream, typename Container>
void	PrintWsvNames (OutputStream &outstream, const Container &container)
	Print list of WSV names to output stream.

---

Detailed Description

Auxiliary header stuff related to workspace variable groups.

Normally you should not need to edit this file.

Author:

Stefan Buehler

Date:

2000-06-10

Definition in file wsv_aux.h.

---

Function Documentation

String get_array_groups_as_string

(

)

Definition at line 201 of file groups.cc.

References Array< base >::nelem().

Referenced by define_md_data_raw().

Index get_wsv_group_id

(

const String &

name

)

Definition at line 192 of file groups.cc.

References WsvGroupMap.

Referenced by check_agenda_data(), define_valid_keyword_groups(), expand_md_data_raw_to_md_data(), get_wsv_group_ids(), main(), MdRecord::MdRecord(), operator<<(), option_input(), option_methods(), ArtsParser::parse_generic_input(), ArtsParser::parse_generic_output(), ArtsParser::read_name_or_value(), ArtsParser::set_gin_to_default(), MdRecord::subst_any_with_group(), MdRecord::subst_any_with_specific_group(), ArtsParser::tasklist_insert_set_delete(), write_method_header(), write_method_header_documentation(), and WsvRecord::WsvRecord().

void get_wsv_group_ids	(	ArrayOfIndex &	ids,
		String	name
	)

Definition at line 154 of file groups.cc.

References get_wsv_group_id(), my_basic_string< charT >::nelem(), and WsvGroupMap.

Referenced by MdRecord::MdRecord().

ostream& operator<<	(	ostream &	os,
		const WsvRecord &	wr
	)

Output operator for WsvRecord.

Author:

Stefan Buehler

This has to be here rather than with workspace.cc or workspace_aux.cc, because it uses agenda_data and AgendaMap.

Parameters:

	os	Output stream.
	wr	Workspace variable record.

Returns:

Output stream.

Definition at line 236 of file agenda_record.cc.

References agenda_data, AgendaMap, WsvRecord::Description(), get_wsv_group_id(), WsvRecord::Group(), WsvRecord::Name(), and wsv_group_names.

template<typename OutputStream, typename Container>

void PrintWsvNames	(	OutputStream &	outstream,
		const Container &	container
	)			[inline]

Print list of WSV names to output stream.

Runs through the list of WSV indexes and print all names to the given output stream. The list of indexes can be any STL container such as Array, vector...

Parameters:

	outstream	OutputStream
	container	List of WSV indexes

Definition at line 126 of file wsv_aux.h.

References PrintWsvName().

Referenced by Agenda::set_outputs_to_push_and_dup().