シリアルストリーム
Haply::HardwareAPI::IO::SerialStream
シリアルポート用の std::iostream 互換ストリームを提供する。
Inverse3およびHandleクラスと組み合わせて使用することを意図しています。APIは、現在Haplyデバイスに関連付けられているシリアル・ポートを簡単に見つけるためのDeviceDetectionクラスを提供します。
オブジェクトをいずれかのデバイス・クラスで使用するには、OpenDeviceを使用するか、SerialStreamのパラメータにtrueを渡す必要があります。
インデックス
方法
| 名称 | タイプ | 説明 |
|---|---|---|
| シリアルストリーム | (const char *, bool) | ... からSerialStreamオブジェクトを構築します。 |
| ~シリアルストリーム | () | シリアルポートを閉じ、関連するリソースを解放する。 |
| オープンデバイス | char() | シリアルポートを開き、いずれかのデバイスで使用できるようにする。 |
| クローズデバイス | void() | この関数はシリアルポートを閉じる。 |
| 利用可能 | int() | この関数は、読み取り可能なバイト数を返します。 |
| ライトバイト | void(const char *, size_t) | この関数は、与えられたデータをシリアル・ポートに書き込む。 |
方法
シリアルストリーム
シリアルストリーム( const char * port、 ブールオープン)
指定されたシリアルポートからSerialStreamオブジェクトを構築します。
警告openが渡され、ポートのオープン中にエラーが発生した場合、エラーが標準エラー出力に書き込まれ、生成されたオブジェクトは無効となる。
パラメータ
-
port開くシリアルポート。Windowsでは、9以上のシリアル・ポートには、その前に "9 "を付けなければならない。例として、シリアル・ポートを開くには or を使用する。
-
opentrueの場合、コンストラクタ内でOpendeviceが呼び出される。
~シリアルストリーム
~シリアルストリーム()
シリアルポートを閉じ、関連するリソースを解放する。
オープンデバイス
char OpenDevice()
シリアル・ポートを開き、デバイス・クラスのいずれかで使用できるようにする。
リターン
ポートのオープンに成功した場合はゼロを返す。シリアル・ポートがオープンできなかった場合は負の値を返し、エラーが標準エラー出力に出力される。
クローズデバイス
void CloseDevice()
この関数はシリアルポートを閉じる。
デストラクタによって呼び出され、ほとんどの状況では安全に無視できる。
利用可能
int Available()
この関数は、シリアル・ポートから読み取り可能なバイト数を返す。
リターン
シリアルポートから読み込み可能なバイト数。
ライトバイト
void WriteBytes() const char * data、 サイズ）
この関数は、与えられたデータをシリアル・ポートに書き込む。
パラメータ
-
dataシリアル・ポートに書き込むデータ。
-
sizeシリアル・ポートに書き込むデータのサイズ。