MQDB Library Specification ver.4 Chapter 6

ヘッダ文字列から「平均振幅」ヘッダを探し、データ文字列中のコンマ数を元にチャンネル数を判断し、必要なデータを切り出した上でMqAmp変数に格納して返す。

返値

平均振幅

6.2.2 「チャンネル数」ヘッダの読み込み

仕様

unsigned short MqGetChannels( char * )

引数

ヘッダ文字列から「チャンネル数」ヘッダを探し、情報文字列を切り出してチャンネル数に相当する数字を返す。

返値

チャンネル数

6.2.3 「データフォーマット」ヘッダの読み込み

仕様

MqFormat MqGetDataFormat( char * )

引数

「データフォーマット」ヘッダを探し、該当するデータフォーマットを読み出してそれをMqFormat変数として返す。

返値

データフォーマットを表す変数。

6.2.4 「データ種別」ヘッダの読み込み

仕様

MqType MqGetDataType( char * )

引数

「データ種別」ヘッダを探し、該当するデータ種別を読みだし、それをMqType変数として返す。

返値

データ種別を表す変数

6.2.5 「終了レコード番号」ヘッダの読み込み

仕様

unsigned long MqGetEndRecord( char * )

引数

「終了レコード番号」ヘッダを探し、情報文字列を数字に変換して返す。

返値

終了レコードを表す数字

6.2.6 ヘッダ文字列の切り出し

仕様

char * MqGetHeader( FILE * )

引数

入力ファイルからヘッダ部分を読みだし、コメント、空白部分などを削除し、ヘッダだけになった文字列を返す。正常にヘッダ文字列を切り出せなかった場合には NULLが返される。

入力ファイル記述子

返値

処理後のヘッダ文字列

6.2.7 「最大振幅」ヘッダの読み込み

仕様

MqAmp MqGetMaxAmp( char * )

引数

ヘッダ文字列から「最大振幅」ヘッダを探し、データ文字列中のコンマ数を元にチャンネル数を判断し、必要なデータを切り出した上でMqAmp変数に格納して返す。

返値

最大振幅

6.2.8 「データ個数」ヘッダの読み込み

仕様

unsigned long MqGetNumOfData( char * )

引数

「データ個数」ヘッダを探し、情報文字列を数字に変換して返す。

返値

データ個数を表す数字

6.2.9 「観測モード」ヘッダの読み込み

仕様

MqMode MqGetObsMode( char * )

引数

「観測モード」ヘッダを読み込み、情報文字列から観測モードを読みだし、MqMode変数の形で返す。

返値

観測モードを表す変数

6.2.10 「元のデータファイル名」ヘッダの読み込み

仕様

void MqGetOrgFile( char *, char * )

引数

char *	ヘッダ文字列
char *	元のファイル名

「元のデータファイル名」ヘッダを読み込み、情報文字列を元のデータファイル名として返す。

6.2.11 「サンプリング間隔」ヘッダの読み込み

仕様

MqAmp MqGetSampRate( char * )

引数

ヘッダ文字列から「サンプリング間隔」ヘッダを探し、データ文字列中のコンマ数を元にチャンネル数を判断し、必要なデータを切り出した上でMqAmp変数に格納して返す。

返値

サンプリング間隔

6.2.12 「開始レコード番号」ヘッダの読み込み

仕様

unsigned long MqGetStartRecord( char * )

引数

「開始レコード番号」ヘッダを探し、情報文字列を数字に変換して返す。

返値

開始レコード番号を表す変数

6.2.13 「データのスタート時刻」ヘッダの読み込み

仕様

MqTime MqGetStartTime( char * )

引数

「データのスタート時刻」ヘッダを探し、情報文字列を数字に変換して返す。

返値

データのスタートする時刻

6.2.14 「観測ステーション」ヘッダの読み込み

仕様

unsigned short MqReaStation( char * )

引数

「観測ステーション」ヘッダを探し、情報文字列を数字に変換して返す。

返値

観測ステーションを表す数字

6.2.15 「テープ番号」ヘッダの読み込み

仕様

unsigned short MqGetTapeNumber( char * )

引数

「テープ番号」ヘッダを探し、情報文字列を数字に変換して返す。

返値

テープ番号を表す変数

6.2.16 先頭行の読み込み

仕様

MqLibInfo MqGetTopLine( FILE * )

引数

FILE *

入力ファイルのファイル記述子

返値

ライブラリ情報構造体

指定された入力ファイルから先頭行を読み、指定されたファイルがMQDBフォーマットであるかどうかを判断する。もしMQDBフォーマットであると判断された場合には、ライブラリ番号、プログラム署名を読み出す。この判断は、先頭２文字が＠＠であるかどうかで行なう。もしMQDBフォーマットでない場合には、バージョン番号は全て 0 となり、プログラム署名の変数には NULLが返される。

6.2.17 「平均振幅」ヘッダ文字列の作成

仕様

char * MqPutAveAmp( MqAmp )

引数

返値

6.2.18 「チャンネル数」ヘッダ文字列の作成

仕様

char * MqCreChannels( unsigned short )

引数

返値

6.2.19 「データ作成日時」ヘッダ文字列の作成

仕様

void MqPutCreateDate( void )

引数

「データ作成日時」ヘッダ用の文字列を作成する。本関数は、MqCreate()内では自動的に呼び出される。

6.2.20 データ部の作成

仕様

void MqPutData( FILE *, double *, MqHeader * )

引数

FILE * double * MqHeader *

ファイル構造体

データ

ヘッダ構造体

データ部を作成する。MqHeader構造体変数に格納されているチャンネル数とデータ数の情報を用いて、データの行数を決定した後、チャンネル数に応じてデータを出力する。FILE構造体がNULLであれば、出力は標準出力に対して行なわれる。それ以外の場合には、FILE構造体変数で指定されるファイルに対して出力される。

6.2.21 「データフォーマット」ヘッダ文字列の作成

仕様

char * MqPutDataFormat( MqFormat )

引数

MqFormat構造体変数の内容に従い、「データフォーマット」ヘッダ用の文字列を作成する。

返値

「データフォーマット」ヘッダ文字列へのポインタ

6.2.22「データ種別」ヘッダの作成

仕様

char * MqPutDataType( MqType )

引数

MqType

月震のデータ種別

返値

「データ種別」ヘッダ文字列へのポインタ

MqType構造体変数の内容に従って、「データ種別」ヘッダ用の文字列を作成する。

6.2.23 「終了レコード番号」ヘッダ文字列の作成

仕様

char * MqPutEndRecord( unsigned long )

引数

引数として受けとったレコード番号から、「終了レコード番号」ヘッダ用の文字列を作成する。

終了レコード番号

返値

「終了レコード番号」ヘッダ文字列へのポインタ

6.2.24 「最大振幅」ヘッダ文字列の作成

仕様

char * MqPutMaxAmp( MqAmp )

引数

MqAmp

最大振幅

返値

「最大振幅」ヘッダ文字列へのポインタ

「最大振幅」ヘッダ用の文字列を作成する。MqAmp変数の内容を文字列化して、ヘッダ文字列に付加する。

6.2.25 「データ個数」ヘッダ文字列の作成

仕様

char * MqPutNumOfData( unsigned long )

引数

char * MqPutObsMode( MqMode )

char *	ヘッダ文字列
データ個数

返値

「データ個数」ヘッダ文字列へのポインタ

「データ個数」ヘッダ用の文字列を作成する。

6.2.26 「観測モード」ヘッダ文字列の作成

仕様

引数

MqMode

観測モード

返値

「観測モード」ヘッダ文字列へのポインタ

「観測モード」ヘッダ用の文字列を作成する。

6.2.27 「元のデータファイル名」ヘッダ文字列の作成

仕様

char * MqPutOrgFile( char * )

引数

「元のデータファイル名」ヘッダ用文字列を作成する。

元のデータファイル名

返値

「元のデータファイル名」ヘッダ文字列へのポインタ

6.2.28 「サンプリング間隔」ヘッダ文字列の作成

仕様

char * MqPutSampRate( MqAmp )

引数

MqAmp

サンプリング間隔

返値

「サンプリング間隔」ヘッダ文字列へのポインタ

「サンプリング間隔」ヘッダ用の文字列を作成する。MqAmp変数の内容を文字列化して、ヘッダ文字列に付加する。

6.2.29 「開始レコード番号」ヘッダの作成

仕様

char * MqPutStartRecord( unsigned long )

引数

引数として受けとったレコード番号から、「開始レコード番号」ヘッダ用の文字列を作成する。

開始レコード番号

返値

「開始レコード番号」ヘッダ文字列へのポインタ

6.2.30 「データのスタート時刻」ヘッダ文字列の作成

仕様

char * MqPutStartTime( MqTime )

引数

MqTime

データのスタート時刻を格納した構造体

返値

「データのスタート時刻」ヘッダ文字列へのポインタ

「データのスタート時刻」ヘッダ用の文字列を作成する。

6.2.31 「観測ステーション」ヘッダ文字列の作成

仕様

char * MqPutStation( unsigned short )

引数

unsigned short

観測点の番号を格納した変数(12～16)

返値

「観測ステーション」ヘッダ文字列へのポインタ

「観測ステーション」ヘッダ用の文字列を作成する。

6.2.32 「テープ番号」ヘッダ文字列の作成

仕様

void MqPutTapeNumber( unsigned short )

引数

返値

6.2.33 先頭行文字列の作成

仕様

void MqPutTopLine( char *header, char *progsign )

引数

char *header	ヘッダ文字列
char *progsign	プログラム署名

先頭行として利用できる文字列を作成し、*headerにセットする。ライブラリのバージョンは、状況変数MqLibVersionよりとられる。従って、本関数の実行前に、必ずMqInit()関数を実行しておかなくてはならない。

6.3 下位関数インタフェース仕様

6.3.1 ヘッダ文字列の作成

仕様

char * MqCatInfoData( char *, char * )

引数

char *	情報文字列
char *	データ文字列

返値

情報文字列とデータ文字列の間に分離記号 : を加え、ヘッダ文字列を作成して返値として返す。もし作成中にエラーが発生した場合には、NULL が返される。

6.3.2 エラー番号のクリア

仕様: void MqClearError( void )

エラー番号をクリアする。ほとんどのMQLIB関数では、最初にこの関数が呼び出されている。なお、本関数はマクロとして実現されており、実際の形は

MqErr.errno = 255

である。

6.3.3 文字列からdouble型配列への変換

仕様

void MqConvCharDouble( char *, MqAmp * )

引数

char *	文字列
MqAmp *	文字列から変換された`double`型データを収めるための変数。

文字列中のセパレータ , の位置を調べ、それを元にしてセパレータで区切られた数値列をdouble型の配列とみなし、変換して格納する。

6.3.4 セパレータ数のカウント

仕様

unsigned short MqCountSeparator( unsigned short, char * )

引数

unsigned short	分離記号を表す文字 1 文字。
char *	ヘッダ文字列

返値

捜し出された分離記号の数。

セパレータを文字列 char * 変数中から探し、その数を返す。

6.3.5 ヘッダ文字列からの１行の切り出し

仕様

void MqCutLine( char *, char *, long )

引数

char *	ヘッダ文字列
char *	切り出された１行
long	行の先頭の位置

long変数に格納されたヘッダ行の先頭の情報に基づき、そこから改行を表す部分までを複写し、C言語で表される文字列の形、すなわち最後に'\'が付加された文字列の形として返す。long変数はポインタではなくて、文字列の先頭から数えた該当するヘッダまでの文字数と考えれば良い。

6.3.6 コメントの先頭文字かどうかを判断

仕様

void MqIsComStart( int )

引数

int

チェックしたい文字

返値

先頭文字であればMQ_TRUE、そうでなければMQ_FALSE

intで示される文字がコメントの先頭文字として有効かどうかを判断し、有効であればMQ_TRUE、そうでなければMQ_FALSEを返す。なお、MQ_TRUE及びMQ_FALSEはいずれもマクロ定義された変数である。また、本関数はマクロによって実現されている。

6.3.7 行末記号の出力

仕様

void MqPutLineEnd( char * )

引数

引数であるヘッダ文字列の最後に行末記号( CR + NL )を付加する。なお、この関数はマクロによって実現されており、実際の形は、

strcat( x, MqLineEnd )

である。

6.3.8 ヘッダ用一時ファイルの読み込み

仕様

char * MqGetdTmpFile( unsigned short )

引数

unsigned short

ファイル記述子

返値

読み込まれたヘッダ用一時ファイルの内容を含む文字列

本関数は、MqOpen()あるいはMQOPEN()関数／サブルーチンによって作成された、ヘッダ用一時ファイルを読み込む。読み込まれるファイルは、引数で指定されたファイル記述子に対応する一時ファイルである。ファイルの読み込みに成功すると、その内容が char *型変数として読み込まれ、返値として返される。もし読み込み中にエラーが発生した場合には、NULLが返される。

6.3.9 情報文字列の検索

仕様

long MqSearchHeader( char *, char * )

引数

char *	ヘッダ文字列
char *	情報文字列

ヘッダ文字列内で情報文字列を検索し、その位置をlong変数として返す。もし、文字列が見つからなかったり、エラーが発生した場合には、-1 が返される。

6.3.10 情報文字列とデータ文字列の分離

仕様

void MqSeparateInfoData( char *, char * )

引数

char *	ヘッダ文字列
char *	データ文字列

情報文字列とデータ文字列の分離記号:を頼りにデータ文字列をヘッダ文字列全体から分離する。

6.3.11 文字列から`MqTime`構造体変数への変換

仕様

MqTime MqSeparateMqTime( char * )

引数

本関数は、数字が次のような形で並んでいる文字列を、MqTime構造体変数へ変換する。各文字列は、65536以下の自然数でなければならない。各文字列が表現する数値の許容範囲は、MqTime構造体による許容範囲と同じである。

データ文字列

year day hour minute second ms
(例)
1972 223 22 10 43 34

6.3.12 エラー番号のセット

仕様

void MqSetError( unsigned long )

引数

エラー番号をセットする。この関数はマクロとして実現されており、実際の形は

エラー番号

MqErr.errno = x

である。xは引数である。

6.3.13 ファイル記述子のセット

仕様

short MqSetFilDesc( char *, MQRW, MQIO );

引数

char *	ファイル名
MQRW	ファイルの読み書きのモード
MQIO	オープンするファイル

返値

ファイル記述子

ファイル記述子を、引数に与えられたモード値でセットする。本関数が呼び出されると、まず未使用の最も若い番号のファイル記述子が探され、もし見つかれば（見つからなければエラーとなる）、そのファイル記述子に、引数で与えられた読み書きのモード、ファイル入出力の種類がセットされ、全て正しくセットされれば、ファイル記述子を表す数字が返値として返される。もし途中でエラーが発生した場合には、-1 が返される。

6.3.14 関数番号のセット

仕様

void MqSetFunc( unsigned long )

引数

関数番号をセットする。この関数はマクロとして実現されており、実際の形は

関数番号

MqErr.func = x

である。xは引数である。

6.4 ユーティリティ関数

6.4.1 平均振幅の計算

仕様

double MqCalcAveAmp( double *, unsigned long start, unsigned long num )

引数

double *	実際のデータ
unsigned long	計算を開始するデータ点
unsigned long	計算するデータ数

返値

平均振幅

double *型配列で示されるデータのstartで示される箇所から、num個のデータについて平均値を計算する。

6.4.2 最大振幅の計算

仕様

double MqCalcMaxAmp( double *, unsigned long start, unsigned long num )

引数

double *	実際のデータ
unsigned long	計算を開始するデータ点
unsigned long	計算するデータ数

返値

最大振幅

double *型配列で示されるデータのstartで示される箇所から、num個のデータについて最大振幅を探し出す。

6.4.3 データベース用ファイル名の作成

仕様

char * MqCreFileName( unsigned short, MqTime, MQDT )

引数

unsigned short	観測点番号
MqTime	データ開始時刻
MQDT	月震データの種別

返値

作成されたファイル名

引数として渡された観測点番号、データ開始時刻、データ種別を元にして、月震データベース用のファイル名を作成する。各引数の内容は、MqRead()、あるいはMqReadStation()、MqReadStartTime()、MqReadDataType()などから得ることができる。引数が不正であった場合、例えば、観測点番号が11以下17以上であったり、MqTime構造体の中に時刻として不適当な値が代入されていた場合などには、ファイル名は作成されず、NULLが返される。それ以外の場合には、月震データベース既約に基づいたファイル名が返される。但し、ファイル名の第8文字については、必ず0となっているので、データベースの規約に合わせるためには、MQLIBのファイルをインストールするプログラムで、適切な名前に変換する必要がある。

6.4.4 `MqFilDesc`変数の整合性チェック

仕様

void MqCheckFilDesc( unsigned short, MQRW )

引数

unsigned short	チェックを行なうファイル記述子
MQRW	ファイルがオープンされているモード(読み出しか書き出しか)

引数として渡されたファイル記述子の内容について、正しい内容が書き込まれているかどうかチェックを行なう。渡されたファイル記述子がMQFILDESCMAX以上の値であったり、使用されていないファイル記述子であった場合にはエラーとなる。また、該当するファイル記述子にセットされているファイルのオープンのモード(MQRW変数)と、引数として渡されたMQRW変数のオープンのモードが異なる場合にもエラーとなる。もちろん、MQRWとして不正な値がセットされている場合にもエラーとなる。

6.4.5 `MqLibVer`構造体の内容の判定

仕様

void MqCheckLibVer( MqLibVer )

引数

MqLibVer

ライブラリ情報を格納した変数

MqLibVer構造体に格納した変数がMQDBの規約に合致しているかどうかを判定する。もし合致していなければ、MqErr構造体に違反内容に会わせたエラー番号が格納される。規約に合っていれば、MqErr.errnoにはEMQNOERRORが格納される。

6.4.6 観測モードの判定

仕様

MqMode MqCheckObsMode( MqTime, unsigned short )

引数

MqTime	データのスタート時刻
unsigned short	観測点を表す数値

返値

観測モード

MqTime変数に格納されているデータのスタート時刻と観測点の番号から、そのデータがpeakedモードで観測されていたかflatモードで観測されていたかを判別し、その値を返す。

6.4.7 サンプリング間隔の生成

仕様

double MqCheckSampRate( MQDT )

引数

MQDT

月震のデータ種類

返値

サンプリング間隔

月震のデータ種別に応じて、サンプリング間隔の値を返す。

6.4.8 観測点番号のチェック

仕様

void MqCheckStation( unsigned short )

引数

MqTime *

チェックされる変数

unsigned short変数の内容が、アポロの観測点番号として妥当な値かどうか、すなわち、12～16の範囲内にあるかどうかを調べる。もしその範囲内にない場合には、それに応じたエラー値がグローバル変数 MqErrにセットされる。

6.4.9 `MqTime`変数の内容のチェック

仕様

void MqCheckTime( MqTime * )

引数

MqTime *

チェックされる変数

MqTime変数の内容をチェックし、妥当な値が各変数に代入されているかどうかをチェックする。もし代入されていない場合には、それに応じたエラー値がグローバル変数 MqErrにセットされる。

6.4.10 2つの`MqTime`変数の時間差の出力

仕様

double MqDiffTime( MqTime time2, Mqtime time1 )

引数

MqTime *time2	引かれる時間
MqTime *time1	引く時間

返値

マイクロ秒単位で計算した時間差

2つのMqTime変数の時間差、time2 - time1を計算し、マイクロ秒単位の時間差を返す。

6.4.11 エラーメッセージの出力

仕様

void MqPerror( char * )

引数