KiNOKO 標準コンポーネント リファレンス
KinokoCollector
| 種別 | ストリームソース |
|---|
| 参照名 | KinokoCollector |
|---|
- 読み出しスクリプト(kts スクリプト)に基づきデバイス等からデータを読み，ストリームに送り出す．
基本的な使用手順
- setSink() を呼び，データストリーム受け取り側コンポーネントを指定する．
- connect() を呼び，データストリームを構築する．
- 必要に応じて，以下のコンポーネント設定を行なう．
- setReadoutScript() を呼び，読み出しスクリプトを指定する．
- 必要なら setMaxEventCounts() を呼び，読み出すイベント数を指定する．
- 必要なら setRunLength() を呼び，データ収集を行なう時間を指定する．
- 必要なら setDataSourceName() を呼び，このコンポーネントが生成するストリームの DataSource 名を指定する．
- 必要なら setDataSourceId() を呼び，このコンポーネントが生成するストリームの DataSourceId を指定する．
- construct() を呼び，スクリプトの読み込みと内部の構築および初期化を行なう．
- start() を呼び，データ収集を開始する．
- 以下のいづれかの方法により，データ収集を停止する．
- stop() を呼ぶ．
- setMaxEventCounts() / setRunLength() をした場合，dataAcquisitionFinished() イベントを待つ．
- destruct() を呼び，終了処理を行なう．
- disconnect() を呼び，ストリームを切り離す．
- quit() を呼び，コンポーネントを KCOM システムから切り放し，実行を終了する．
- ストリームの受け取り側コンポーネントが Buffer でない場合，このコンポーネントの connect() が呼び出される前に，受け取り側のコンポーネントの setSource() が呼び出されていなければならない．
- ストリームの受け取り側コンポーネントが Buffer の場合，このコンポーネントの connect() が呼び出される前に，Buffer の start() が呼び出されていなければならない．
外部インターフェース定義
component KinokoCollectorCom {
property string host;
property long condition_check_time;
property long heart_beat_count;
property long vital_level;
property string stream_type;
property string state;
property int port_number;
uses KinokoLogger logger;
emits dataAcquisitionFinished();
accepts system();
accepts enableConditionMonitor();
accepts setSource();
accepts setSink();
accepts setSourceSink();
accepts connect();
accepts construct();
accepts destruct();
accepts disconnect();
accepts halt();
accepts quit();
accepts start();
accepts stop();
accepts setDataSourceName(string datasource_name);
accepts setDataSourceId();
accepts setReadoutScript(string file_name, string datasource_name);
accepts setMaxEventCounts(int number_of_events);
accepts setRunLength(int run_length_sec);
accepts executeCommand(string command_name, int parameter);
accepts disable();
}