ARTS  1.0.222
parameters.h
Go to the documentation of this file.
1 /* Copyright (C) 2000, 2001 Stefan Buehler <sbuehler@uni-bremen.de>
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 
42 struct Parameters {
46  help(false),
47  version(false),
48  basename(""),
49  controlfiles(),
50  reporting(-1),
51  methods(""),
52  input(""),
54  describe(""),
55  groups(false)
56  { /* Nothing to be done here */ }
62  bool help;
64  bool version;
96  bool groups;
97 };
98 
99 
113 bool get_parameters(int argc, char **argv);
114 
115 
116 #endif // parameters_h
get_parameters
bool get_parameters(int argc, char **argv)
Get the command line parameters.
Definition: parameters.cc:36
Parameters::input
String input
This is complementary to the methods switch.
Definition: parameters.h:87
Parameters::reporting
Index reporting
This should be a two digit integer.
Definition: parameters.h:79
Parameters::describe
String describe
Print the description String of the given workspace variable or method.
Definition: parameters.h:94
Parameters::groups
bool groups
Print a list of all workspace variable groups.
Definition: parameters.h:96
Parameters::methods
String methods
If this is given the argument ‘all’, it simply prints a list of all methods.
Definition: parameters.h:83
Parameters::helptext
String helptext
Longer message explaining the options.
Definition: parameters.h:60
Parameters::Parameters
Parameters()
Default constructor.
Definition: parameters.h:45
array.h
This file contains the definition of Array.
Parameters::controlfiles
ArrayOfString controlfiles
The filenames of the controlfiles.
Definition: parameters.h:71
Array< String >
Parameters::basename
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:68
my_basic_string< char >
Index
INDEX Index
The type to use for all integer numbers and indices.
Definition: arts.h:153
Parameters
Structure to hold all command line Parameters.
Definition: parameters.h:42
Parameters::version
bool version
Display version information.
Definition: parameters.h:64
Parameters::usage
String usage
Short message how to call the program.
Definition: parameters.h:58
Parameters::workspacevariables
String workspacevariables
If this is given the argument ‘all’, it simply prints a list of all workspace variables.
Definition: parameters.h:91
Parameters::help
bool help
Only display the help text.
Definition: parameters.h:62
mystring.h
This file contains the definition of String, the ARTS string class.