arts.h File Reference

The global header file for ARTS. More...

#include <cstddef>
#include <cstdlib>
#include "matpack.h"
#include "mystring.h"
#include <cassert>

Include dependency graph for arts.h:

Go to the source code of this file.

Defines

#define DEBUG_ONLY(...)   __VA_ARGS__

Functions

void define_wsv_group_names ()
 Define the array of workspace variable group names.
Index get_wsv_id (const String &name)
bool is_valid_keyword_group (const Index name)
void define_species_data ()
void define_lineshape_data ()
void define_lineshape_norm_data ()
void arts_exit (int status=EXIT_FAILURE)
 This is the exit function of ARTS.
void arts_exit_with_error_message (const String &m)
 Print error message and exit.
void exit_or_rethrow (const String &m)
 Exit ARTS or re-throw error.


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.


Define Documentation

#define DEBUG_ONLY ( ...   )     __VA_ARGS__


Function Documentation

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 41 of file arts.cc.

Referenced by arts_exit_with_error_message(), Error(), Exit(), get_parameters(), give_up(), interp_poly(), main(), operator<<(), AgRecord::operator=(), option_describe(), option_input(), option_methods(), option_workspacevariables(), ArtsParser::parse_main(), polite_goodby(), LineRecord::ReadFromHitranStream(), LineRecord::ReadFromMytran2Stream(), set_reporting_level(), and VectorInsertGridPoints().

void arts_exit_with_error_message ( const String m  ) 

Print error message and exit.

This function is intended for use in catch blocks.

Parameters:
m Error message.
Author:
Stefan Buehler
Date:
2008-05-09

Definition at line 55 of file arts.cc.

References arts_exit(), and out0.

Referenced by exit_or_rethrow(), and main().

void define_lineshape_data (  ) 

void define_lineshape_norm_data (  ) 

void define_species_data (  ) 

Definition at line 136 of file species_data.cc.

References define_basic_species_data(), and define_partition_species_data().

Referenced by main().

void define_wsv_group_names (  ) 

Define the array of workspace variable group names.

This defines the global variable wsv_group_names. 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 80 of file groups.cc.

References define_valid_keyword_groups(), and define_wsv_group_map().

Referenced by main().

void exit_or_rethrow ( const String m  ) 

Exit ARTS or re-throw error.

The behavior of this function depends on whether we are compiling with OpenMP or without. With OpenMP, the program is terminated with the error message. Without OpenMP, the runtime_error is re-thrown in order to be handled higher up.

Parameters:
m Error message.
Author:
Stefan Buehler
Date:
2008-05-09

Definition at line 80 of file arts.cc.

References arts_exit_with_error_message().

Referenced by abs_fieldCalc(), abs_lookupCreate(), batch_atm_fields_compactFromArrayOfMatrix(), RteCalc(), RteCalcMC(), xsec_species(), and ybatchCalc_implementation().

Index get_wsv_id ( const String name  ) 

Definition at line 4101 of file workspace.cc.

References Workspace::WsvMap.

Referenced by AgRecord::AgRecord(), and MdRecord::MdRecord().

bool is_valid_keyword_group ( const Index  name  ) 

Definition at line 143 of file groups.cc.

References Array< base >::nelem().


Generated on Mon Mar 23 14:06:30 2009 for ARTS by  doxygen 1.5.6