loggingmodule Module Reference

A module for writing data to the log file. More...

Functions/Subroutines
subroutine, public	activatelogger
	Activate the logger.
subroutine, public	deactivatelogger
	Deactivate the logger.
subroutine, public	entersublog
	Call this function when you enter into a section with verbose output.
subroutine, public	exitsublog
	Call this function when you exit a section with verbose output.
subroutine, public	writeheader (header_value)
	Write out a header to the log. More...
subroutine, public	writeelement (key, text_value_in, int_value_in, float_value_in, bool_value_in)
	Write out a element. More...
subroutine, public	writelistelement (key, text_value_in, int_value_in, float_value_in, bool_value_in)
	Write out a list element. More...
subroutine, public	writecitation (citation_list)
	Write out a citation element. More...

Detailed Description

A module for writing data to the log file.

Function/Subroutine Documentation

writecitation()

subroutine, public loggingmodule::writecitation

(

character(len=*), intent(in)

citation_list

)

Write out a citation element.

Parameters

[in]

citation_list

list of citations, separated by a space.

writeelement()

subroutine, public loggingmodule::writeelement	(	character(len=*), intent(in)	key,
		character(len=*), intent(in), optional	text_value_in,
		integer, intent(in), optional	int_value_in,
		real(ntreal), intent(in), optional	float_value_in,
		logical, intent(in), optional	bool_value_in
	)

Write out a element.

Parameters

[in]	key	some text to write.
[in]	text_value_in	a text value to write.
[in]	int_value_in	an integer value to write.
[in]	float_value_in	an float value to write.
[in]	bool_value_in	a bool value to write.

writeheader()

subroutine, public loggingmodule::writeheader

(

character(len=*), intent(in)

header_value

)

Write out a header to the log.

Parameters

[in]

header_value

the text of the header.

writelistelement()

subroutine, public loggingmodule::writelistelement	(	character(len=*), intent(in)	key,
		character(len=*), intent(in), optional	text_value_in,
		integer, intent(in), optional	int_value_in,
		real(ntreal), intent(in), optional	float_value_in,
		logical, intent(in), optional	bool_value_in
	)

Write out a list element.

Parameters

[in]	key	some text to add to the list.
[in]	text_value_in	a text value to add to the list.
[in]	int_value_in	an integer value to add to the list.
[in]	float_value_in	a float value to add to the list.
[in]	bool_value_in	a bool value to add to the list.