kim-api  2.1.4-git+v2.1.3-git-3-g4c859c7f.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Data Types | Functions/Subroutines | Variables
kim_log_module Module Reference

Provides the logging interface for the KIM API. More...

Functions/Subroutines

recursive subroutine, public kim_log_create (log_handle, ierr)
 Create a new KIM API Log object. More...
 
recursive subroutine, public kim_log_destroy (log_handle)
 Destroy a previously Log::Create'd object. More...
 
recursive subroutine kim_log_pop_default_verbosity ()
 Pop a LogVerbosity from the KIM API global default verbosity stack. More...
 
recursive subroutine kim_log_set_id (log_handle, id_string)
 Set the identity of the Log object. More...
 
recursive subroutine kim_log_push_verbosity (log_handle, log_verbosity)
 Push a new LogVerbosity onto the Log object's verbosity stack. More...
 
recursive subroutine kim_log_pop_verbosity (log_handle)
 Pop a LogVerbosity from the Log object's verbosity stack. More...
 
recursive subroutine kim_log_log_entry (log_handle, log_verbosity, message)
 Write a log entry into the log file. More...
 

Variables

type(kim_log_handle_type), save, public, protected kim_log_null_handle
 NULL handle for use in comparisons. More...
 

Detailed Description

Provides the logging interface for the KIM API.

See also
KIM::Log, KIM_Log
Since
2.0

Function/Subroutine Documentation

◆ kim_log_create()

recursive subroutine, public kim_log_module::kim_log_create ( type(kim_log_handle_type), intent(out)  log_handle,
integer(c_int), intent(out)  ierr 
)

Create a new KIM API Log object.

See also
KIM::Log::Create, KIM_Log_Create
Since
2.0

Definition at line 190 of file kim_log_module.f90.

◆ kim_log_destroy()

recursive subroutine, public kim_log_module::kim_log_destroy ( type(kim_log_handle_type), intent(inout)  log_handle)

Destroy a previously Log::Create'd object.

See also
KIM::Log::Destroy, KIM_Log_Destroy
Since
2.0

Definition at line 214 of file kim_log_module.f90.

◆ kim_log_log_entry()

recursive subroutine kim_log_module::kim_log_log_entry ( type(kim_log_handle_type), intent(in)  log_handle,
type(kim_log_verbosity_type), intent(in)  log_verbosity,
character(len=*, kind=c_char), intent(in)  message 
)

Write a log entry into the log file.

See also
KIM::Log::LogEntry, KIM_Log_LogEntry
Since
2.0

Definition at line 381 of file kim_log_module.f90.

◆ kim_log_pop_default_verbosity()

recursive subroutine kim_log_module::kim_log_pop_default_verbosity ( )

Pop a LogVerbosity from the KIM API global default verbosity stack.

See also
KIM::Log::PopDefaultVerbosity, KIM_Log_PopDefaultVerbosity
Since
2.0

Definition at line 258 of file kim_log_module.f90.

◆ kim_log_pop_verbosity()

recursive subroutine kim_log_module::kim_log_pop_verbosity ( type(kim_log_handle_type), intent(in)  log_handle)

Pop a LogVerbosity from the Log object's verbosity stack.

See also
KIM::Log::PopVerbosity, KIM_Log_PopVerbosity
Since
2.0

Definition at line 357 of file kim_log_module.f90.

◆ kim_log_push_verbosity()

recursive subroutine kim_log_module::kim_log_push_verbosity ( type(kim_log_handle_type), intent(in)  log_handle,
type(kim_log_verbosity_type), intent(in)  log_verbosity 
)

Push a new LogVerbosity onto the Log object's verbosity stack.

See also
KIM::Log::PushVerbosity, KIM_Log_PushVerbosity
Since
2.0

Definition at line 329 of file kim_log_module.f90.

◆ kim_log_set_id()

recursive subroutine kim_log_module::kim_log_set_id ( type(kim_log_handle_type), intent(in)  log_handle,
character(len=*, kind=c_char), intent(in)  id_string 
)

Set the identity of the Log object.

See also
KIM::Log::SetID, KIM_Log_SetID
Since
2.0

Definition at line 304 of file kim_log_module.f90.

Variable Documentation

◆ kim_log_null_handle

type(kim_log_handle_type), save, public, protected kim_log_module::kim_log_null_handle

NULL handle for use in comparisons.

Since
2.0

Definition at line 77 of file kim_log_module.f90.