ARTS 2.5.0 (git: 9ee3ac6c)
Parameters Class Reference

Structure to hold all command line Parameters. More...

#include <parameters.h>

Public Member Functions

 Parameters ()
 Default constructor. More...
 

Public Attributes

String usage
 Short message how to call the program. More...
 
String helptext
 Longer message explaining the options. More...
 
bool help
 Only display the help text. More...
 
bool version
 Display version information. More...
 
String basename
 If this is specified (with the -b –basename option), it is used as the base name for the report file and for other output files. More...
 
String outdir
 If this is specified (with the -o –outdir option), it is used as the base directory for the report file and for other output files. More...
 
ArrayOfString controlfiles
 The filenames of the controlfiles. More...
 
Index reporting
 This should be a two digit integer. More...
 
String methods
 If this is given the argument ‘all’, it simply prints a list of all methods. More...
 
Index numthreads
 The maximum number of threads to use. More...
 
ArrayOfString includepath
 List of paths to search for include files. More...
 
ArrayOfString datapath
 List of paths to search for data files. More...
 
String input
 This is complementary to the methods switch. More...
 
String workspacevariables
 If this is given the argument ‘all’, it simply prints a list of all workspace variables. More...
 
String describe
 Print the description String of the given workspace variable or method. More...
 
bool groups
 Print a list of all workspace variable groups. More...
 
bool plain
 Generate plain help out suitable for script processing. More...
 
Index docserver
 Port to use for the docserver. More...
 
String baseurl
 Baseurl for the docserver. More...
 
bool daemon
 Flag to run the docserver in the background. More...
 
bool gui
 Flag to run with graphical user interface. More...
 
bool check_docs
 Flag to check built-in documentation. More...
 

Detailed Description

Structure to hold all command line Parameters.

This holds all the command line parameters, plut the usage message and the helptext message. The messages are in the same structure, because they need to be changed whenever the parameters are changed, so it is better to have them in the same place.

Author
SAB

Definition at line 42 of file parameters.h.

Constructor & Destructor Documentation

◆ Parameters()

Parameters::Parameters ( )
inline

Default constructor.

Care has to be taken to properly initialize all variables, e.g., bool options to false.

Definition at line 46 of file parameters.h.

Member Data Documentation

◆ basename

String Parameters::basename

If this is specified (with the -b –basename option), it is used as the base name for the report file and for other output files.

Definition at line 82 of file parameters.h.

Referenced by get_parameters(), and main().

◆ baseurl

String Parameters::baseurl

Baseurl for the docserver.

Definition at line 127 of file parameters.h.

Referenced by get_parameters(), and main().

◆ check_docs

bool Parameters::check_docs

Flag to check built-in documentation.

Definition at line 133 of file parameters.h.

Referenced by get_parameters(), and main().

◆ controlfiles

ArrayOfString Parameters::controlfiles

The filenames of the controlfiles.

Can be only one or as many as you want.

Definition at line 90 of file parameters.h.

Referenced by get_parameters(), and main().

◆ daemon

bool Parameters::daemon

Flag to run the docserver in the background.

Definition at line 129 of file parameters.h.

Referenced by get_parameters(), and main().

◆ datapath

ArrayOfString Parameters::datapath

List of paths to search for data files.

Definition at line 108 of file parameters.h.

Referenced by data_path_pop(), data_path_push(), find_xml_file(), find_xml_file_existence(), get_parameters(), main(), open_input_file(), and ArtsParser::parse_agenda().

◆ describe

String Parameters::describe

Print the description String of the given workspace variable or method.

Definition at line 119 of file parameters.h.

Referenced by get_parameters(), and main().

◆ docserver

Index Parameters::docserver

Port to use for the docserver.

Definition at line 125 of file parameters.h.

Referenced by get_parameters(), and main().

◆ groups

bool Parameters::groups

Print a list of all workspace variable groups.

Definition at line 121 of file parameters.h.

Referenced by get_parameters(), and main().

◆ gui

bool Parameters::gui

Flag to run with graphical user interface.

Definition at line 131 of file parameters.h.

Referenced by get_parameters().

◆ help

bool Parameters::help

Only display the help text.

Definition at line 76 of file parameters.h.

Referenced by get_parameters(), and main().

◆ helptext

String Parameters::helptext

Longer message explaining the options.

Definition at line 74 of file parameters.h.

Referenced by get_parameters(), and main().

◆ includepath

ArrayOfString Parameters::includepath

List of paths to search for include files.

Definition at line 106 of file parameters.h.

Referenced by find_xml_file(), find_xml_file_existence(), get_parameters(), include_path_pop(), include_path_push(), main(), open_input_file(), and ArtsParser::parse_agenda().

◆ input

String Parameters::input

This is complementary to the methods switch.

It must be given the name of a variable (or group). Then it lists all methods that take this variable (or group) as input.

Definition at line 112 of file parameters.h.

Referenced by get_parameters(), and main().

◆ methods

String Parameters::methods

If this is given the argument ‘all’, it simply prints a list of all methods.

If it is given the name of a variable (or group), it prints all methods that produce this variable (or group) as output.

Definition at line 102 of file parameters.h.

Referenced by get_parameters(), and main().

◆ numthreads

Index Parameters::numthreads

The maximum number of threads to use.

Definition at line 104 of file parameters.h.

Referenced by get_parameters(), and main().

◆ outdir

String Parameters::outdir

If this is specified (with the -o –outdir option), it is used as the base directory for the report file and for other output files.

If a full path is given for an output file it will not be affected by this.

Definition at line 87 of file parameters.h.

Referenced by add_basedir(), and get_parameters().

◆ plain

bool Parameters::plain

Generate plain help out suitable for script processing.

Definition at line 123 of file parameters.h.

Referenced by get_parameters(), main(), option_methods(), and option_workspacevariables().

◆ reporting

Index Parameters::reporting

This should be a two digit integer.

The first digit specifies the output level for stdout (stderr for error messages), the second digit the output level for the report file. The levels can reach from 0 (show only error messages) to 3 (show everything). Example:

03 = only errors to the screen, everything to the file.

Definition at line 98 of file parameters.h.

Referenced by get_parameters(), and main().

◆ usage

String Parameters::usage

Short message how to call the program.

Definition at line 72 of file parameters.h.

Referenced by get_parameters(), and main().

◆ version

bool Parameters::version

Display version information.

Definition at line 78 of file parameters.h.

Referenced by get_parameters(), and main().

◆ workspacevariables

String Parameters::workspacevariables

If this is given the argument ‘all’, it simply prints a list of all workspace variables.

If it is given the name of a method, it prints all variables needed by that method.

Definition at line 116 of file parameters.h.

Referenced by get_parameters(), and main().


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