ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_io::getAction Interface Reference

Generate and return the action attribute of the input file or unit. More...

Detailed Description

Generate and return the action attribute of the input file or unit.

The action attribute of a connected file or unit is returned by the Fortran intrinsic inquire() statement.
Possible values are, "READ", "WRITE", "READWRITE". If there is no connection, the value returned is "UNDEFINED".

Parameters
[in]unit: The input scalar, or array of arbitrary rank, of type integer of default kind IK representing the file unit whose action attribute is to be returned.
(optional, it must be present if and only if the input argument file is missing.)
[in]file: The input scalar, or array of arbitrary rank, of type character of default kind SK representing the file path whose action attribute is to be returned.
(optional, it must be present if and only if the input argument unit is missing.)
Returns
action : The output scalar, or array of same rank, shape, and size as the input array-like argument, of type character of default kind SK of length type parameter 9, containing the action attribute of the input file or unit.
If the length of the output value is less than 9, it is left-adjusted and padded with blanks.


Possible calling interfaces ⛓

use pm_kind, only: SK
use pm_io, only: getAction
character(9, SK) :: action
action = getAction(unit)
action = getAction(file)
Generate and return the action attribute of the input file or unit.
Definition: pm_io.F90:1384
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539
Warning
This procedure does not gracefully handle unexpected runtime errors.
If error handling is needed, use the Fortran intrinsic inquire() with arguments iostat and iomsg present.
Remarks
The procedures under discussion are impure.
The procedures under discussion are elemental.
See also
isOpen


Example usage ⛓

1program example
2
3 use iso_fortran_env, only: output_unit, input_unit, error_unit
4 use pm_kind, only: SK, IK, LK
5 use pm_io, only: display_type
6 use pm_sysPath, only: getPathNew
7 use pm_io, only: getAction
8
9 implicit none
10
11 integer(IK) :: unit
12 type(display_type) :: disp
13
14 disp = display_type(file = "main.out.F90")
15
16 call disp%skip
17 call disp%show("getAction('temp.tmp') ! file is not connected.")
18 call disp%show( getAction('temp.tmp') , deliml = SK_"""" )
19 call disp%skip
20
21 call disp%skip
22 call disp%show("open(newunit = unit, file = 'temp.tmp', action = 'write')")
23 open(newunit = unit, file = 'temp.tmp', action = 'write')
24 call disp%show("getAction('temp.tmp')")
25 call disp%show( getAction('temp.tmp') , deliml = SK_"""" )
26 call disp%show("getAction(unit)")
27 call disp%show( getAction(unit) , deliml = SK_"""" )
28 call disp%show("close(unit)")
29 close(unit)
30 call disp%skip
31
32 call disp%skip
33 call disp%show("open(newunit = unit, file = 'temp.tmp', action = 'read')")
34 open(newunit = unit, file = 'temp.tmp', action = 'read')
35 call disp%show("getAction('temp.tmp')")
36 call disp%show( getAction('temp.tmp') , deliml = SK_"""" )
37 call disp%show("getAction(unit)")
38 call disp%show( getAction(unit) , deliml = SK_"""" )
39 call disp%show("close(unit)")
40 close(unit)
41 call disp%skip
42
43 call disp%skip
44 call disp%show("open(newunit = unit, file = 'temp.tmp', action = 'readwrite')")
45 open(newunit = unit, file = 'temp.tmp', action = 'readwrite')
46 call disp%show("getAction('temp.tmp')")
47 call disp%show( getAction('temp.tmp') , deliml = SK_"""" )
48 call disp%show("getAction(unit)")
49 call disp%show( getAction(unit) , deliml = SK_"""" )
50 call disp%show("close(unit)")
51 close(unit)
52 call disp%skip
53
54 call disp%skip
55 call disp%show("getAction([output_unit, input_unit, error_unit])")
56 call disp%show( getAction([output_unit, input_unit, error_unit]) , deliml = SK_"""" )
57 call disp%skip
58
59end program example
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
Generate and return a unique (directory or file) path name in the specified directory or the default ...
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540
This module contains classes and procedures for manipulating system file/folder paths.
Definition: pm_sysPath.F90:274
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler ⛓
1#!/usr/bin/env sh
2rm main.exe
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓
1del main.exe
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓
1#!/usr/bin/env sh
2rm main.exe
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example output ⛓
1
2getAction('temp.tmp') ! file is not connected.
3àðÂÈ"eU ®"
4
5
6open(newunit = unit, file = 'temp.tmp', action = 'write')
7getAction('temp.tmp')
8"WRITE "
9getAction(unit)
10"WRITE "
11close(unit)
12
13
14open(newunit = unit, file = 'temp.tmp', action = 'read')
15getAction('temp.tmp')
16"READ "
17getAction(unit)
18"READ "
19close(unit)
20
21
22open(newunit = unit, file = 'temp.tmp', action = 'readwrite')
23getAction('temp.tmp')
24"READWRITE"
25getAction(unit)
26"READWRITE"
27close(unit)
28
29
30getAction([output_unit, input_unit, error_unit])
31"WRITE ", "READ ", "WRITE "
32
33
Test:
test_pm_io


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.

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 1384 of file pm_io.F90.


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