pm_err::show Interface Reference

Generate and return an object of type stop_type with the user-specified input attributes. More...

Detailed Description

Generate and return an object of type stop_type with the user-specified input attributes.

This generic interface serves as the custom constructor for objects of type stop_type.
See the documentation of stop_type for the documentation of the input arguments.
This custom constructor exists because of a GNU Fortran Compiler gfortran bug in the implementation of the default constructor.
See the bug description below.

See also

stop_type

Test:

test_pm_err

Bug:

Status: Unresolved
Source: GNU Fortran Compiler gfortran version 11-13
Description: GNU Fortran Compiler gfortran cannot properly construct the allocatable scalar non-character components of objects of type stop_type using the default constructor.
For example, when unit is set via the default constructor, the program behaves as if the unit component of the object is allocated but unset, yielding a segmentation fault error.

Remedy (as of ParaMonte Library version 2.0.0): For now, the custom constructor bypasses GNU Fortran Compiler gfortran bug.

Todo:

Low Priority: A test should be implemented for arrays of size that can be represented only by an IKD integer.

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, Tuesday March 7, 2017, 3:50 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin

Write the input string msg in the format of a notification/warning/abortion message to the output.

The procedures under this generic interface are dynamic member methods of objects whose class is dictated by the implicitly-passed class argument self as described below.
to obtain a wrapped text within the specified width and maxwidth where the input prefix is suffixed with - NOTE: and then prepended to the beginning of each wrapped line and then printed on the display.

See the documentations of,

1. mark_type
   
2. note_type
   
3. warn_type
   
4. stop_type
   

for example usage.

Parameters

[in,out]	self	: The input/output implicitly-passed scalar that can be of, class mark_type class note_type class warn_type class stop_type
[in]	msg	: The input scalar character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) representing the text to be wrapped and displayed.
[in]	prefix	: See the corresponding definition in the documentation of getStrWrapped. (optional)
[in]	indent	: See the corresponding definition in the documentation of getStrWrapped. (optional)
[in]	break	: See the corresponding definition in the documentation of getStrWrapped. (optional)
[in]	newline	: See the corresponding definition in the documentation of getStrWrapped. (optional)
[in]	width	: See the corresponding definition in the documentation of getStrWrapped. (optional)
[in]	maxwidth	: See the corresponding definition in the documentation of getStrWrapped. (optional)
[in]	tmsize	: The input scalar of integer of default kind IK representing the number of empty lines preceding the text in the display. (optional, default = 1_IK)
[in]	bmsize	: The input scalar of integer of default kind IK representing the number of empty lines succeeding the text in the display. (optional, default = 0_IK)
[in]	unit	: The input scalar integer of default kind IK containing the output file unit. If the input unit is different from the standard output (output_unit), all messages will also be printed on stdout recursively. (optional, default = output_unit taken from the intrinsic module iso_fortran_env.)
[in]	sticky	: The input scalar of type logical of default kind LK. If .true., the global properties (i.e., components) of the object of class message_type can be overridden by the corresponding arguments passed to the dynamic methods of the object. (optional, default = .false.)
[in]	stat	: The input scalar integer of default kind IK containing the error stat code, frequently returned by the compiler. (optional. If missing, no error code will be suffixed to the output error message. It can be present only if self is of class stop_type.)
[in]	help	: The input scalar character of the same kind as msg containing a descriptive help message to display separately after the fatal error message. (optional, default = "". It can be present only if self is of class stop_type.)
[in]	renabled	: The input scalar logical of default kind LK that if .true., the program-control will be returned to the calling routine instead of terminating the program via error stop. This capability is particularly needed during the testing of the various components of the ParaMonte library, when fatal error must be handled gracefully. (optional, default = SOFT_EXIT_ENABLED. It can be present only if self is of class stop_type.)

Possible calling interfaces ⛓

use pm_err, only: show
 
call self%show(msg, prefix = prefix, indent = indent, break = break, newline = newline, width = width, maxwidth = maxwidth, tmsize = tmsize, bmsize = bmsize, unit = unit)
call self%show(msg, prefix = prefix, indent = indent, break = break, newline = newline, width = width, maxwidth = maxwidth, tmsize = tmsize, bmsize = bmsize, unit = unit, stat = stat, help = help, renabled = renabled) ! only if self is of class `stop_type`.

Remarks

The procedures under discussion are impure.

See also

getStr
setNoted
setWarned
setAborted
setAsserted
getLine

test_pm_err

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, 9:49 PM Friday, March 1, 2013, Institute for Fusion Studies, The University of Texas at Austin

Definition at line 1618 of file pm_err.F90.

---

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

• src/fortran/main/pm_err.F90