config.F90 File Reference

The musica_config module. More...

Data Types
type	musica_config::config_t
	Model configuration data. More...
type	musica_config::config_iterator_t
	Configuration data iterator. More...

Modules
module	musica_config
	The config_t type and related functions.

Functions/Subroutines
subroutine	musica_config::empty (this)
	Empties the configuration.
subroutine	musica_config::construct_from_file (this, file_name)
	Constructs a configuration from a file.
subroutine	musica_config::to_file (this, file_name)
	Writes a configuration to a file.
integer(kind=musica_ik) function	musica_config::number_of_children (this)
	Returns the number of child objects.
class(iterator_t) function, pointer	musica_config::get_iterator (this)
	Gets an interator for the configuration data.
type(string_t) function	musica_config::key (this, iterator)
	Gets the key name using an iterator.
subroutine	musica_config::get_config (this, key, value, caller, default, found)
	Gets a subset of the configuration data.
subroutine	musica_config::get_string_string_default (this, key, value, caller, default, found)
	Gets a string from the configuration data.
subroutine	musica_config::get_string (this, key, value, caller, default, found)
	Gets a string from the configuration data.
subroutine	musica_config::get_int (this, key, value, caller, default, found)
	Gets an integer from the configuration data.
subroutine	musica_config::get_float (this, key, value, caller, default, found)
	Gets a single-precision real number from the configuration data.
subroutine	musica_config::get_double (this, key, value, caller, default, found)
	Gets a double-precision real number from the configuration data.
subroutine	musica_config::get_logical (this, key, value, caller, default, found)
	Gets a boolean value from the configuration data.
subroutine	musica_config::get_string_array (this, key, value, caller, default, found)
	Gets an array of strings from the configuration data.
subroutine	musica_config::get_double_array (this, key, value, caller, default, found)
	Gets an array of doubles from the configuration data.
recursive subroutine	musica_config::get_config_array (this, key, value, caller, default, found)
	Gets an array of config_t objects.
subroutine	musica_config::get_from_iterator (this, iterator, value, caller)
	Gets a value using an iterator.
subroutine	musica_config::get_array_from_iterator (this, iterator, value, caller)
	Gets an array value using an iterator.
recursive subroutine	musica_config::add_config (this, key, value, caller)
	Adds a subset of configuration data.
subroutine	musica_config::add_char_array (this, key, value, caller)
	Adds a string to the configuration data.
subroutine	musica_config::add_string (this, key, value, caller)
	Adds a string to the configuration data.
subroutine	musica_config::add_int (this, key, value, caller)
	Adds an integer to the configuration data.
subroutine	musica_config::add_float (this, key, value, caller)
	Adds a single-precision real number to the configuration data.
subroutine	musica_config::add_double (this, key, value, caller)
	Adds a double-precision real number to the configuration data.
subroutine	musica_config::add_logical (this, key, value, caller)
	Adds a boolean to the configuration data.
subroutine	musica_config::add_string_array (this, key, value, caller)
	Adds a string array to the configuration data.
subroutine	musica_config::add_double_array (this, key, value, caller)
	Adds a double array to the configuration data.
recursive subroutine	musica_config::add_config_array (this, key, value, caller)
	Adds a config_t array to the configuration data.
subroutine	musica_config::config_assign_config (a, b)
	Assigns a config_t from a config_t.
subroutine	musica_config::config_assign_string (config, string)
	Assigns a config_t from a string.
subroutine	musica_config::config_assign_char (config, string)
	Assigns a config_t from a character array.
subroutine	musica_config::string_assign_config (string, config)
	Assigns a string from a configuration.
subroutine	musica_config::finalize (this)
	Cleans up memory.
subroutine	musica_config::finalize_1d_array (this)
	Cleans up memory.
subroutine	musica_config::find_by_prefix (this, prefix, full_key, found)
	Finds a full key name by a prefix.
recursive subroutine	musica_config::merge_in (this, other, caller)
	Merges another config_t object into the config_t object.
logical function	musica_config::find_key_in_list (key_to_find, list)
	Returns true if the given key is in the given list of keys.
logical function	musica_config::validate (this, required_keys, optional_keys)
	Validates the format of the configuration data.
subroutine	musica_config::do_print (this)
	Print out the raw contents of the configuration.
integer function	musica_config::pack_size (this, comm)
	Returns the size of a binary buffer required to pack the object.
subroutine	musica_config::mpi_pack (this, buffer, position, comm)
	Packs the configuration onto a character buffer.
subroutine	musica_config::mpi_unpack (this, buffer, position, comm)
	Unpacks the configuration from a character buffer.
logical function	musica_config::iterator_next (this)
	Advances the iterator.
subroutine	musica_config::iterator_reset (this, parent)
	Resets the iterator.
subroutine	musica_config::iterator_finalize (this)
	Cleans up memory assoicated with an iterator.
subroutine	musica_config::initialize_config_t (config, string)
	Initialize a config_t object.
character(len=1, kind=c_char) function, dimension(:), allocatable	musica_config::to_c_string (f_string)
	Convert a fortran character array to a c string.
character(len=:) function, allocatable	musica_config::to_f_string (c_string)
	Convert a c string to a fortran character array.

Detailed Description

The musica_config module.