M
M
MWX Library
検索…
stream_helper
stream_helperは、mwx::streamインタフェースを付与するヘルパーオブジェクトです。データクラスを参照するヘルパーオブジェクトを生成し、ヘルパーオブジェクト経由でデータの入出力を行います。
以下にはsmplbufの配列bからヘルパーオブジェクトbsを生成しmwx::stream::operator <<()演算子によるデータ入力を行っています。
1
smplbuf_u8<32> b;
2
auto&& bs = b.get_stream_helper(); // ヘルパーオブジェクト
3
4
// データ列の生成
5
uint8_t FOURCHARS[]={'A', 'B', 'C', 'D'};
6
bs << FOURCHARS;
7
bs << ';';
8
bs << uint32_t(0x30313233); // "0123"
9
bs << format(";%d", 99);
10
11
Serial << b << crlf; // Serialへの出力は smplbuf_u8<32> クラス経由で
12
13
//結果: ABCD;0123;99
Copied!

概要

stream_helper はデータ配列をストリームに見立てて振舞います。
内部にはデータ配列中の読み書き位置を保持しています。次のようにふるまいます。
  • 読み出しまたは書き込みをすると次の読み書き位置に移動します。
  • 最期のデータを読み出した後、またはデータを末尾に追記した後には、読み書き位置は終端となります。
  • 読み書き位置が終端の場合、
    • available()falseになります。
    • 読み出しは出来ません。
    • 書き込みは書き込み可能範囲であれば追記します。

stream_helperの生成

stream_helper は、データクラス (smplbuf, EEPROM) のメンバー関数より生成します。
1
auto&& obj_helper = obj.get_stream_helper()
2
// obj はデータクラスのオブジェクト、obj_helperの型は長くなるのでauto&&で受けています。
Copied!

メソッド

rewind()

1
void rewind()
Copied!
読み書き位置を先頭に移動します。

seek()

1
int seek(int offset, int whence = MWX_SEEK_SET)
Copied!
読み書き位置を設定します。
whence
設定位置
MWX_SEEK_SET
先頭位置から設定します。offset0を指定するとrewind()と同じ意味になります。
MWX_SEEK_CUR
現在位置を基準にoffset分移動しまします。
MWX_SEEK_END
終端位置にします。offset0にすると終端に設定します。-1を設定すると最後の文字に移動します。

tell()

1
int tell()
Copied!
読み書き位置を返します。終端位置の場合は-1を返します。

available()

1
int available()
Copied!
読み書き位置が終端であれば0を返します。終端でなければそれ以外の値を返します。
最終更新 1yr ago