dc_message::messagenotify Interface Reference

Public Member Functions
subroutine	messagenotifyc (level, where, message, i, r, d, l, n, c1, c2, c3, ca, rank_mpi)
subroutine	messagenotifyi (number, where, message, i, r, d, l, n, c1, c2, c3, ca, rank_mpi)

Detailed Description

Definition at line 60 of file dc_message.f90.

Member Function/Subroutine Documentation

messagenotifyc()

subroutine dc_message::messagenotify::messagenotifyc	(	character(*), intent(in)	level,
		character(*), intent(in)	where,
		character(*), intent(in)	message,
		integer, dimension(:), intent(in), optional	i,
		real, dimension(:), intent(in), optional	r,
		real(dp), dimension(:), intent(in), optional	d,
		logical, dimension(:), intent(in), optional	l,
		integer, dimension(:), intent(in), optional	n,
		character(*), intent(in), optional	c1,
		character(*), intent(in), optional	c2,
		character(*), intent(in), optional	c3,
		character(*), dimension(:), intent(in), optional	ca,
		integer, intent(in), optional	rank_mpi
	)

メッセージの出力およびエラーによる終了

メッセージを標準出力へ出力したい場合に用います。

文字型変数 where にはプログラム名 (サブルーチン名) など、 プログラム内のどこでメッセージを出力するのかを示すものを与えます。

文字型変数 message には、出力したい文字列を与えます。 オプション変数 i, r, d, L, s, n, c1, c2, c3 を付加する事も出来ます。 詳細に関しては dc_string::CPrintf を参照して下さい。

文字型変数 level は出力するメッセージの種類を決める引数で、

• "W" (または "Warning" など "W" で始まる文字) を与える事で 警告 であることを指定
• "E" (または "Error" など "E" で始まる文字) を与える事で エラー (メッセージ出力後プログラムを終了) であることを指定
• それ以外の文字 (大抵は "M" を与えることを想定) を与える事で 通常のメッセージ であることを指定

"E" を与えた場合はメッセージ出力後、プログラムを強制終了させます。 エラーコードは dc_error::USR_ERRNO となります。

Parameters

[in]	level	メッセージレベル ("E", "W", "M" のいずれか)
[in]	where	プログラム名、手続き名
[in]	message	メッセージ
[in]	i	フォーマット用整数配列
[in]	r	フォーマット用実数配列
[in]	d	フォーマット用倍精度実数配列
[in]	L	フォーマット用論理配列
[in]	n	フォーマット用整数配列
[in]	c1	フォーマット用文字列1
[in]	c2	フォーマット用文字列2
[in]	c3	フォーマット用文字列3
[in]	ca	フォーマット用文字列配列
[in]	rank_mpi	MPI 使用時に、ここで指定されたランク数のノードでのみ メッセージ出力を行います。負の値を与えた場合には、 全てのノードで出力を行います。MPI を使用していない場合には無視されます。

Definition at line 142 of file dc_message.f90.

    use dc_types  ,only: string, dp
    use dc_string ,only: uchar, strhead, printf, cprintf
    use dc_error  ,only: storeerror, usr_errno
    implicit none
    character(*), intent(in)          :: level
    character(*), intent(in)          :: where
    character(*), intent(in)          :: message
    integer     , intent(in), optional:: i(:), n(:)
    real        , intent(in), optional:: r(:)
    real(DP)    , intent(in), optional:: d(:)
    logical     , intent(in), optional:: L(:)
    character(*), intent(in), optional:: c1, c2, c3
    character(*), intent(in), optional:: ca(:)
    integer     , intent(in), optional:: rank_mpi
    character(string)        :: msg
  continue
    if ( invalid_rank_number( rank_mpi ) ) return
    if (   strhead(  'ERROR', trim( uchar(level) )  )   ) then
      msg = cprintf(message, &
        &           i=i, r=r, d=d, l=l, n=n, c1=c1, c2=c2, c3=c3, ca=ca)
      call storeerror(usr_errno, where, cause_c=msg)
    elseif (   strhead(  'WARNING', trim( uchar(level) )  )   ) then
      msg = cprintf(message, &
        &           i=i, r=r, d=d, l=l, n=n, c1=c1, c2=c2, c3=c3, ca=ca)
      msg=' *** WARNING [' // trim(where) // '] ***  '// trim(msg)
      call printf(fmt='%c', c1=msg)
    else
      msg = cprintf(message, &
        &           i=i, r=r, d=d, l=l, n=n, c1=c1, c2=c2, c3=c3, ca=ca)
      msg=' *** MESSAGE [' // trim(where) // '] ***  ' // trim(msg)
      call printf(fmt='%c', c1=msg)
    endif
    return

References dc_types::dp, dc_error::storeerror(), dc_types::string, and dc_error::usr_errno.

Here is the call graph for this function:

messagenotifyi()

subroutine dc_message::messagenotify::messagenotifyi	(	integer, intent(in)	number,
		character(*), intent(in)	where,
		character(*), intent(in), optional	message,
		integer, dimension(:), intent(in), optional	i,
		real, dimension(:), intent(in), optional	r,
		real(dp), dimension(:), intent(in), optional	d,
		logical, dimension(:), intent(in), optional	l,
		integer, dimension(:), intent(in), optional	n,
		character(*), intent(in), optional	c1,
		character(*), intent(in), optional	c2,
		character(*), intent(in), optional	c3,
		character(*), dimension(:), intent(in), optional	ca,
		integer, intent(in), optional	rank_mpi
	)

メッセージの出力およびエラーによる終了 (エラーコード版)

基本的にもう一方の MessageNotify (または dc_message::MessageNotifyC) と同様ですが、こちらは第１引数に数値型変数 number をとります。 この number はエラーコードとして、そのまま dc_error::StoreError に 引き渡されます。エラーコードに関しては dc_error を参照ください。

Parameters

[in]	number	エラーコード (dc_error 参照)
[in]	where	プログラム名、手続き名
[in]	message	メッセージ (省略可)
[in]	i	フォーマット用整数配列
[in]	r	フォーマット用実数配列
[in]	d	フォーマット用倍精度実数配列
[in]	L	フォーマット用論理配列
[in]	n	フォーマット用整数配列
[in]	c1	フォーマット用文字列1
[in]	c2	フォーマット用文字列2
[in]	c3	フォーマット用文字列3
[in]	ca	フォーマット用文字列配列
[in]	rank_mpi	MPI 使用時に、ここで指定されたランク数のノードでのみ メッセージ出力を行います。負の値を与えた場合には、 全てのノードで出力を行います。MPI を使用していない場合には無視されます。

Definition at line 227 of file dc_message.f90.

    use dc_types  ,only: dp
    use dc_string ,only: cprintf
    use dc_error  ,only: storeerror
    implicit none
    integer,      intent(in)          :: number
    character(*), intent(in)          :: where
    character(*), intent(in), optional:: message
    integer     , intent(in), optional:: i(:), n(:)
    real        , intent(in), optional:: r(:)
    real(DP)    , intent(in), optional:: d(:)
    logical     , intent(in), optional:: L(:)
    character(*), intent(in), optional:: c1, c2, c3
    character(*), intent(in), optional:: ca(:)
    integer     , intent(in), optional:: rank_mpi
  continue
    if ( invalid_rank_number( rank_mpi ) ) return
    if (.not. present(message)) then
      call storeerror(number, where)
    else
      call storeerror(number, where,  &
        &             cause_c=cprintf( message, &
        &             i=i, r=r, d=d, l=l, n=n, c1=c1, c2=c2, c3=c3, ca=ca )  )
    endif
    return

References dc_types::dp, and dc_error::storeerror().

Here is the call graph for this function:

---

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

• /build/gtool5-1.0.0~rc5/debian/build-serial/src/dc_utils/dc_message.f90