1.付録A:netcdf.rb仕様書

目的:netCDFファイルのC言語インターフェースをrubyを用いて簡易に使用できるよう作成した。

構成

NetCDF

クラスメソッド

NetCDF.open(filename, mode="r", share=false)

ファイルオープン(クラスメソッド)mode="w" でファイルが存在しなければ新規作成

引数

戻り値

拡張ライブラリ中のC言語の関数名

NetCDF.new

openメソッドのエイリアスであるのでopenを参照のこと

NetCDF.create(filename, noclobber=false, share=false)

netCDFファイルを作る(クラスメソッド)

引数

戻り値

拡張ライブラリ中のC言語の関数名

インスタンスメソッド

close

ファイルクローズ

引数

戻り値

拡張ライブラリ中のC言語の関数名

ndims

次元の数

引数

戻り値

拡張ライブラリ中のC言語の関数名

nvars

変数の数

引数

戻り値

拡張ライブラリ中のC言語の関数名

natts

グローバル属性の数

引数

戻り値

拡張ライブラリ中のC言語の関数名

unlimited

unlimited-dimensionを返す

引数

戻り値

拡張ライブラリ中のC言語の関数名

path

NetCDFクラスのオブジェクトの指すファイルのパス

引数

戻り値

拡張ライブラリ中のC言語の関数名

redef

define modeにする。

引数

戻り値

拡張ライブラリ中のC言語の関数名

enddef

define modeを解除

引数

戻り値

拡張ライブラリ中のC言語の関数名

sync

ディスクと同期

引数

戻り値

拡張ライブラリ中のC言語の関数名

def_dim(dimension_name, length)

dimensionを定義

引数

戻り値

拡張ライブラリ中のC言語の関数名

put_att(attribute_name, value, atttype=nil)

global attributeを設定

引数

戻り値

拡張ライブラリ中のC言語の関数名

def_var(variable_name, vartype, dimensions)

変数を定義

引数

戻り値

拡張ライブラリ中のC言語の関数名

var(var_name)

既存の変数をオープン

引数

戻り値

拡張ライブラリ中のC言語の関数名

dim(dimension_name)

既存の次元をオープン

引数

戻り値

拡張ライブラリ中のC言語の関数名

att(attribute_name)

既存のglobal-attributeをオープン

引数

戻り値

拡張ライブラリ中のC言語の関数名

fill=(filemode)

fillmodeの設定

引数

戻り値

拡張ライブラリ中のC言語の関数名

each_dim{ ... }

全次元(NetCDFDim)に関するイテレータ

引数

戻り値

拡張ライブラリ中のC言語の関数名

each_var{ ... }

全変数(NetCDFVar)に関するイテレータ

引数

戻り値

拡張ライブラリ中のC言語の関数名

each_att{ ... }

全属性(NetCDFAtt)に関するイテレータ

引数

戻り値

拡張ライブラリ中のC言語の関数名

dim_names

NetCDFクラスのオブジェクトの中にある、次元の名前をすべてあげて、配列に入れて返す。

引数

戻り値

拡張ライブラリ中のC言語の関数名

var_names

NetCDFクラスのオブジェクトの中にある、変数の名前をすべてあげて、配列に入れて返す。

引数

戻り値

拡張ライブラリ中のC言語の関数名

att_names

NetCDFクラスのオブジェクトの中にある、attributeの名前をすべてあげて、配列に入れて返す。 引数

戻り値

拡張ライブラリ中のC言語の関数名

NetCDFDim

クラスメソッド

インスタンスメソッド

length

長さを返す

引数

戻り値

拡張ライブラリ中のC言語の関数名

name=(dimension_newname)

名前をつけかえる

引数

戻り値

拡張ライブラリ中のC言語の関数名

name

名前を返す

引数

戻り値

拡張ライブラリ中のC言語の関数名

unlimited?

無制限次元か?

引数

戻り値

拡張ライブラリ中のC言語の関数名

NetCDFAtt

クラスメソッド

インスタンスメソッド

name

Attributeの名前を問う

引数

戻り値

拡張ライブラリ中のC言語の関数名

name=(attribute_newname)

Attributeの名前を定義

引数

戻り値

拡張ライブラリ中のC言語の関数名

copy

Attributeをコピー

引数

戻り値

拡張ライブラリ中のC言語の関数名

delete

Attributeを削除

引数

戻り値

拡張ライブラリ中のC言語の関数名

put(value, atttype=nil)

Attributeの中身を入れる。

引数

戻り値

拡張ライブラリ中のC言語の関数名

get

Attributeの中身を取り出す

引数

戻り値

拡張ライブラリ中のC言語の関数名

atttype

Attributeの種類を問う

引数

戻り値

拡張ライブラリ中のC言語の関数名

NetCDFVar

クラスメソッド

インスタンスメソッド

dim(dim_num)

NetCDFVarクラスのオブジェクトから指定されたdimensionのNetCDFDimオブジェクトを取り出す。

引数

戻り値

拡張ライブラリ中のC言語の関数名

dims

NetCDFVarクラスのオブジェクトが指す変数中のdimensionsに対応するNetCDFDimオブジェクトを全て取り出す.

引数

戻り値

拡張ライブラリ中のC言語の関数名

each_att{ ... }

全属性(NetCDFAtt)に関するイテレータ

引数

戻り値

拡張ライブラリ中のC言語の関数名

dim_names

dimensionの名前を全てあげて配列に入れて返す。

引数

戻り値

拡張ライブラリ中のC言語の関数名

att_names

attributeの名前を全てあげて配列に入れて返す。

引数

戻り値

拡張ライブラリ中のC言語の関数名

name

名前を問う

引数

戻り値

拡張ライブラリ中のC言語の関数名

name=(variable_newname)

名前を付け替える

引数

戻り値

拡張ライブラリ中のC言語の関数名

ndims

次元の数を問う

引数

戻り値

拡張ライブラリ中のC言語の関数名

vartype

変数の種類を問う

引数

戻り値

拡張ライブラリ中のC言語の関数名

natts

attributeの数を問う

引数

戻り値

拡張ライブラリ中のC言語の関数名

file

NetCDFVarオブジェクトがもともと属するNetCDFオブジェクトを取り出す。 引数

戻り値

拡張ライブラリ中のC言語の関数名

att(attribute_name)

NetCDFVarオブジェクトからNetCDFAttオブジェクトを取り出す。

引数

戻り値

拡張ライブラリ中のC言語の関数名

put_att(attribute_name, value, atttype=nil)

attributeを設定

引数

戻り値

拡張ライブラリ中のC言語の関数名

put(value, option=nil)

値を入れる

引数

戻り値

拡張ライブラリ中のC言語の関数名

get(option=nil)

値を取り出す

引数

戻り値

拡張ライブラリ中のC言語の関数名