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)

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 ⛓

program example
 
    use iso_fortran_env, only: output_unit, input_unit, error_unit
    use pm_kind, only: SK, IK, LK
    use pm_io, only: display_type
    use pm_sysPath, only: getPathNew
    use pm_io, only: getAction
 
    implicit none
 
    integer(IK) :: unit
    type(display_type) :: disp
 
    disp = display_type(file = "main.out.F90")
 
    call disp%skip
    call disp%show("getAction('temp.tmp') ! file is not connected.")
    call disp%show( getAction('temp.tmp') , deliml = SK_"""" )
    call disp%skip
 
    call disp%skip
    call disp%show("open(newunit = unit, file = 'temp.tmp', action = 'write')")
                    open(newunit = unit, file = 'temp.tmp', action = 'write')
    call disp%show("getAction('temp.tmp')")
    call disp%show( getAction('temp.tmp') , deliml = SK_"""" )
    call disp%show("getAction(unit)")
    call disp%show( getAction(unit) , deliml = SK_"""" )
    call disp%show("close(unit)")
                    close(unit)
    call disp%skip
 
    call disp%skip
    call disp%show("open(newunit = unit, file = 'temp.tmp', action = 'read')")
                    open(newunit = unit, file = 'temp.tmp', action = 'read')
    call disp%show("getAction('temp.tmp')")
    call disp%show( getAction('temp.tmp') , deliml = SK_"""" )
    call disp%show("getAction(unit)")
    call disp%show( getAction(unit) , deliml = SK_"""" )
    call disp%show("close(unit)")
                    close(unit)
    call disp%skip
 
    call disp%skip
    call disp%show("open(newunit = unit, file = 'temp.tmp', action = 'readwrite')")
                    open(newunit = unit, file = 'temp.tmp', action = 'readwrite')
    call disp%show("getAction('temp.tmp')")
    call disp%show( getAction('temp.tmp') , deliml = SK_"""" )
    call disp%show("getAction(unit)")
    call disp%show( getAction(unit) , deliml = SK_"""" )
    call disp%show("close(unit)")
                    close(unit)
    call disp%skip
 
    call disp%skip
    call disp%show("getAction([output_unit, input_unit, error_unit])")
    call disp%show( getAction([output_unit, input_unit, error_unit]) , deliml = SK_"""" )
    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 ⛓

 
getAction('temp.tmp') ! file is not connected.
"␁       ("
 
 
open(newunit = unit, file = 'temp.tmp', action = 'write')
getAction('temp.tmp')
"WRITE    "
getAction(unit)
"WRITE    "
close(unit)
 
 
open(newunit = unit, file = 'temp.tmp', action = 'read')
getAction('temp.tmp')
"READ     "
getAction(unit)
"READ     "
close(unit)
 
 
open(newunit = unit, file = 'temp.tmp', action = 'readwrite')
getAction('temp.tmp')
"READWRITE"
getAction(unit)
"READWRITE"
close(unit)
 
 
getAction([output_unit, input_unit, error_unit])
"WRITE    ", "READ     ", "WRITE    "
 
 

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.

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

Definition at line 1384 of file pm_io.F90.

---

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

• src/fortran/main/pm_io.F90