pm_err::err_type Interface Reference

This is the derived type for generating objects to gracefully and verbosely handle runtime unexpected behavior in the ParaMonte library.
More...

Public Attributes
logical(LK)	iswarned = .false._LK
	The scalar logical of default kind LK that is .true. if a runtime warning occurs. More...
logical(LK)	occurred = .false._LK
	The scalar logical of default kind LK that is .true. if a runtime error occurs. More...
integer(IK)	stat = -huge(0_IK)
	The scalar integer of default kind IK to contain the error flag or status code returned by the compiler or program upon encountering an error. More...
character(:, SK), allocatable	msg
	The allocatable scalar character of default kind SK containing the error message. More...

Detailed Description

This is the derived type for generating objects to gracefully and verbosely handle runtime unexpected behavior in the ParaMonte library.

Always initialize objects of type err_type if you prefer to avoid the manual allocation of the msg component of the object.
The pre-allocated component can be readily passed to various Fortran routines for catching error messages.

Parameters

[in]	occurred	: The input scalar logical of default kind LK that is used to initialize the corresponding component of the output object. (optional, default = .false.)
[in]	stat	: The input scalar integer of default kind IK that contains the error flag or status. It is used to to initialize the corresponding component of the output object. (optional, default = -huge(0_IK))
[in]	msg	: The input allocatable scalar character of default kind SK containing the error message. It is used to to initialize the corresponding component of the output object. (optional, default = repeat(" ", 255))

Returns

err : The output scalar object of type err_type.

Possible calling interfaces ⛓

use pm_err, only: err_type
type(err_type) :: err
 
err = err_type()
print *, err%occurred
print *, err%stat
print *, err%msg

See also

getStr
setNoted
setWarned
setAborted
setAsserted
getLine

Example usage ⛓

program example
 
    use pm_kind, only: IK, LK
    use pm_kind, only: SK ! All kinds are supported.
    use pm_err, only: err_type
    use pm_io, only: display_type
    use iso_fortran_env, only: output_unit
 
    implicit none
 
    integer :: fileunit
    type(err_type) :: err
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%show("err = err_type()")
                    err = err_type()
    call disp%show("err%msg")
    call disp%show( err%msg , deliml = SK_"""" )
    call disp%show("err%stat")
    call disp%show( err%stat )
    call disp%show("open(newunit = fileunit, file = 'nonesense.io', status = 'old', iostat = err%stat, iomsg = err%msg)")
                    open(newunit = fileunit, file = 'nonesense.io', status = 'old', iostat = err%stat, iomsg = err%msg)
    call disp%skip()
    call disp%show("err%stat")
    call disp%show( err%stat )
    call disp%skip()
    call disp%show("trim(err%msg)")
    call disp%show( trim(err%msg) )
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

err = err_type()
err%msg
"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
err%stat
-2147483647
open(newunit = fileunit, file = 'nonesense.io', status = 'old', iostat = err%stat, iomsg = err%msg)
 
err%stat
+2
 
trim(err%msg)
Cannot open file 'nonesense.io': No such file or directory
 
 

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, 3:43 AM Friday, March 1, 2013, Institute for Fusion Studies, The University of Texas at Austin

Definition at line 157 of file pm_err.F90.

Member Data Documentation

iswarned

logical(LK) pm_err::err_type::iswarned = .false._LK

The scalar logical of default kind LK that is .true. if a runtime warning occurs.

Definition at line 158 of file pm_err.F90.

msg

character(:, SK), allocatable pm_err::err_type::msg

The allocatable scalar character of default kind SK containing the error message.

Definition at line 162 of file pm_err.F90.

occurred

logical(LK) pm_err::err_type::occurred = .false._LK

The scalar logical of default kind LK that is .true. if a runtime error occurs.

Definition at line 159 of file pm_err.F90.

stat

integer(IK) pm_err::err_type::stat = -huge(0_IK)

The scalar integer of default kind IK to contain the error flag or status code returned by the compiler or program upon encountering an error.

Definition at line 160 of file pm_err.F90.

---

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

• src/fortran/main/pm_err.F90