ARTS 2.5.4 (git: bcd8c674)
parameters.h
Go to the documentation of this file.
1/* Copyright (C) 2000-2012 Stefan Buehler <sbuehler@ltu.se>
2
3 This program is free software; you can redistribute it and/or modify it
4 under the terms of the GNU General Public License as published by the
5 Free Software Foundation; either version 2, or (at your option) any
6 later version.
7
8 This program is distributed in the hope that it will be useful,
9 but WITHOUT ANY WARRANTY; without even the implied warranty of
10 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 GNU General Public License for more details.
12
13 You should have received a copy of the GNU General Public License
14 along with this program; if not, write to the Free Software
15 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
16 USA. */
17
28#ifndef parameters_h
29#define parameters_h
30
31#include "array.h"
32#include "mystring.h"
33
43 public:
47 : usage(),
48 helptext(),
49 help(false),
50 version(false),
51 basename(""),
52 outdir(""),
54 reporting(-1),
55 methods(""),
56 numthreads(0),
58 datapath(),
59 input(""),
61 describe(""),
62 groups(false),
63 plain(false),
64 docserver(0),
65 baseurl(""),
66 daemon(false),
67 gui(false),
68 check_docs(false) { /* Nothing to be done here */
69 }
70
76 bool help;
78 bool version;
121 bool groups;
123 bool plain;
129 bool daemon;
131 bool gui;
134};
135
149bool get_parameters(int argc, char **argv);
150
151#endif // parameters_h
This file contains the definition of Array.
Structure to hold all command line Parameters.
Definition: parameters.h:42
bool check_docs
Flag to check built-in documentation.
Definition: parameters.h:133
ArrayOfString includepath
List of paths to search for include files.
Definition: parameters.h:106
String helptext
Longer message explaining the options.
Definition: parameters.h:74
String outdir
If this is specified (with the -o –outdir option), it is used as the base directory for the report fi...
Definition: parameters.h:87
bool gui
Flag to run with graphical user interface.
Definition: parameters.h:131
String usage
Short message how to call the program.
Definition: parameters.h:72
bool version
Display version information.
Definition: parameters.h:78
ArrayOfString datapath
List of paths to search for data files.
Definition: parameters.h:108
String workspacevariables
If this is given the argument ‘all’, it simply prints a list of all workspace variables.
Definition: parameters.h:116
String baseurl
Baseurl for the docserver.
Definition: parameters.h:127
String input
This is complementary to the methods switch.
Definition: parameters.h:112
ArrayOfString controlfiles
The filenames of the controlfiles.
Definition: parameters.h:90
bool plain
Generate plain help out suitable for script processing.
Definition: parameters.h:123
String basename
If this is specified (with the -b –basename option), it is used as the base name for the report file ...
Definition: parameters.h:82
bool groups
Print a list of all workspace variable groups.
Definition: parameters.h:121
bool help
Only display the help text.
Definition: parameters.h:76
Index reporting
This should be a two digit integer.
Definition: parameters.h:98
Index numthreads
The maximum number of threads to use.
Definition: parameters.h:104
Index docserver
Port to use for the docserver.
Definition: parameters.h:125
bool daemon
Flag to run the docserver in the background.
Definition: parameters.h:129
String describe
Print the description String of the given workspace variable or method.
Definition: parameters.h:119
Parameters()
Default constructor.
Definition: parameters.h:46
String methods
If this is given the argument ‘all’, it simply prints a list of all methods.
Definition: parameters.h:102
INDEX Index
The type to use for all integer numbers and indices.
Definition: matpack.h:39
This file contains the definition of String, the ARTS string class.
bool get_parameters(int argc, char **argv)
Get the command line parameters.
Definition: parameters.cc:71