gt4f90io リファレンスマニュアル

エラーの取り扱い

2004/12/24 森川靖大

概要

プログラムの部品は必ずエラーの取り扱いを明確に規定すべきものである。 エラーとは当該部品への入力が不適切であるとか、 期待される動作をすることができないといった事態である。

gt4f90io ライブラリがユーザに提供する手続 (手続とはサブルーチンまたは関数の総称) はほとんどの場合、以下の2つの方式のいずれかで呼び出し元にエラーを報告する。

• エラーが発生すると適切なメッセージを表示してプログラム終了
• 論理型の省略できる引数 err が与えられた場合は、 エラー時にはそれを真にする。err が省略された場合は上に同じ。

これらの処理はすべて dc_error モジュールの StoreError サブルーチンで行っている。StoreError は以下のような引用仕様を持つ。

subroutine StoreError(number, where, err, cause_c, cause_i)

    use dc_string

    integer     , intent(in)            :: number  ! エラーコード
    character(*), intent(in)            :: where   ! エラー発生
    logical     , intent(out), optional :: err
    character(*), intent(in),  optional :: cause_c ! 文字型メッセージ
    integer     , intent(in),  optional :: cause_i ! 整数型メッセージ

end subroutine

必要な引数は2つであり、第1引数 number は整数型のエラーコード、 第2引数 where は文字型でエラーの発生した手続名を与える。 デフォルトでは以下の形式の文字列が標準出力 に表示されてプログラムは終了する。 エラーメッセージ error_message はエラーコードから自動的に決まる。 対応表がエラーコード一覧にあるので参照の事。

なお、gt4f90io の ライブラリ外 からユーザがエラー処理用ツール として StoreError を用いることを想定し、 USR_ECHAR および USR_INT を用意した。 このエラーコードを用いると、StoreError は以下の形式の文字列を 標準出力に出力してプログラムを終了させる。 なお、より安易に使えるラッパーとして dc_message モジュールを 用意してあるのでそちらも参照の事。

エラーコード一覧

gt4f90io ライブラリにコードを追加するプログラマは適切なエラーコードで StoreError を呼び出すようにしなければならない。そこで、 新しいエラーコードを定義する必要があるかどうかを判定するために、 エラーコードの値と対応するメッセージを一覧する。 エラーコードニーモニックを使用するためには、NF_E で始まる名前については netcdf_f77 モジュールを引用するか include 'netcdf.inc' を行い （後者は推奨されない）、GT_E で始まる名前については dc_error モジュールを引用する。また USR_E で始まる名前は各々のユーザが定義して良いエラーコードである。

エラーコードの数値の欄を設けたのは、 新たなエラーコードを割り当てる際の指針を示すためである。 コードではエラーコードをニーモニックで与えるべきであり、 数値をハードコードすることは厳に慎まれたい。

利用しないコード

netCDF に関するエラーコード

gtool4 のデータ構造に関するエラーコード

gtool4 の可視化に関するエラーコード

GrADS に関するエラーコード

gtool4 に関して予約してあるエラーコード

ユーザ定義用エラーコード