pic_logger

this is the logger module

Uses

- pic_global_definitions
- pic_types
Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Used by

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Variables

Type	Visibility	Attributes		Name		Initial
integer(kind=default_int),	public,	parameter	::	debug_level	=	10
integer(kind=default_int),	public,	parameter	::	error_level	=	5
type(logger_type),	public		::	global_logger
integer(kind=default_int),	public,	parameter	::	info_level	=	8
integer(kind=default_int),	public,	parameter	::	knowledge_level	=	4
integer(kind=default_int),	public,	parameter	::	performance_level	=	7
integer(kind=default_int),	public,	parameter	::	verbose_level	=	9
integer(kind=default_int),	public,	parameter	::	warning_level	=	6
character(len=*),	private,	parameter	::	name	=	"pic_logger"

Derived Types

type, public :: logger_type

custom logger data type

Components

Type	Visibility		Name		Initial
integer(kind=default_int),	public	::	log_file_level	=	verbose_level	set default log file log level to verbose
integer(kind=default_int),	public	::	log_level	=	info_level	set default log level to info
logical,	private	::	log_file_open	=	.false.
integer(kind=default_int),	private	::	log_file_unit	=	-1

Type-Bound Procedures

procedure, public, pass(self), non_overridable :: close_log_file	Close the log file, needs to be called at the end of the program. Usage: call my_logger%close_log_file()
procedure, public, pass(self), non_overridable :: configuration	Get the current logger verbosity configuration. Usage: call my_logger%configuration(level)
procedure, public, pass(self), non_overridable :: configure	Configure the logger to be a certain verbosity level. Usage: call my_logger%configure(level)
procedure, public, pass(self), non_overridable :: configure_file_output	Configure the logger to file to be a certain verbosity level. Usage: call my_logger%configure_file_output(filename, level)
procedure, public, pass(self), non_overridable :: debug	Log a message that will only be printed at the debug level of verbosity. Usage: call my_logger%debug(“MESSAGE”)
procedure, public, pass(self), non_overridable :: error	Log a message that will only be printed at the error level of verbosity. Usage: call my_logger%error(“MESSAGE”)
procedure, public, pass(self), non_overridable :: info	Log a message that will only be printed at the info level of verbosity. Usage: call my_logger%info(“MESSAGE”)
procedure, public, pass(self), non_overridable :: knowledge	Log a message that will only be printed at the knowledge level of verbosity. Usage: call my_logger%knowledge(“MESSAGE”)
procedure, public, pass(self), non_overridable :: performance	Log a message that will only be printed at the performance level of verbosity. Usage: call my_logger%performance(“MESSAGE”)
procedure, public, pass(self), non_overridable :: verbose	Log a message that will only be printed at the verbose level of verbosity. Usage: call my_logger%verbose(“MESSAGE”)
procedure, public, pass(self), non_overridable :: warning	Log a message that will only be printed at the warning level of verbosity. Usage: call my_logger%warning(“MESSAGE”)
procedure, private, pass(self), non_overridable :: log	Processes the message and filters it according to the verbosity level set by the user or the default

Subroutines

private subroutine close_log_file(self)

Close the log file, needs to be called at the end of the program

Arguments

Type	Intent	Optional	Attributes		Name
class(logger_type),	intent(inout)			::	self

private pure subroutine configuration(self, level)

Get the current logger verbosity configuration

Arguments

Type	Intent	Optional	Attributes		Name
class(logger_type),	intent(in)			::	self
integer(kind=default_int),	intent(out),	optional		::	level

private pure subroutine configure(self, level)

Configure the logger to be a certain verbosity level

Arguments

Type	Intent	Optional	Attributes		Name
class(logger_type),	intent(inout)			::	self
integer(kind=default_int),	intent(in),	optional		::	level

private subroutine configure_file_output(self, filename, level)

Configure the logger to file to be a certain verbosity level

Arguments

Type	Intent	Optional		Name
class(logger_type),	intent(inout)		::	self
character(len=*),	intent(in)		::	filename
integer(kind=default_int),	intent(in),	optional	::	level

private subroutine debug(self, message, module, procedure)

Log a message that will only be printed at the debug level of verbosity

Arguments

Type	Intent	Optional		Name
class(logger_type),	intent(in)		::	self
character(len=*),	intent(in)		::	message
character(len=*),	intent(in),	optional	::	module
character(len=*),	intent(in),	optional	::	procedure

private subroutine error(self, message, module, procedure)

Log a message that will only be printed at the error of verbosity

Arguments

Type	Intent	Optional		Name
class(logger_type),	intent(in)		::	self
character(len=*),	intent(in)		::	message
character(len=*),	intent(in),	optional	::	module
character(len=*),	intent(in),	optional	::	procedure

private subroutine info(self, message, module, procedure)

Log a message that will only be printed at the info level of verbosity

Arguments

Type	Intent	Optional		Name
class(logger_type),	intent(in)		::	self
character(len=*),	intent(in)		::	message
character(len=*),	intent(in),	optional	::	module
character(len=*),	intent(in),	optional	::	procedure

private subroutine knowledge(self, message, module, procedure)

Log a message that will only be printed at the error of verbosity

Arguments

Type	Intent	Optional		Name
class(logger_type),	intent(in)		::	self
character(len=*),	intent(in)		::	message
character(len=*),	intent(in),	optional	::	module
character(len=*),	intent(in),	optional	::	procedure

private subroutine log(self, level, message, module, procedure)

internal subroutines that processes the message and filters it according to the verbosity level set by the user or the default this is a private subroutine so it is not exposed to the user

Arguments

Type	Intent	Optional		Name
class(logger_type),	intent(in)		::	self
character(len=*),	intent(in)		::	level
character(len=*),	intent(in)		::	message
character(len=*),	intent(in),	optional	::	module
character(len=*),	intent(in),	optional	::	procedure

private subroutine performance(self, message, module, procedure)

Log a message that will only be printed at the performance of verbosity

Arguments

Type	Intent	Optional		Name
class(logger_type),	intent(in)		::	self
character(len=*),	intent(in)		::	message
character(len=*),	intent(in),	optional	::	module
character(len=*),	intent(in),	optional	::	procedure

private subroutine verbose(self, message, module, procedure)

Log a message that will only be printed at the verbose level of verbosity

Arguments

Type	Intent	Optional		Name
class(logger_type),	intent(in)		::	self
character(len=*),	intent(in)		::	message
character(len=*),	intent(in),	optional	::	module
character(len=*),	intent(in),	optional	::	procedure

private subroutine warning(self, message, module, procedure)

Log a message that will only be printed at the warning level of verbosity

Arguments

Type	Intent	Optional		Name
class(logger_type),	intent(in)		::	self
character(len=*),	intent(in)		::	message
character(len=*),	intent(in),	optional	::	module
character(len=*),	intent(in),	optional	::	procedure

private subroutine write_log_line(unit, level, message, module, procedure)

Internal subroutine that will write the message to the log no interface to the public

Arguments

Type	Intent	Optional		Name
integer(kind=default_int),	intent(in)		::	unit
character(len=*),	intent(in)		::	level
character(len=*),	intent(in)		::	message
character(len=*),	intent(in),	optional	::	module
character(len=*),	intent(in),	optional	::	procedure

pic_logger Module

Contents

Variables

Derived Types

Subroutines

Uses

Used by

Variables

Derived Types

type, public :: logger_type

Components

Type-Bound Procedures

Subroutines

private subroutine close_log_file(self)

Arguments

private pure subroutine configuration(self, level)

Arguments

private pure subroutine configure(self, level)

Arguments

private subroutine configure_file_output(self, filename, level)

Arguments

private subroutine debug(self, message, module, procedure)

Arguments

private subroutine error(self, message, module, procedure)

Arguments

private subroutine info(self, message, module, procedure)

Arguments

private subroutine knowledge(self, message, module, procedure)

Arguments

private subroutine log(self, level, message, module, procedure)

Arguments

private subroutine performance(self, message, module, procedure)

Arguments

private subroutine verbose(self, message, module, procedure)

Arguments

private subroutine warning(self, message, module, procedure)

Arguments

private subroutine write_log_line(unit, level, message, module, procedure)

Arguments