dbStore利用方法 for PV-WAVE/IDL

ver.16.0.1　'12.8.27現在

計測データまたはパラメータを保存するには、データを作成後、dbStoreで保存します。

• 事前準備
• ショットデータ・パラメータデータを準備する
• データを保存する

事前準備

• 参照サイトを変更する
• テンポラリファイルの作成場所を変更する

Retrieve+dbStoreをインストールすると、参照サイトが自動的に「LHD」に設定されます。デフォルトの参照サイトを変更したい場合はこちらをご覧ください。

dbStoreはテンポラリファイルを作成します。デフォルトではカレントディレクトリに作成します。
テンポラリファイルを作成するディレクトリを変更したい場合は、次の手順に沿って環境変数 「DBSTORE_TMP」を作成してください。 （インストール時には環境変数 「DBSTORE_TMP」は作成されません）

1. コントロールパネルで「システム」を選択します。
2. 「システムのプロパティ」ダイアログが表示されますので、「詳細設定」タブの中にある「環境変数」をクリックします。
3. 「環境変数」ダイアログが表示されますので、システム環境変数で「新規」をクリックします。
4. 変数名に「DBSTORE_TMP」、変数値にテンポラリファイルを作成するディレクトリを指定し「OK」をクリックします。
5. 「環境変数」ダイアログでもう一度「OK」、「システムのプロパティ」ダイアログでも「OK」をクリックします。

ショットデータ・パラメータデータを準備する

ショットデータとパラメータデータの2種類を準備します。どちらか1つでもデータは保存できます。

バイナリ配列データ、またはフレームに対応したカメラ画像データを保存します。

例）
data = indgen(131072)

登録するパラメータ数を指定しInitParamListでパラメータリストを作成します。
その後SetParamでパラメータを１つずつ格納します。

例）
InitParamList, ParamArr, 2
SetParam, ParamArr, 'ClockSpeed', 10000, 'INTEGER', code
SetParam, ParamArr, 'MemorySize', 131072, 'INTEGER', code

• InitParamList : チャネルデータに関するパラメータリストpStrArrを初期化します。
  
  InitParamList, pStrArr, NumParam
  
  

  pStrArr :	[out] パラメータリスト領域
  NumParam :	[in] パラメータ数

  
  
• SetParam : パラメータリストpStrArrに各パラメータを１つずつ一時格納します。
  
  SetParam, pStrArr, KeyName, Value, ValType, code
  
  

  pStrArr :	[in/out] パラメータリスト領域
  KeyName :	[in] パラメータ名
  Value :	[in] パラメータ値
  ValType :	[in] パラメータ値のデータ型 … 'STRING', 'BYTE', 'SHORT', 'INT', 'FLOAT', 'DOUBLE', 'INT64'から1つ指定
  code :	[out] 関数の返り値

  ・成功したら、codeに0が、エラーの場合は、負の値（エラーコード）が戻ります。

データを保存する

ショットデータ（バイナリ配列データ、またはフレームに対応したカメラ画像データ）とパラメータデータをdbStoreで保存します。
ショットデータまたはパラメータを空で登録する場合は、変数名nullを使用します。
ショットデータの登録処理を途中でキャンセルすることもできます。
また、エラーコードをエラーメッセージに変換するコマンドもあります。

dbsOpenでショットデータの登録を開始し、チャネルデータ数分dbsWriteを繰り返します。dbsCloseでショットデータの登録を終了します。

例）
dbsOpen, des, '','LABCOM', 49001, 1, 'RAW', code
dbsWrite, des, 1, ParamArr, data, 'INT16', code
dbsClose, des, code

• dbsOpen : ショットデータの登録を開始します。
  

  dbsOpen, dbs_des, MailAddress, DiagName, ShotNumber, SubShotNumber, DataType, code[, cndb_timeout=t][, cndb_retry=n]

  dbs_des :	[out] dbs識別子
  Mailaddress :	[in] メールアドレス（＝登録者ID）
  DiagName :	[in] データ名（Bolometer, Halpha, ...）
  ShotNo :	[in] ショット番号
  SubShotNo :	[in] サブショット番号
  DataType :	[in] データタイプ（'RAW','ANA'...）
  cndb_timeout=t :	[in ]データベース接続のタイムアウトをt秒にする default: 5
  cndb_retry=n :	[in ] データベース接続のエラー時にn回リトライする default: 3
  code :	[out] 関数の返り値

  ・成功したら、codeに0が、dbs_desにdbs識別子(0<)が戻ります。
    また、エラーの場合には codeにエラーコード(0>)が戻ります。
• dbsWrite : 各チャネルデータを内部的に一時格納します。

  dbsWrite, dbs_des, ChannelNumber, pStrArr, pDataArray, ImageType, code

  dbs_des :	[in] dbs識別子
  ChannelNumber :	[in] チャネル番号
  pStrArr :	[in] パラメータリスト
  pDataArr :	[in] チャネル配列データ
  ImageType :	[in] チャネル配列データのデータ型　※補足参照
  code :	[out] 関数の返り値

  ・成功したら、codeに0が、エラーの場合は、負の値（エラーコード）が戻ります。
  ・配列データ(pDataArr)の長さは、配列のサイズそのものになります。
  ・配列データ(pDataArr)またはパラメータ(pStrArr)を空で登録する場合は、変数名nullを使用してください。null は予約語ですので、他の変数名にnullは使用できません。
  ・pStrArrは、dbsWriteのコール後、変更されません。
  ・チャネル数分、dbsWriteを呼び出してください。

  ※【補足】ImageTypeパラメータ : データファイルのデータの型を指定します。

  "INT8" :	8ビット整数
  "INT16" :	16ビット整数
  "INT32" :	32ビット整数
  "INT64" :	64ビット整数
  "FLT32" :	32ビット浮動少数点
  "FLT64" :	64ビット浮動少数点
  "GRAYn" :	nビットグレースケール画像（n:8～16）　例）'GRAY8'
  "RGB" :	24ビットカラー画像（RGBの順が変更可) 例）'BGR'
  "ARGB" :	32ビットカラー画像（ARGBの順が変更可) 例）'BGRA'

• dbsClose : 内部的に一時格納した登録データを転送します。データ転送が正常に終了すると、index DB にデータ情報が登録されます。

  dbsClose, dbs_des, code

  dbs_des :	[in] dbs識別子
  code :	[out] 関数の返り値

  ・成功したら、codeに0が、エラーの場合は、負の値（エラーコード）が戻ります。

まず、dbsOpenでショットデータの登録開始を宣言します。
次にdbsOpenFrameでフレームデータの登録を開始し、フレームデータ数分dbsWriteFrameを繰り返します。
dbsCloseFrameでフレームデータを終了します。
最後にdbsCloseでショットデータの登録を終了します。

例）
dbsOpen, des, '','LABCOM', 49002, 1, 'RAW', code
dbsOpenFrame, des, 1, 640, 480, 'GRAY8', code
dbsWriteFrame, des, 1, 1, data(*, *, 0), code
dbsCloseFrame, des, 1, null, code
dbsClose, des, code

• dbsOpenFrame : フレームデータの登録開始を開始します。

  dbsOpenFrame, dbs_des, ChannelNumber, SizeX, SizeY, ImageType, code[,/accept_sizes]

  dbs_des :	[in] dbs識別子
  ChannelNumber :	[in] チャネル番号
  SizeX :	[in] フレームのX方向サイズ
  SizeY :	[in] フレームのY方向サイズ
  ImageType :	[in] チャネル配列データのデータ型  ※補足参照
  /accept_sizes :	[in] XYサイズと異なるサイズのデータを保存する default: しない
  code :	[out] 関数の返り値

  ・成功したら、codeに0が、エラーの場合は、負の値（エラーコード）が戻ります。
• dbsWriteFrame : 各フレームデータの格納をします。
  

  dbsWriteFrame, dbs_des, ChannelNumber, FrameNumber, pDataArray, code

  dbs_des :	[in] dbs識別子
  ChannelNumber :	[in] チャネル番号
  FrameNumber :	[in] フレーム番号
  pDataArray :	[in] フレームデータ
  code :	[out] 関数の返り値

  ・成功したら、codeに0が、エラーの場合は、負の値（エラーコード）が戻ります。
  ・配列データ(pDataArr)の長さは、配列のサイズそのものになります。また、dbsOpenFrameで指定したフレームサイズと一致する（画像）もしくは、フレームサイズ以下（画像以外）である必要があります。
  ・フレーム数分、dbsWriteFrameを呼び出してください。
• dbsWriteFrame : 各フレームデータの格納をします。

  dbsWriteFrame, dbs_des, ChannelNumber, FrameNumber, pDataArray, code

  dbs_des :	[in] dbs識別子
  ChannelNumber :	[in] チャネル番号
  FrameNumber :	[in] フレーム番号
  pDataArray :	[in] フレームデータ
  code :	[out] 関数の返り値

  ・成功したら、codeに0が、エラーの場合は、負の値（エラーコード）が戻ります。
  ・配列データ(pDataArr)の長さは、配列のサイズそのものになります。また、dbsOpenFrameで指定したフレームサイズと一致する（画像）もしくは、フレームサイズ以下（画像以外）である必要があります。
  ・フレーム数分、dbsWriteFrameを呼び出してください。
• dbsWriteFrames : 複数のフレームデータの格納をします。

  dbsWriteFrames ,dbs_des ,ChannelNumber ,StartFrame ,NumFrame ,pDataArray ,code

  dbs_des :	[in] dbs識別子
  ChannelNumber :	[in] チャネル番号
  StartFrame :	[in] 開始フレーム番号
  NumFrame :	[in] フレーム数
  pDataArray :	[in] フレームデータ
  code :	[out] 関数の返り値

  ・成功したら、codeに0が、エラーの場合は、負の値（エラーコード）が戻ります。
  ・配列データ(pDataArr)の長さは、配列のサイズそのものになります。また、dbsOpenFrameで指定したフレームサイズ×フレーム数である必要があります。
• dbsCloseFrame : ショットデータの正常終了処理を行います。

  dbsCloseFrame ,dbs_des ,ChannelNumber ,pStrArr ,code

  dbs_des :	[in] dbs識別子
  ChannelNumber :	[in] チャネル番号
  pStrArray :	[in] パラメータリスト
  code :	[out] 関数の返り値

  ・成功したら、codeに0が、エラーの場合は、負の値（エラーコード）が戻ります。
  ・パラメータリストの作成方法は、パラメータの準備と同じです。
  ・パラメータリスト(pStrArr)を空で登録する場合は、変数名nullを使用してください。
    null は予約語ですので、他の変数名にnullは使用できません。
  ・pStrArrは、dbsCloseFrameのコール後、変更されません。

途中でショットデータの登録をキャンセルするには、dbsAbortでキャンセルします。

例）
dbsOpen, des, '','LABCOM', 49001, 1, 'RAW', code
dbsWrite, des, 1, null, data, 'INT16', code
dbsAbort, des

• dbsAbort : ショットデータの登録処理をキャンセルします。

  dbsAbort, dbs_des

  dbs_des :	[in] dbs識別子

エラーコードをdbs_messageでエラーメッセージに変換します。

例）
dbsOpen, des, '', 'LAB', 1, 1, 'RAW', code
dbs_message, code

• dbs_message : エラーコードのメッセージ変換

  dbs_message, errorCode [,error_mes]

  errorCode :	[in ] エラーコード
  error_mes :	[out] エラーメッセージ

  ・error_mesがない場合、メッセージをprintする

この Web に関する問題または質問等については，LABCOM までご連絡下さい．