SFXOutputStream

書き込み用ストリームの基底クラスです。

#include <SFXOutputStream.h.hpp>

class SFXOutputStream : public SFXStream;

SFMTYPEDEFCLASS(SFXOutputStream)

継承図

SFXOutputStream は、書き込み用ストリームの基底クラスです。

ストリームに書き込むデータの種類に応じて、 SFXOutputStream を継承する SFXAnsiStringStreamWriter / SFXWideStringStreamWriter / SFXBinaryStreamWriter クラスを使い分けます。

コンストラクタ/デストラクタ
SFXOutputStream( `Void` ) SFXOutputStream クラスのコンストラクタです。
~SFXOutputStream( `Void` ) SFXOutputStream クラスのデストラクタです。

パブリック関数
`SFCError`	Flush( `Void` ) ストリームバッファ内のデータをストレージに書き込みます。
`SFCError`	Flush( `CallbackSPP` spp , `VoidPtr` reference ) ストリームバッファ内のデータをストレージに書き込みます。
`UInt32`	GetWritableSize( `Void` ) ストリームバッファに書き込み可能なデータサイズを取得します。
`SFCError`	Write( `SFXBufferConstRef` buffer ) ストリームにデータを書き込みます。
`SFCError`	Write( `VoidConstPtr` buffer , `UInt32` size ) ストリームにデータを書き込みます。
`Void`	Cancel( `Void` ) (SFXStream から継承) ストリームの読み込み/書き込みをキャンセルします。
`SFCError`	ResetTrigger( `Void` ) (SFXStream から継承) コールバック関数が呼ばれるトリガーをリセットします。
`SFCError`	SetTrigger( `UInt32` size ) (SFXStream から継承) トリガー(コールバック関数が呼ばれるタイミング)を設定します。
`SFCError`	SetTrigger( `SFXBufferConstRef` buffer ) (SFXStream から継承) トリガー(コールバック関数が呼ばれるタイミング)を設定します。
`SFCError`	SetTrigger( `VoidConstPtr` buffer , `UInt32` size ) (SFXStream から継承) トリガー(コールバック関数が呼ばれるタイミング)を設定します。
`Bool`	Triggers( `Void` ) (SFXStream から継承) トリガーによりコールバック関数が呼び出されたか判定します。

型
CallbackSPP (SFXStream から継承) コールバック関数を表す型です。

SFXOutputStream::SFXOutputStream

SFXOutputStream クラスのコンストラクタです。

[ protected, explicit ]
SFXOutputStream(Void);

特に何も行いません。

SFXOutputStream::~SFXOutputStream

SFXOutputStream クラスのデストラクタです。

[ public, pure-virtual ]
~SFXOutputStream(Void);

この関数は純粋仮想関数です。

SFXOutputStream::Flush

ストリームバッファ内のデータをストレージに書き込みます。

[ public, pure-virtual ]
SFCError Flush(Void);

[ public, pure-virtual ]
SFCError Flush(
    CallbackSPP spp     // コールバック関数
    VoidPtr reference   // コールバック関数に渡すデータ（参照値）
);

この関数は純粋仮想関数です。

SFXOutputStream::GetWritableSize

ストリームバッファに書き込み可能なデータサイズを取得します。

[ public, pure-virtual, const ]
UInt32 GetWritableSize(Void);

この関数は純粋仮想関数です。

SFXOutputStream::Write

ストリームにデータを書き込みます。

[ public, pure-virtual ]
SFCError Write(
    SFXBufferConstRef buffer   // 書き込むデータ
);

[ public, pure-virtual ]
SFCError Write(
    VoidConstPtr buffer   // 書き込むデータ
    UInt32 size           // 書き込むデータのサイズ
);

この関数は純粋仮想関数です。