mod_config Module Reference

Module that allows working with a configuration file. More...

Data Types
type	cfg_t
	The configuration that contains all the variables. More...
interface	cfg_add
	Interface to add variables to the configuration. More...
interface	cfg_get
	Interface to get variables from the configuration. More...
interface	cfg_add_get
	Interface to get variables from the configuration. More...

Functions/Subroutines
subroutine, public	cfg_update_from_arguments (cfg)
subroutine, public	cfg_read_file (cfg, filename)
	Update the variables in the configartion with the values found in 'filename'.
subroutine, public	cfg_check (cfg)
subroutine, public	cfg_write (cfg_in, filename, hide_unused)
	This routine writes the current configuration to a file with descriptions.
subroutine, public	cfg_write_markdown (cfg_in, filename, hide_unused)
	This routine writes the current configuration to a markdown file.
subroutine, public	cfg_get_size (cfg, var_name, res)
	Get the size of a variable.
subroutine, public	cfg_get_type (cfg, var_name, res)
	Get the type of a given variable of a configuration type.
subroutine, public	cfg_sort (cfg)
	Sort the variables for faster lookup.

Variables
integer, parameter, public	cfg_integer_type = 1
	Integer type.
integer, parameter, public	cfg_real_type = 2
	Real number type.
integer, parameter, public	cfg_string_type = 3
	String type.
integer, parameter, public	cfg_logic_type = 4
	Boolean/logical type.
integer, parameter, public	cfg_name_len = 80
	Maximum length of variable names.
integer, parameter, public	cfg_string_len = 200
	Fixed length of string type.
character(len=10), dimension(0:cfg_num_types), parameter, public	cfg_type_names = [character(len=10) :: "storage", "integer", "real", "string ", "logical"]
	Names of the types.
integer, parameter, public	cfg_max_array_size = 20
	Maximum number of entries in a variable (if it's an array).

Detailed Description

Module that allows working with a configuration file.

Function/Subroutine Documentation

cfg_check()

subroutine, public mod_config::cfg_check

(

type(cfg_t), intent(in)

cfg

)

Definition at line 319 of file mod_config.t.

cfg_get_size()

subroutine, public mod_config::cfg_get_size	(	type(cfg_t), intent(in)	cfg,
		character(len=*), intent(in)	var_name,
		integer, intent(out)	res )

Get the size of a variable.

Definition at line 967 of file mod_config.t.

cfg_get_type()

subroutine, public mod_config::cfg_get_type	(	type(cfg_t), intent(in)	cfg,
		character(len=*), intent(in)	var_name,
		integer, intent(out)	res )

Get the type of a given variable of a configuration type.

Definition at line 983 of file mod_config.t.

cfg_read_file()

subroutine, public mod_config::cfg_read_file	(	type(cfg_t), intent(inout)	cfg,
		character(len=*), intent(in)	filename )

Update the variables in the configartion with the values found in 'filename'.

Definition at line 165 of file mod_config.t.

cfg_sort()

subroutine, public mod_config::cfg_sort

(

type(cfg_t), intent(inout)

cfg

)

Sort the variables for faster lookup.

Definition at line 1097 of file mod_config.t.

cfg_update_from_arguments()

subroutine, public mod_config::cfg_update_from_arguments

(

type(cfg_t), intent(inout)

cfg

)

Definition at line 118 of file mod_config.t.

Here is the call graph for this function:

cfg_write()

subroutine, public mod_config::cfg_write	(	type(cfg_t), intent(in)	cfg_in,
		character(len=*), intent(in)	filename,
		logical, intent(in), optional	hide_unused )

This routine writes the current configuration to a file with descriptions.

Definition at line 334 of file mod_config.t.

Here is the call graph for this function:

cfg_write_markdown()

subroutine, public mod_config::cfg_write_markdown	(	type(cfg_t), intent(in)	cfg_in,
		character(len=*), intent(in)	filename,
		logical, intent(in), optional	hide_unused )

This routine writes the current configuration to a markdown file.

Definition at line 434 of file mod_config.t.

Here is the call graph for this function:

Variable Documentation

cfg_integer_type

integer, parameter, public mod_config::cfg_integer_type = 1

Integer type.

Definition at line 11 of file mod_config.t.

cfg_logic_type

integer, parameter, public mod_config::cfg_logic_type = 4

Boolean/logical type.

Definition at line 14 of file mod_config.t.

cfg_max_array_size

integer, parameter, public mod_config::cfg_max_array_size = 20

Maximum number of entries in a variable (if it's an array).

Definition at line 25 of file mod_config.t.

cfg_name_len

integer, parameter, public mod_config::cfg_name_len = 80

Maximum length of variable names.

Definition at line 17 of file mod_config.t.

cfg_real_type

integer, parameter, public mod_config::cfg_real_type = 2

Real number type.

Definition at line 12 of file mod_config.t.

cfg_string_len

integer, parameter, public mod_config::cfg_string_len = 200

Fixed length of string type.

Definition at line 18 of file mod_config.t.

cfg_string_type

integer, parameter, public mod_config::cfg_string_type = 3

String type.

Definition at line 13 of file mod_config.t.

cfg_type_names

character(len=10), dimension(0:cfg_num_types), parameter, public mod_config::cfg_type_names = [character(len=10) :: "storage", "integer", "real", "string ", "logical"]

Names of the types.

Definition at line 21 of file mod_config.t.