Stellarator-Tools
bmw_commandline_parser::bmw_commandline_parser_class Interface Reference

Base class containing a parsed bmw_commandline. More...

Public Member Functions

PROCEDURE, pass get_string => bmw_commandline_parser_get_string
 
PROCEDURE, pass get_integer => bmw_commandline_parser_get_integer
 
PROCEDURE, pass get_real => bmw_commandline_parser_get_real
 
GENERIC get => get_string, get_integer, get_real
 
PROCEDURE, pass is_flag_set => bmw_commandline_parser_is_flag_set
 
PROCEDURE, pass flag_requires_value => bmw_commandline_parser_flag_requires_value
 
PROCEDURE, pass check_arg => bmw_commandline_parser_check_arg
 
FINAL bmw_commandline_parser_destruct
 
class(bmw_commandline_parser_class) function, pointer bmw_commandline_parser_construct (parallel)
 Construct a bmw_commandline_parser_class object. More...
 

Public Attributes

character(len=max_length) command
 Command name of current process.
 
character(len=max_arg_length), dimension(:), pointer arg => null()
 Array of arguments. An argument is the form of -flag.
 
character(len=path_length), dimension(:), pointer value => null()
 Array of value corresponding to the flag. A value is everything after the '=' character. The value maybe blank indicating there was no value provided.
 

Detailed Description

Base class containing a parsed bmw_commandline.

Interface for the bmw_commandline_parser constructor.

Member Function/Subroutine Documentation

◆ bmw_commandline_parser_construct()

class (bmw_commandline_parser_class) function, pointer bmw_commandline_parser::bmw_commandline_parser_class::bmw_commandline_parser_construct ( class (bmw_parallel_context_class), intent(in)  parallel)

Construct a bmw_commandline_parser_class object.

Allocates memory and initializes a bmw_commandline_parser_class object. The command line is parsed assuming the the flags take the form of -flag=value. If the '=' is missing, it is assumed there is no value. If -h is found, the help text is printed out and the program terminated.

Parameters
[in]parallelbmw_parallel_context_class object instance.
Returns
A pointer to a constructed bmw_commandline_parser_class object.

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