PDFTool  7.0
Public Member Functions | Protected Attributes | List of all members
PdfTk::PtlParamStream Class Referenceabstract

ファイルやストリームの入出力指定に使うベースクラスです。
PDFToolではstd::ifstreamを使うPtlParamInput、std::ofstreamを使うPtlParamOutputクラスが事前定義されています。
ユーザーが独自に派生クラスを作ることも可能です。 More...

#include <PtlParamStream.h>

Inheritance diagram for PdfTk::PtlParamStream:
Inheritance graph
[legend]

Public Member Functions

 PtlParamStream ()
 コンストラクタ
 
virtual ‾PtlParamStream ()
 デストラクタ
 
bool canRead () const
 入力ストリームの読み込み可能かを取得。 More...
 
bool canWrite () const
 出力ストリームの書き込み可能かを取得。 More...
 
virtual bool open ()=0
 ストリームをオープン。 More...
 
virtual void close ()
 ストリームをクローズ。 More...
 
virtual int read (char *pBuf, int len)
 入力ストリームの読み込み。 More...
 
virtual int write (char *pBuf, int len)
 出力ストリームの書き込み。 More...
 
virtual long seekoff (long off, int way, int which)
 入力ストリーム内の移動。 More...
 
virtual PtlParamString getPath () const =0
 パスの取得。
 

Protected Attributes

bool m_canRead
 
bool m_canWrite
 

Detailed Description

ファイルやストリームの入出力指定に使うベースクラスです。
PDFToolではstd::ifstreamを使うPtlParamInput、std::ofstreamを使うPtlParamOutputクラスが事前定義されています。
ユーザーが独自に派生クラスを作ることも可能です。

Member Function Documentation

◆ canRead()

bool PdfTk::PtlParamStream::canRead ( ) const
inline

入力ストリームの読み込み可能かを取得。

Returns
可能な場合はtrue

◆ canWrite()

bool PdfTk::PtlParamStream::canWrite ( ) const
inline

出力ストリームの書き込み可能かを取得。

Returns
可能な場合はtrue

◆ close()

virtual void PdfTk::PtlParamStream::close ( )
inlinevirtual

ストリームをクローズ。

Exceptions
PtlException

Reimplemented in PdfTk::PtlParamInput, and PdfTk::PtlParamOutput.

◆ open()

virtual bool PdfTk::PtlParamStream::open ( )
pure virtual

ストリームをオープン。

Returns
オープンできた場合はtrue
Exceptions
PtlException

Implemented in PdfTk::PtlParamInput, and PdfTk::PtlParamOutput.

◆ read()

virtual int PdfTk::PtlParamStream::read ( char *  pBuf,
int  len 
)
inlinevirtual

入力ストリームの読み込み。

Parameters
pBuf読み込んだデータを格納するバッファ
len読み込むサイズ
Returns
読み込んだサイズ
読み込みに失敗した時は-1
Exceptions
PtlException

Reimplemented in PdfTk::PtlParamInput.

◆ seekoff()

virtual long PdfTk::PtlParamStream::seekoff ( long  off,
int  way,
int  which 
)
inlinevirtual

入力ストリーム内の移動。

Parameters
off基準位置からのオフセット
way基準位置
0:入力ストリームの先頭を基準とします。
1:現在の位置を基準とします。
2:入力ストリームの末尾を基準とします。
which未使用
Returns
現在の位置
移動に失敗した時は-1
Exceptions
PtlException

Reimplemented in PdfTk::PtlParamInput.

◆ write()

virtual int PdfTk::PtlParamStream::write ( char *  pBuf,
int  len 
)
inlinevirtual

出力ストリームの書き込み。

Parameters
pBuf書き込むデータ
lenデータ長
Returns
書き込んだ長さ
移動に失敗した時は-1

Reimplemented in PdfTk::PtlParamOutput.