bmw_commandline_parser::bmw_commandline_parser_class Interface Reference

Base class containing a parsed bmw_commandline. More...

Public Member Functions
procedure, pass	get_string (this, arg)
	Get the value of an argument as a string.
procedure, pass	get_integer (this, arg, default_value)
	Get the value of an argument as an integer.
procedure, pass	get_real (this, arg, default_value)
	Get the value of an argument as a Real.
GENERIC	get get_string, get_integer, get_real
procedure, pass	is_flag_set (this, arg)
	Check if a command line argument was set.
procedure, pass	flag_requires_value (this, index)
	Check if a command line argument requires a value.
procedure, pass	check_arg (this, arg)
	Check if a command line argument is valid.
FINAL	bmw_commandline_parser_destruct (this)
	Deconstruct a bmw_commandline_parser_class object.
class(bmw_commandline_parser_class) function, pointer	bmw_commandline_parser_construct (parallel)
	Construct a bmw_commandline_parser_class object.

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]

parallel

bmw_parallel_context_class object instance.

Returns

A pointer to a constructed bmw_commandline_parser_class object.

bmw_commandline_parser_destruct()

FINAL bmw_commandline_parser::bmw_commandline_parser_class::bmw_commandline_parser_destruct ( type (bmw_commandline_parser_class), intent(inout)  this )

final

Deconstruct a bmw_commandline_parser_class object.

Deallocates memory and uninitializes a bmw_commandline_parser_class object.

Parameters

[in,out]

this

A bmw_commandline_parser_class instance.

check_arg()

procedure, pass bmw_commandline_parser::bmw_commandline_parser_class::check_arg	(	class (bmw_commandline_parser_class), intent(in)	this,
		character (len=*), intent(in)	arg
	)

Check if a command line argument is valid.

Valid commands are

• -h
• -mgridf
• -woutf
• -wvacf
• -siestaf
• -outf
• -logf
• -jv
• -ju
• -p_start
• -p_end
• -para
• -force
• -num_r
• -num_p
• -num_z
• -rmax
• -rmin
• -zmax
• -zmin

Parameters

[in]	this	A bmw_commandline_parser_class instance.
[in]	arg	A command line argument to check.

Returns

The argument if it's valid.

flag_requires_value()

procedure, pass bmw_commandline_parser::bmw_commandline_parser_class::flag_requires_value	(	class (bmw_commandline_parser_class), intent(in)	this,
		integer, intent(in)	index
	)

Check if a command line argument requires a value.

Command line arguments for

• -mgridf
• -woutf
• -wvacf
• -siestaf
• -outf
• -logf

require a value to be set.

Parameters

[in]	this	A bmw_commandline_parser_class instance.
[in]	index	A argument string to search for.

Returns

True if the argument has a value.

get_integer()

procedure, pass bmw_commandline_parser::bmw_commandline_parser_class::get_integer	(	class (bmw_commandline_parser_class), intent(in)	this,
		character (len=*), intent(in)	arg,
		integer, intent(in)	default_value
	)

Get the value of an argument as an integer.

Searches the parsed command line flags for a matching command like argument. If no matching argument is found, no value was set or the value cannot be converted to an integer, the default value is returned. Command line arguments take the form of -flag.

Parameters

[in]	this	A bmw_commandline_parser_class instance.
[in]	arg	A argument string to search for.
[in]	default_value	Default value in case flag is not set.

Returns

The argument value.

get_real()

procedure, pass bmw_commandline_parser::bmw_commandline_parser_class::get_real	(	class (bmw_commandline_parser_class), intent(in)	this,
		character (len=*), intent(in)	arg,
		real (rprec), intent(in)	default_value
	)

Get the value of an argument as a Real.

Searches the parsed command line flags for a matching command like argument. If no matching argument is found, no value was set or the value cannot be converted to an integer, the default value is returned. Command line arguments take the form of -flag.

Parameters

[in]	this	A bmw_commandline_parser_class instance.
[in]	arg	A argument string to search for.
[in]	default_value	Default value in case flag is not set.

Returns

The argument value.

get_string()

procedure, pass bmw_commandline_parser::bmw_commandline_parser_class::get_string	(	class (bmw_commandline_parser_class), intent(in)	this,
		character (len=*), intent(in)	arg
	)

Get the value of an argument as a string.

Searches the parsed command line flags for a matching command like argument. If no matching argument is found or no value was set, a blank string is returned. command line arguments take the form of -flag.

Parameters

[in]	this	A bmw_commandline_parser_class instance.
[in]	arg	A argument string to search for.

Returns

The argument value.

is_flag_set()

procedure, pass bmw_commandline_parser::bmw_commandline_parser_class::is_flag_set	(	class (bmw_commandline_parser_class), intent(in)	this,
		character (len=*), intent(in)	arg
	)

Check if a command line argument was set.

Searches the parsed command line flags for a matching command line argument. If no matching argument is found the flag was not set.

Parameters

[in]	this	A bmw_commandline_parser_class instance.
[in]	arg	A argument string to search for.

Returns

True if the argument was found, false if it was not found.

---

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

• BMW/Sources/bmw_commandline_parser.f