arts.h File Reference

The global header file for ARTS. More...

#include <cstddef>
#include <cstdlib>
#include "debug.h"
#include "mystring.h"
#include "config.h"

Go to the source code of this file.

Functions
void	define_wsv_groups ()
	Define the array of workspace variable group names.
bool	is_valid_keyword_group (const Index name)
void	arts_exit (int status=EXIT_FAILURE)
	This is the exit function of ARTS.
void	arts_exit_with_error_message (const String &m, ArtsOut &os)
	Print error message and exit.
std::string_view	arts_get_version_string ()

Detailed Description

The global header file for ARTS.

This file is included directly or indirectly by each and every ARTS source file. It must therefor not contain stuff that should not always be present.

Note that you do not have to include this file explicitly in many cases, since it is included directly or indirectly by most ARTS header files.

Author

Stefan Buehler

Date

16.05.1999

Definition in file arts.h.

Function Documentation

arts_exit()

void arts_exit

(

int

status

)

This is the exit function of ARTS.

Whenever arts has to be terminated at some point, call this function.

You can call without any parameters, since the exit status then defaults to EXIT_FAILURE.

Parameters

status

Exit code. EXIT_FAILURE if omitted.

Definition at line 25 of file arts.cc.

References add_basedir(), cleanup_output_file(), out_basename, and report_file.

Referenced by arts_exit_with_error_message(), Exit(), get_parameters(), interp_poly(), main(), option_describe(), option_input(), option_methods(), option_workspacevariables(), polite_goodby(), set_reporting_level(), and VectorInsertGridPoints().

arts_exit_with_error_message()

void arts_exit_with_error_message	(	const String &	m,
		ArtsOut &	out
	)

Print error message and exit.

This function is intended for use in catch blocks.

Parameters

m	Error message.
m	ArtsOut stream to use.

Author

Stefan Buehler

Date

2008-05-09

Definition at line 47 of file arts.cc.

References add_basedir(), arts_exit(), Verbosity::get_file_verbosity(), Verbosity::get_screen_verbosity(), ArtsOut::get_verbosity(), and out_basename.

Referenced by Arts(), Arts2(), and main().

arts_get_version_string()

std::string_view arts_get_version_string

(

)

Definition at line 4 of file auto_version.cc.

Referenced by main().

define_wsv_groups()

void define_wsv_groups

(

)

Define the array of workspace variable group names.

This defines the global variable wsv_groups. It is used in two different programs:

1. In arts.
2. In make_wsv_group_h.

Author

Stefan Buehler

Date

2000-08-04

Definition at line 47 of file groups.cc.

References global_data::wsv_groups.

Referenced by main(), and main().

is_valid_keyword_group()

bool is_valid_keyword_group

(

const Index

name

)