pm_err::message_type Type Reference

This is the base derived type for constructing subclasses that contain the specifications of the generic message interfaces.
More...

Inheritance diagram for pm_err::message_type:

Public Attributes
character(:, SK), allocatable, public	prefix
	See the corresponding definition in the documentation of getStrWrapped. More...
character(:, SK), allocatable, public	indent
	See the corresponding definition in the documentation of getStrWrapped. More...
character(:, SK), allocatable, public	break
	See the corresponding definition in the documentation of getStrWrapped. More...
character(:, SK), allocatable, public	newline
	See the corresponding definition in the documentation of getStrWrapped. More...
integer(IK), allocatable, public	width
	See the corresponding definition in the documentation of getStrWrapped. More...
integer(IK), allocatable, public	maxwidth
	See the corresponding definition in the documentation of getStrWrapped. More...
integer(IK), allocatable, public	tmsize
	See the corresponding definition in the documentation of getStrWrapped. More...
integer(IK), allocatable, public	bmsize
	See the corresponding definition in the documentation of getStrWrapped. More...
integer(IK), allocatable, public	unit
	See the corresponding definition in the documentation of message_type. More...
logical(LK), public	sticky = .false._LK
	See the corresponding argument in the documentation of message_type. More...

Detailed Description

This is the base derived type for constructing subclasses that contain the specifications of the generic message interfaces.

The generic message interfaces of this module include,

1. setMarked
   
2. setNoted
   
3. setWarned
   
4. setAborted
   

The subclasses of this derived contain a dynamic method show() that acts as a convenience wrapper around the corresponding static generic interfaces mentioned above.
The main use of these classes is in situations where arbitrary user-specified messages must be delivered to an output unit repeatedly with a uniform identical style.
In such cases, the settings for the message can be specified once via the default constructor of this derived type and used subsequently via its wrapper method show.
This base derived type minimally defines the following type components listed below as input arguments to the default constructor of the type.

Parameters

[in]	prefix	: See the corresponding definition in the documentation of getStrWrapped. (optional, see the corresponding default in the documentation of getStrWrapped.)
[in]	indent	: See the corresponding definition in the documentation of getStrWrapped. (optional, see the corresponding default in the documentation of getStrWrapped.)
[in]	break	: See the corresponding definition in the documentation of getStrWrapped. (optional, see the corresponding default in the documentation of getStrWrapped.)
[in]	newline	: See the corresponding definition in the documentation of getStrWrapped. (optional, see the corresponding default in the documentation of getStrWrapped.)
[in]	width	: See the corresponding definition in the documentation of getStrWrapped. (optional, see the corresponding default in the documentation of getStrWrapped.)
[in]	maxwidth	: See the corresponding definition in the documentation of getStrWrapped. (optional, see the corresponding default in the documentation of getStrWrapped.)
[in]	tmsize	: The input scalar of integer of default kind IK representing the number of empty lines preceding the message to be displayed. (optional, see the corresponding default in the documentation of getStrWrapped.)
[in]	bmsize	: The input scalar of integer of default kind IK representing the number of empty lines succeeding the message to be displayed. (optional, see the corresponding default in the documentation of getStrWrapped.)
[in]	unit	: The input scalar integer of default kind IK containing the output file unit. (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.)

Returns

message : An object of class message_type containing the attributes and wrapper method for outputting a message.

Possible calling interfaces ⛓

use pm_err, only: message_type, mark_type, note_type, warn_type, stop_type
class(message_type), allocatable :: message
 
message = message_type()
message = mark_type()
message = note_type()
message = warn_type()
message = stop_type()

Note

This base derived type is meant to be primary provide the scaffolding required to define the subclasses,

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

See also

show
mark_type
note_type
warn_type
stop_type
message_type
display_type
getStrWrapped
getCentered
setCentered

Test:

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

Definition at line 889 of file pm_err.F90.

Member Data Documentation

bmsize

integer(IK), allocatable, public pm_err::message_type::bmsize

See the corresponding definition in the documentation of getStrWrapped.

Definition at line 897 of file pm_err.F90.

break

character(:, SK), allocatable, public pm_err::message_type::break

See the corresponding definition in the documentation of getStrWrapped.

Definition at line 892 of file pm_err.F90.

indent

character(:, SK), allocatable, public pm_err::message_type::indent

See the corresponding definition in the documentation of getStrWrapped.

Definition at line 891 of file pm_err.F90.

maxwidth

integer(IK), allocatable, public pm_err::message_type::maxwidth

See the corresponding definition in the documentation of getStrWrapped.

Definition at line 895 of file pm_err.F90.

newline

character(:, SK), allocatable, public pm_err::message_type::newline

See the corresponding definition in the documentation of getStrWrapped.

Definition at line 893 of file pm_err.F90.

prefix

character(:, SK), allocatable, public pm_err::message_type::prefix

See the corresponding definition in the documentation of getStrWrapped.

Definition at line 890 of file pm_err.F90.

sticky

logical(LK), public pm_err::message_type::sticky = .false._LK

See the corresponding argument in the documentation of message_type.

Definition at line 899 of file pm_err.F90.

tmsize

integer(IK), allocatable, public pm_err::message_type::tmsize

See the corresponding definition in the documentation of getStrWrapped.

Definition at line 896 of file pm_err.F90.

unit

integer(IK), allocatable, public pm_err::message_type::unit

See the corresponding definition in the documentation of message_type.

Definition at line 898 of file pm_err.F90.

width

integer(IK), allocatable, public pm_err::message_type::width

See the corresponding definition in the documentation of getStrWrapped.

Definition at line 894 of file pm_err.F90.

---

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

• src/fortran/main/pm_err.F90