Collaboration diagram for dictionary::dict_t:

[legend]

Public Member Functions
generic	get_entry (this, skey)
generic	get_entry (this, iindex)
generic	get_next_entry (this, skey)
generic	get_next_entry (this)
generic	add_entry (this, dict_entry)
generic	key_already_in_use (this, skey)
procedure	find_dict_entry_fn (this, ssearchkey)
generic	find_dict_entry (this, ssearchkey)
generic	delete_entry (this, skey)
generic	print_all (this, iloglevel, sdescription, lecho)
generic	grep_keys (this, skey)
procedure, public	get_value (this, stext, skey, iindex, is_fatal)
generic	get_values (this, skey, ivalues, is_fatal)
generic	get_values (this, skey, fvalues, is_fatal)
generic	get_values (this, skey, lvalues, is_fatal)
generic	get_values (this, skey, slstring, is_fatal)
generic	get_values (this, slkeys, ivalues, is_fatal)
	Search through keys for a match; return integer values.
generic	get_values (this, slkeys, fvalues, is_fatal)
	Search through keys for a match; return float values.
generic	get_values (this, slkeys, lvalues, is_fatal)
	Search through keys for a match; return logical values.
generic	get_values (this, slkeys, slstring, is_fatal)

Public Attributes
type(dict_entry_t), pointer	first => null()
type(dict_entry_t), pointer	last => null()
type(dict_entry_t), pointer	current => null()
integer(c_int)	count = 0

Private Member Functions
procedure, private	get_entry_by_key_fn (this, skey)
procedure, private	get_entry_by_index_fn (this, iindex)
procedure, private	get_next_entry_by_key_fn (this, skey)
procedure, private	get_next_entry_fn (this)
procedure, private	add_entry_to_dict_sub (this, dict_entry)
procedure, private	key_name_already_in_use_fn (this, skey)
procedure, private	delete_entry_by_key_sub (this, skey)
procedure, private	print_all_dictionary_entries_sub (this, iloglevel, sdescription, lecho)
procedure, private	grep_dictionary_key_names_fn (this, skey)
procedure, private	get_values_as_int_sub (this, skey, ivalues, is_fatal)
procedure, private	get_values_as_float_sub (this, skey, fvalues, is_fatal)
procedure, private	get_values_as_logical_sub (this, skey, lvalues, is_fatal)
procedure, private	get_values_as_string_list_sub (this, skey, slstring, is_fatal)
procedure, private	get_values_as_int_given_list_of_keys_sub (this, slkeys, ivalues, is_fatal)
	Search through keys for a match; return integer values.
procedure, private	get_values_as_float_given_list_of_keys_sub (this, slkeys, fvalues, is_fatal)
	Search through keys for a match; return float values.
procedure, private	get_values_as_logical_given_list_of_keys_sub (this, slkeys, lvalues, is_fatal)
	Search through keys for a match; return logical values.
procedure, private	get_values_as_string_list_given_list_of_keys_sub (this, slkeys, slstring, is_fatal)

Detailed Description

Definition at line 41 of file dictionary.F90.

Member Function/Subroutine Documentation

◆ add_entry()

generic dictionary::dict_t::add_entry	(	class (dict_t)	this,
		type (dict_entry_t), pointer	dict_entry )

Definition at line 61 of file dictionary.F90.

Here is the call graph for this function:

◆ add_entry_to_dict_sub()

procedure, private dictionary::dict_t::add_entry_to_dict_sub	(	class (dict_t)	this,
		type (dict_entry_t), pointer	dict_entry )

private

Definition at line 60 of file dictionary.F90.

◆ delete_entry()

generic dictionary::dict_t::delete_entry	(	class (dict_t)	this,
		character (len=*), intent(in)	skey )

Definition at line 70 of file dictionary.F90.

Here is the call graph for this function:

◆ delete_entry_by_key_sub()

procedure, private dictionary::dict_t::delete_entry_by_key_sub	(	class (dict_t)	this,
		character (len=*), intent(in)	skey )

private

Definition at line 69 of file dictionary.F90.

◆ find_dict_entry()

generic dictionary::dict_t::find_dict_entry	(	class (dict_t)	this,
		character (len=*), intent(in)	ssearchkey )

Definition at line 67 of file dictionary.F90.

Here is the call graph for this function:

◆ find_dict_entry_fn()

procedure dictionary::dict_t::find_dict_entry_fn	(	class (dict_t)	this,
		character (len=*), intent(in)	ssearchkey )

Definition at line 66 of file dictionary.F90.

◆ get_entry() [1/2]

generic dictionary::dict_t::get_entry	(	class (dict_t)	this,
		integer (c_int), intent(in)	iindex )

Definition at line 52 of file dictionary.F90.

◆ get_entry() [2/2]

generic dictionary::dict_t::get_entry	(	class (dict_t)	this,
		character (len=*), intent(in)	skey )

Definition at line 52 of file dictionary.F90.

Here is the call graph for this function:

◆ get_entry_by_index_fn()

procedure, private dictionary::dict_t::get_entry_by_index_fn	(	class (dict_t)	this,
		integer (c_int), intent(in)	iindex )

private

Definition at line 51 of file dictionary.F90.

◆ get_entry_by_key_fn()

procedure, private dictionary::dict_t::get_entry_by_key_fn	(	class (dict_t)	this,
		character (len=*), intent(in)	skey )

private

Definition at line 50 of file dictionary.F90.

◆ get_next_entry() [1/2]

generic dictionary::dict_t::get_next_entry ( class (dict_t) this )

Definition at line 57 of file dictionary.F90.

◆ get_next_entry() [2/2]

generic dictionary::dict_t::get_next_entry	(	class (dict_t)	this,
		character (len=*), intent(in)	skey )

Definition at line 57 of file dictionary.F90.

Here is the call graph for this function:

◆ get_next_entry_by_key_fn()

procedure, private dictionary::dict_t::get_next_entry_by_key_fn	(	class (dict_t)	this,
		character (len=*), intent(in)	skey )

private

Definition at line 55 of file dictionary.F90.

◆ get_next_entry_fn()

procedure, private dictionary::dict_t::get_next_entry_fn ( class (dict_t) this )

private

Definition at line 56 of file dictionary.F90.

◆ get_value()

procedure, public dictionary::dict_t::get_value	(	class (dict_t)	this,
		character(len=:), intent(out), allocatable	stext,
		character (len=*), intent(in), optional	skey,
		integer (c_int), intent(in), optional	iindex,
		logical (c_bool), optional	is_fatal )

Definition at line 78 of file dictionary.F90.

◆ get_values() [1/8]

generic dictionary::dict_t::get_values	(	class (dict_t)	this,
		character (len=*), intent(in)	skey,
		real (c_float), dimension(:), intent(out), allocatable	fvalues,
		logical (c_bool), optional	is_fatal )

Definition at line 88 of file dictionary.F90.

◆ get_values() [2/8]

generic dictionary::dict_t::get_values	(	class (dict_t)	this,
		character (len=*)	skey,
		integer (c_int), dimension(:), intent(out), allocatable	ivalues,
		logical (c_bool), optional	is_fatal )

Definition at line 88 of file dictionary.F90.

Here is the call graph for this function:

◆ get_values() [3/8]

generic dictionary::dict_t::get_values	(	class (dict_t)	this,
		character (len=*)	skey,
		logical (c_bool), dimension(:), intent(out), allocatable	lvalues,
		logical (c_bool), optional	is_fatal )

Definition at line 88 of file dictionary.F90.

◆ get_values() [4/8]

generic dictionary::dict_t::get_values	(	class (dict_t)	this,
		character (len=*), intent(in)	skey,
		type (fstring_list_t), intent(out)	slstring,
		logical (c_bool), optional	is_fatal )

Definition at line 88 of file dictionary.F90.

◆ get_values() [5/8]

generic dictionary::dict_t::get_values	(	class (dict_t)	this,
		type (fstring_list_t)	slkeys,
		real (c_float), dimension(:), intent(out), allocatable	fvalues,
		logical (c_bool), optional	is_fatal )

Search through keys for a match; return float values.

THis routine allows for multiple header values to be supplied in the search for the appropriate column.

Parameters

[in]	this	Object of DICT_T class.
[in]	slKeys	String list containing one or more possible key values to search for.
[out]	fValues	Float vector of values associated with one of the provided keys.

Definition at line 88 of file dictionary.F90.

◆ get_values() [6/8]

generic dictionary::dict_t::get_values	(	class (dict_t)	this,
		type (fstring_list_t)	slkeys,
		integer (c_int), dimension(:), intent(out), allocatable	ivalues,
		logical (c_bool), optional	is_fatal )

Search through keys for a match; return integer values.

THis routine allows for multiple header values to be supplied in the search for the appropriate column.

Parameters

[in]	this	Object of DICT_T class.
[in]	slKeys	String list containing one or more possible key values to search for.
[out]	iValues	Integer vector of values associated with one of the provided keys.

Definition at line 88 of file dictionary.F90.

◆ get_values() [7/8]

generic dictionary::dict_t::get_values	(	class (dict_t)	this,
		type (fstring_list_t)	slkeys,
		logical (c_bool), dimension(:), intent(out), allocatable	lvalues,
		logical (c_bool), optional	is_fatal )

Search through keys for a match; return logical values.

THis routine allows for multiple header values to be supplied in the search for the appropriate column.

Parameters

[in]	this	Object of DICT_T class.
[in]	slKeys	String list containing one or more possible key values to search for.
[out]	iValues	Integer vector of values associated with one of the provided keys.

Definition at line 88 of file dictionary.F90.

◆ get_values() [8/8]

generic dictionary::dict_t::get_values	(	class (dict_t)	this,
		type (fstring_list_t)	slkeys,
		type ( fstring_list_t ), intent(out)	slstring,
		logical (c_bool), optional	is_fatal )

Definition at line 88 of file dictionary.F90.

◆ get_values_as_float_given_list_of_keys_sub()

procedure, private dictionary::dict_t::get_values_as_float_given_list_of_keys_sub	(	class (dict_t)	this,
		type (fstring_list_t)	slkeys,
		real (c_float), dimension(:), intent(out), allocatable	fvalues,
		logical (c_bool), optional	is_fatal )

private

Search through keys for a match; return float values.

THis routine allows for multiple header values to be supplied in the search for the appropriate column.

Parameters

[in]	this	Object of DICT_T class.
[in]	slKeys	String list containing one or more possible key values to search for.
[out]	fValues	Float vector of values associated with one of the provided keys.

Definition at line 85 of file dictionary.F90.

◆ get_values_as_float_sub()

procedure, private dictionary::dict_t::get_values_as_float_sub	(	class (dict_t)	this,
		character (len=*), intent(in)	skey,
		real (c_float), dimension(:), intent(out), allocatable	fvalues,
		logical (c_bool), optional	is_fatal )

private

Definition at line 81 of file dictionary.F90.

◆ get_values_as_int_given_list_of_keys_sub()

procedure, private dictionary::dict_t::get_values_as_int_given_list_of_keys_sub	(	class (dict_t)	this,
		type (fstring_list_t)	slkeys,
		integer (c_int), dimension(:), intent(out), allocatable	ivalues,
		logical (c_bool), optional	is_fatal )

private

Search through keys for a match; return integer values.

THis routine allows for multiple header values to be supplied in the search for the appropriate column.

Parameters

[in]	this	Object of DICT_T class.
[in]	slKeys	String list containing one or more possible key values to search for.
[out]	iValues	Integer vector of values associated with one of the provided keys.

Definition at line 84 of file dictionary.F90.

◆ get_values_as_int_sub()

procedure, private dictionary::dict_t::get_values_as_int_sub	(	class (dict_t)	this,
		character (len=*)	skey,
		integer (c_int), dimension(:), intent(out), allocatable	ivalues,
		logical (c_bool), optional	is_fatal )

private

Definition at line 80 of file dictionary.F90.

◆ get_values_as_logical_given_list_of_keys_sub()

procedure, private dictionary::dict_t::get_values_as_logical_given_list_of_keys_sub	(	class (dict_t)	this,
		type (fstring_list_t)	slkeys,
		logical (c_bool), dimension(:), intent(out), allocatable	lvalues,
		logical (c_bool), optional	is_fatal )

private

Search through keys for a match; return logical values.

THis routine allows for multiple header values to be supplied in the search for the appropriate column.

Parameters

[in]	this	Object of DICT_T class.
[in]	slKeys	String list containing one or more possible key values to search for.
[out]	iValues	Integer vector of values associated with one of the provided keys.

Definition at line 86 of file dictionary.F90.

◆ get_values_as_logical_sub()

procedure, private dictionary::dict_t::get_values_as_logical_sub	(	class (dict_t)	this,
		character (len=*)	skey,
		logical (c_bool), dimension(:), intent(out), allocatable	lvalues,
		logical (c_bool), optional	is_fatal )

private

Definition at line 82 of file dictionary.F90.

◆ get_values_as_string_list_given_list_of_keys_sub()

procedure, private dictionary::dict_t::get_values_as_string_list_given_list_of_keys_sub	(	class (dict_t)	this,
		type (fstring_list_t)	slkeys,
		type ( fstring_list_t ), intent(out)	slstring,
		logical (c_bool), optional	is_fatal )

private

Definition at line 87 of file dictionary.F90.

◆ get_values_as_string_list_sub()

procedure, private dictionary::dict_t::get_values_as_string_list_sub	(	class (dict_t)	this,
		character (len=*), intent(in)	skey,
		type (fstring_list_t), intent(out)	slstring,
		logical (c_bool), optional	is_fatal )

private

Definition at line 83 of file dictionary.F90.

◆ grep_dictionary_key_names_fn()

procedure, private dictionary::dict_t::grep_dictionary_key_names_fn	(	class (dict_t)	this,
		character (len=*), intent(in)	skey )

private

Definition at line 75 of file dictionary.F90.

◆ grep_keys()

generic dictionary::dict_t::grep_keys	(	class (dict_t)	this,
		character (len=*), intent(in)	skey )

Definition at line 76 of file dictionary.F90.

Here is the call graph for this function:

◆ key_already_in_use()

generic dictionary::dict_t::key_already_in_use	(	class (dict_t)	this,
		character (len=*), intent(in)	skey )

Definition at line 64 of file dictionary.F90.

Here is the call graph for this function:

◆ key_name_already_in_use_fn()

procedure, private dictionary::dict_t::key_name_already_in_use_fn	(	class (dict_t)	this,
		character (len=*), intent(in)	skey )

private

Definition at line 63 of file dictionary.F90.

◆ print_all()

generic dictionary::dict_t::print_all	(	class (dict_t)	this,
		integer (c_int), intent(in), optional	iloglevel,
		character (len=*), intent(in), optional	sdescription,
		logical (c_bool), intent(in), optional	lecho )

Definition at line 73 of file dictionary.F90.

Here is the call graph for this function:

◆ print_all_dictionary_entries_sub()

procedure, private dictionary::dict_t::print_all_dictionary_entries_sub	(	class (dict_t)	this,
		integer (c_int), intent(in), optional	iloglevel,
		character (len=*), intent(in), optional	sdescription,
		logical (c_bool), intent(in), optional	lecho )

private

Definition at line 72 of file dictionary.F90.

Member Data Documentation

◆ count

integer (c_int) dictionary::dict_t::count = 0

Definition at line 46 of file dictionary.F90.

◆ current

type (dict_entry_t), pointer dictionary::dict_t::current => null()

Definition at line 45 of file dictionary.F90.

◆ first

type (dict_entry_t), pointer dictionary::dict_t::first => null()

Definition at line 43 of file dictionary.F90.

◆ last

type (dict_entry_t), pointer dictionary::dict_t::last => null()

Definition at line 44 of file dictionary.F90.

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

dictionary.F90

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Function/Subroutine Documentation

◆ add_entry()

◆ add_entry_to_dict_sub()

◆ delete_entry()

◆ delete_entry_by_key_sub()

◆ find_dict_entry()

◆ find_dict_entry_fn()

◆ get_entry() [1/2]

◆ get_entry() [2/2]

◆ get_entry_by_index_fn()

◆ get_entry_by_key_fn()

◆ get_next_entry() [1/2]

◆ get_next_entry() [2/2]

◆ get_next_entry_by_key_fn()

◆ get_next_entry_fn()

◆ get_value()

◆ get_values() [1/8]

◆ get_values() [2/8]

◆ get_values() [3/8]

◆ get_values() [4/8]

◆ get_values() [5/8]

◆ get_values() [6/8]

◆ get_values() [7/8]

◆ get_values() [8/8]

◆ get_values_as_float_given_list_of_keys_sub()

◆ get_values_as_float_sub()

◆ get_values_as_int_given_list_of_keys_sub()

◆ get_values_as_int_sub()

◆ get_values_as_logical_given_list_of_keys_sub()

◆ get_values_as_logical_sub()

◆ get_values_as_string_list_given_list_of_keys_sub()

◆ get_values_as_string_list_sub()

◆ grep_dictionary_key_names_fn()

◆ grep_keys()

◆ key_already_in_use()

◆ key_name_already_in_use_fn()

◆ print_all()

◆ print_all_dictionary_entries_sub()

Member Data Documentation

◆ count

◆ current

◆ first

◆ last