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

Subroutine: HistoryAddVariable

【変数定義】

2004/11/29 森川靖大


概要

サブルーチン HistoryAddVariable は、 gtool4 データ内の変数の定義を行います。 なお、このサブルーチンを用いる前に、 HistoryCreate による初期設定が必要です。

なお、既に gtool4 データが存在し、 そのデータ内の変数と全く同じ構造の変数を定義したい場合は HistoryCopyVariable を利用すると便利です。

書式

call HistoryAddVariable(varname, dims, longname, units, [xtype], [history])
	  
call HistoryAddVariable(varinfo, [history])

引数

※ 以下には、1) 引数、2) 変数か配列か、3) データ型、4)引数の説明 が記してある。なお、[配列(*)]の括弧内は配列の次元を表しており、 [配列(2)]ならば2次元の配列を意味する。 また、[実数型(単)]は単精度実数型を、 [実数型(倍)]は倍精度実数型を表す。
  • varinfo
  •    [変数] [GT_HISTORY_VARINFO型]    変数情報を格納した構造型変数。 構造型の詳細や設定の例は GT_HISTORY_VARINFO を参照のこと。
  • varname
  •    [変数] [文字型]    定義する変数の名前。 文字数は32まで。
  • dims
  •    [配列(1)] [文字型]    変数が依存する次元の名前。 配列の大きさは1〜4まで指定可能。 (ただし、時間の次元を含まない場合は1〜3)。 また、時間の次元は配列の最後に指定しなければならない。 なお、ここで指定するものは、 HistoryCreate にてdimsで指定されていなければならない。
  • longname
  •    [変数] [文字型]    varnameで指定した変数の長い方の名前。 文字数は500まで。
  • units
  •    [変数] [文字型]    varnameで指定した変数の単位。 文字数は500まで。
  • [xtype]
  •    [変数] [文字型]    varnameで指定した変数のデータ型。 デフォルトはfloat (単精度実数型)である。 有効なのは、double (倍精度実数型)、 int (整数型)である。 指定しない場合や、無効な型を指定した場合には、 float (単精度実数型)となる。
  • [history]
  •    [変数] [GT_HISTORY型]    出力するファイルの変数。 ここに指定するものは、 HistoryCreate にてhistoryで指定されていなければならない。