関数TF_openall マニュアル

(The documentation of function TF_openall)

Last Update: 2022/8/8


◆機能・用途(Purpose)

コマンドライン引数の指定に基づいて、 出力対象になっている全てのファイルを 指定したモード(上書き/追加書き込み)でオープンする。
Open all output files, that are specified to output by command-line arguments, with specified (overwrite or add) modes.


◆形式(Format)

#include "detect_VLP_sub/file.h"
inline void TF_openall
(const struct TF_parameters parameters,
 FILE_L ∗fp_eventCandidate,FILE_L ∗fp_peakList,
 FILE_L ∗fp_eventList,FILE_L ∗fp_sacMacro)


◆引数(Arguments)

parameters 全てのメンバの値が設定された構造体。
A structure for which the values of all members are set.
fp_eventCandidate イベント候補リストファイル用の構造体。 宣言しただけの変数に&を付けて与える。
A structure for an event candidate list file. Give an empty variable with &.
fp_peakList ピークリストファイル用の構造体。 宣言しただけの変数に&を付けて与える。
A structure for a peak list file. Give an empty variable with &.
fp_eventList イベントリストファイル用の構造体。 宣言しただけの変数に&を付けて与える。
A structure for an event list file. Give an empty variable with &.
fp_sacMacro イベント波形プロット用SACマクロ用の構造体。 宣言しただけの変数に&を付けて与える。
A structure for a macro for plotting event waveforms in SAC. Give an empty variable with &.


◆動作(Behaviour)

イベント候補リストファイル、 ピークリストファイル、 イベントリストファイル、 イベント波形プロット用SACマクロのうち、 コマンドライン引数でオープンの対象になっているファイルについて、 コマンドライン引数で指定したモード(上書き/追加書き込み)でオープンする。 ファイルのオープンには関数CKfopen(file.h)を使用し、 その戻り値を引数 fp_eventCandidate, fp_peakList, fp_eventList, fp_sacMacro に代入する。
Open files that are specified to open by command-line arguments, with specified (overwrite or add) modes, among an event candidate list file, a peak list file, an event list file, and a macro for plotting event waveforms in SAC. Function CKfopen (file.h) is used to open the files, and the return values are inserted to the arguments fp_eventCandidate, fp_peakList, fp_eventList, and fp_sacMacro.