Parameters Class Reference
Structure to hold all command line Parameters. More...
#include <parameters.h>
Public Member Functions | |
| Parameters () | |
| Default constructor. | |
Public Attributes | |
| String | usage |
| Short message how to call the program. | |
| String | helptext |
| Longer message explaining the options. | |
| bool | help |
| Only display the help text. | |
| bool | version |
| Display version information. | |
| 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. | |
| ArrayOfString | controlfiles |
| The filenames of the controlfiles. | |
| Index | reporting |
| This should be a two digit integer. | |
| String | methods |
| If this is given the argument `all', it simply prints a list of all methods. | |
| Index | numthreads |
| The maximum number of threads to use. | |
| ArrayOfString | includepath |
| List of paths to search for include files. | |
| String | input |
| This is complementary to the methods switch. | |
| String | workspacevariables |
| If this is given the argument `all', it simply prints a list of all workspace variables. | |
| String | describe |
| Print the description String of the given workspace variable or method. | |
| bool | groups |
| Print a list of all workspace variable groups. | |
| bool | plain |
| Generate plain help out suitable for script processing. | |
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.
Definition at line 42 of file parameters.h.
Constructor & Destructor Documentation
| 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
Short message how to call the program.
Definition at line 64 of file parameters.h.
Referenced by get_parameters(), and main().
Longer message explaining the options.
Definition at line 66 of file parameters.h.
Referenced by get_parameters(), and main().
| bool Parameters::help |
Only display the help text.
Definition at line 68 of file parameters.h.
Referenced by get_parameters(), and main().
| bool Parameters::version |
Display version information.
Definition at line 70 of file parameters.h.
Referenced by get_parameters(), and main().
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 74 of file parameters.h.
Referenced by get_parameters(), and main().
The filenames of the controlfiles.
Can be only one or as many as you want.
Definition at line 77 of file parameters.h.
Referenced by get_parameters(), and main().
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 85 of file parameters.h.
Referenced by get_parameters(), and main().
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 89 of file parameters.h.
Referenced by get_parameters(), and main().
The maximum number of threads to use.
Definition at line 91 of file parameters.h.
Referenced by get_parameters(), and main().
List of paths to search for include files.
Definition at line 93 of file parameters.h.
Referenced by find_file(), get_parameters(), and ArtsParser::parse_agenda().
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 97 of file parameters.h.
Referenced by get_parameters(), and main().
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 101 of file parameters.h.
Referenced by get_parameters(), and main().
Print the description String of the given workspace variable or method.
Definition at line 104 of file parameters.h.
Referenced by get_parameters(), and main().
| bool Parameters::groups |
Print a list of all workspace variable groups.
Definition at line 106 of file parameters.h.
Referenced by get_parameters(), and main().
| bool Parameters::plain |
Generate plain help out suitable for script processing.
Definition at line 108 of file parameters.h.
Referenced by get_parameters(), main(), option_methods(), and option_workspacevariables().
The documentation for this class was generated from the following file:
