Class dcpam_error
In: shared/dcpam_error.f90

dcpam エラー処理モジュール

dcpam error handling module

Note that Japanese and English are described in parallel.

dcpam におけるエラー処理を行うモジュールです. 基本的には gt4f90io ライブラリの dc_error モジュールのかぶせものです.

This module handles error in dcpam. It is a wrapper of dc_error module of gt4f90io library in principle.

エラーコード一覧

Error code list

gt4f90io の dc_error で自由に使用することを許可されている -3000 〜 -3099 を使用します.

Code number -3000 — -3099 are used. They are allowed to use freely in dc_error module of gt4f90io library.

非エラーコード

Non error code

以下の非エラーコードに関してはこの dcpam_error モジュールを引用することで 利用してください. (この非エラーコードは dc_error と共有されています).

Use following non error code by refering this dcpam_error module. (This non error code is shared with dc_error).

数値. Number : [ ニーモニック. Mnemonic ]
0 :[ DC_NOERR ]

dcpam 用エラーコード

Error codes for dcpam

以下のエラーコードに関してはこの dcpam_error モジュールを 引用することで利用してください。

Use following error codes by refering this dcpam_error module.

数値. Number : [ ニーモニック. Mnemonic ] エラーメッセージ. Error message
-3000 :[ DCPAM_ENEGATIVE ]
:negative value is invalid for (cause_c)
-3001 :[ DCPAM_EARGLACK ]
:lack of arguments (cause_c)
-3002 :[ DCPAM_EALREADYINIT ]
:object (cause_c) is already initialized
-3003 :[ DCPAM_ENOTINIT ]
:object (cause_c) is not initialized
-3004 :[ DCPAM_ENOVARDEF ]
:variable (cause_c) is not defined.
-3005 :[ DCPAM_EARGSIZEMISMATCH ]
:arguments (cause_c) array size mismatch
-3006 :[ DCPAM_ELMAXMISMATCH ]
:<all wavenum> - <zonal wavenum> is over the meridonal wavenum (cause_c)
-3007 :[ DCPAM_ENMLARRAYINSUFF ]
:size of array (cause_c) in NAMELIST group is insufficient

Methods

Included Modules

dc_error dc_types

Public Instance methods

DCPAM_EALREADYINIT
Constant :
DCPAM_EALREADYINIT = -3002 :integer, parameter, public
DCPAM_EARGLACK
Constant :
DCPAM_EARGLACK = -3001 :integer, parameter, public
DCPAM_EARGSIZEMISMATCH
Constant :
DCPAM_EARGSIZEMISMATCH = -3005 :integer, parameter, public
DCPAM_ELMAXMISMATCH
Constant :
DCPAM_ELMAXMISMATCH = -3006 :integer, parameter, public
DCPAM_ENEGATIVE
Constant :
DCPAM_ENEGATIVE = -3000 :integer, parameter, public
DCPAM_ENMLARRAYINSUFF
Constant :
DCPAM_ENMLARRAYINSUFF = -3007 :integer, parameter, public
DCPAM_ENOTINIT
Constant :
DCPAM_ENOTINIT = -3003 :integer, parameter, public
DCPAM_ENOVARDEF
Constant :
DCPAM_ENOVARDEF = -3004 :integer, parameter, public
Subroutine :
number :integer, intent(in)
: エラーコード. Error code
where :character(*), intent(in)
: エラー発生個所. Place where error occurs
err :logical, intent(out), optional
: 例外処理用フラグ. デフォルトでは, number に非エラーコード 以外の値が与えられた場合, エラーメッセージを 表示してプログラムは強制終了します. 引数 err が与えられる場合, プログラムは強制終了せず, 代わりに err に .true. が代入されます.

Exception handling flag. By default, when error code (excluding non error code) is given to number, the program display error message and aborts. If this err argument is given, .true. is substituted to err and the program does not abort.

cause_c :character(*), intent(in), optional
: 文字型メッセージ. Character message
cause_i :integer, intent(in), optional
: 整数型メッセージ. Integer message

dcpam 用エラー処理サブルーチン

基本的な使用方法は gt4f90io の dc_error モジュールの StoreError と同様です. このモジュールで提供される StoreError は dcpam 用のエラーコードを使用可能です.

Error handling subroutine for dcpam

Usage is same as StoreError provided by dc_error module in gt4f90io library. This StoreError can treat error codes for dcpam.

[Source]

  subroutine StoreError( number, where, err, cause_c, cause_i )
    !
    !== dcpam 用エラー処理サブルーチン
    !
    ! 基本的な使用方法は gt4f90io の dc_error モジュールの
    ! StoreError と同様です. このモジュールで提供される StoreError
    ! は dcpam 用のエラーコードを使用可能です.
    !
    !== Error handling subroutine for dcpam
    !
    ! Usage is same as StoreError provided by dc_error module in 
    ! gt4f90io library. This StoreError can treat error codes for 
    ! dcpam.
    !
    use dc_error, only: StoreErrorOrg => StoreError
    use dc_types, only: STRING
    implicit none
    integer, intent(in):: number
                              ! エラーコード. 
                              ! Error code
    character(*), intent(in):: where
                              ! エラー発生個所. 
                              ! Place where error occurs
    logical, intent(out), optional:: err
                              ! 例外処理用フラグ.
                              ! デフォルトでは, *number* に非エラーコード
                              ! 以外の値が与えられた場合, エラーメッセージを
                              ! 表示してプログラムは強制終了します.
                              ! 引数 *err* が与えられる場合,
                              ! プログラムは強制終了せず, 代わりに
                              ! *err* に .true. が代入されます.
                              !
                              ! Exception handling flag. 
                              ! By default, when error code (excluding 
                              ! non error code) is given to *number*, 
                              ! the program display error message and aborts. 
                              ! If this *err* argument is given, 
                              ! .true. is substituted to *err* and 
                              ! the program does not abort. 
    character(*), intent(in), optional:: cause_c
                              ! 文字型メッセージ. 
                              ! Character message
    integer, intent(in), optional:: cause_i
                              ! 整数型メッセージ. 
                              ! Integer message
    character(STRING):: cause_string, msg
    integer:: cause_int
  continue
    if (present(cause_c)) then
      cause_string = cause_c
    else
      cause_string = ''
    end if
    if (present(cause_i)) then
      cause_int = cause_i
    else
      cause_int = 0
    end if

    select case(number)
      case(DCPAM_ENEGATIVE)
        msg = ' negative value is invalid for (' // trim(cause_string) // ')'
        call StoreErrorOrg(number, where, err, cause_c=msg)
      case(DCPAM_EARGLACK)
        msg = ' lack of arguments (' // trim(cause_string) // ')'
        call StoreErrorOrg(number, where, err, cause_c=msg)
      case(DCPAM_EALREADYINIT)
        msg = ' object (' // trim(cause_string) // ') is already initialized'
        call StoreErrorOrg(number, where, err, cause_c=msg)
      case(DCPAM_ENOTINIT)
        msg = ' object (' // trim(cause_string) // ') is not initialized'
        call StoreErrorOrg(number, where, err, cause_c=msg)
      case(DCPAM_ENOVARDEF)
        msg = ' variable (' // trim(cause_string) // ') is not defined'
        call StoreErrorOrg(number, where, err, cause_c=msg)
      case(DCPAM_EARGSIZEMISMATCH)
        msg = ' arguments (' // trim(cause_string) // ') array size mismatch'
        call StoreErrorOrg(number, where, err, cause_c=msg)
      case(DCPAM_ELMAXMISMATCH)
        msg = ' <all wavenum> - <zonal wavenum> is over the meridonal wavenum' // trim(cause_string) // ')'
        call StoreErrorOrg(number, where, err, cause_c=msg)
      case(DCPAM_ENMLARRAYINSUFF)
        msg = ' size of array (' // trim(cause_string) // ') in NAMELIST group is insufficient'
        call StoreErrorOrg(number, where, err, cause_c=msg)
      case default
        call StoreErrorOrg(number, where, err, cause_c, cause_i)
    end select

  end subroutine StoreError

Private Instance methods

version
Constant :
version = ‘$Name: dcpam4-20070731 $’ // ‘$Id: dcpam_error.f90,v 1.3 2007/07/26 06:13:28 morikawa Exp $‘ :character(*), parameter

[Validate]