Main Content

hdfan

マルチファイル形式の HDF 注釈 (AN) インターフェイスへのゲートウェイ

構文

[out1,...,outN] = hdfan(funcstr,input1,...,inputN)

説明

hdfan はマルチファイル形式の HDF 注釈 (AN) インターフェイスへの MATLAB® ゲートウェイです。

[out1,...,outN] = hdfan(funcstr,input1,...,inputN) は、functstr で指定された HDF ライブラリの AN 関数に対応する 1 つ以上の出力値を返します。

HDF ライブラリの AN 関数と funcstr の有効値の間には 1 対 1 の対応があります。たとえば、hdfan('endaccess',annot_id) はC ライブラリの呼び出し ANendaccess(annot_id) に相当します。

アクセス関数

アクセス関数は、インターフェイスの初期化、および注釈へのアクセスの提供や停止を行います。

funcstr の値関数構文説明
'start'AN_id = hdfan('start',file_id)

マルチファイル形式の注釈インターフェイスを初期化します。

'select'annot_id = hdfan('select',AN_id, index,annot_type)

指定されたインデックス値と注釈タイプによって識別される注釈の識別子を選択して返します。

'end'status = hdfan('end',AN_id)

マルチファイル形式の注釈インターフェイスへのアクセスを停止します。

'create'annot_id = hdfan('create',AN_id,tag,ref,annot_type)

指定されたタグと参照番号によって識別されるオブジェクトのデータ注釈を作成します。annot_type'data_label' または 'data_desc' のいずれかです。

'createf'annot_id = hdfan('createf',AN_id,annot_type)

ファイル ラベルまたはファイル説明の注釈を作成します。annot_type'file_label' または 'file_desc' のいずれかです。

'endaccess'status = hdfan('endaccess',annot_id)

注釈へのアクセスを停止します。

読み取り/書き込み関数

読み取り/書き込み関数は、ファイルやオブジェクトの注釈の読み取りや書き込みを行います。

funcstr の値関数構文説明
'writeann'status = hdfan('writeann',annot_id,annot_string)

指定された注釈識別子に対応する注釈を書き込みます。

'readann'[annot_string,status] = hdfan('readann',annot_id)

指定された注釈識別子に対応する注釈を読み取ります。

[annot_string,status] = hdfan('readann',annot_id,max_str_length)

指定された注釈識別子に対応する注釈を読み取ります。annot_stringmax_str_length 以内になります。

一般的な問い合わせ関数

一般的な問い合わせ関数は、ファイル内の注釈に関する情報を返します。

funcstr の値関数構文説明
'numann'num_annot = hdfan('numann',AN_id,annot_type,tag,ref)

指定されたタグと参照番号のペアに対応する指定されたタイプの注釈の数を取得します。

'annlist'[ann_list,status] = hdfan('annlist',AN_id,annot_type,tag,ref)

指定されたタグと参照番号のペアに対応するファイル内の指定されたタイプの注釈のリストを取得します。

'annlen'length = hdfan('annlen',annot_id)

指定された注釈識別子に対応する注釈の長さを取得します。

'fileinfo'[nfl,nfd,ndl,ndd,status] = hdfan('fileinfo',AN_id)

AN_id に対応するファイル内のファイル ラベル、ファイルの説明、データ ラベル、データの説明の注釈の数を取得します。

'get_tagref'[tag,ref,status] = hdfan('get_tagref',AN_id,index,annot_type)

指定された注釈のタイプとインデックスに対するタグと参照番号のペアを取得します。

'id2tagref'[tag,ref,status] = hdfan('id2tagref',annot_id)

指定された注釈識別子に対応するタグと参照番号のペアを取得します。

'tagref2id'annot_id = hdfan('tagref2id',AN_id,tag,ref)

指定されたタグと参照番号のペアに対応する注釈識別子を取得します。

'atype2tag'tag = hdfan('atype2tag',annot_type)

指定された注釈のタイプに対応するタグを取得します。

'tag2atype'annot_type = hdfan('tag2atype',tag)

指定されたタグに対応する注釈のタイプを取得します。

入力引数と出力引数

status または識別子出力が -1 の場合は、操作が失敗したことを示します。

一般に、入力引数 annot_type には、次の値のいずれかを指定できます。

  • 'file_label'

  • 'file_desc'

  • 'data_label'

  • 'data_desc'

AN_id はマルチファイル形式の注釈インターフェイス識別子を表しています。

annot_id は個別の注釈識別子を表しています。

hdfan('end',AN_id) または hdfan('endaccess',annot_id) を使用して、開いているすべての識別子に対するアクセスを停止しなければなりません。そうしないと、HDF ライブラリはファイルにデータをすべて正しく書き込むことができない場合があります。

バージョン履歴

R2006a より前に導入