ARTS  2.4.0(git:4fb77825)
parameters.cc File Reference

This file contains the function get_parameters, which reads command line parameters. More...

#include <cstdio>
#include <cstdlib>
#include <iostream>
#include "arts.h"
#include <arts_getopt.h>
#include "file.h"
#include "parameters.h"

Go to the source code of this file.

Functions

void parse_path_from_environment (String envvar, ArrayOfString &paths)
 Parse path environment variable. More...
 
bool get_parameters (int argc, char **argv)
 Get the command line parameters. More...
 

Variables

Parameters parameters
 Holds the command line parameters. More...
 

Detailed Description

This file contains the function get_parameters, which reads command line parameters.

Standard GNU functions are used for this.

Author
Stefan Buehler
Date
2001-07-24

Definition in file parameters.cc.

Function Documentation

◆ get_parameters()

bool get_parameters ( int  argc,
char **  argv 
)

Get the command line parameters.

They are stored in the global variable parameters which is a structure of type Parameters. If needed, this variable should be declared like this:

extern const Parameters parameters

Returns
false=ok, true=error
Parameters
argcNumber of command line parameters
argvValues of command line parameters
Author
Stefan Buehler
Version
1

Definition at line 71 of file parameters.cc.

References Parameters::helptext, option::name, no_argument, optional_argument, parameters, required_argument, and Parameters::usage.

Referenced by main().

◆ parse_path_from_environment()

void parse_path_from_environment ( String  envvar,
ArrayOfString paths 
)

Parse path environment variable.

Parse a colon separated list of paths from the given environment variable into an ArrayOfString.

Parameters
[in]envvarName of environment variable.
[out]pathsArrayOfString of paths.
Author
Oliver Lemke

Definition at line 53 of file parameters.cc.

References my_basic_string< char >::npos.

Variable Documentation

◆ parameters