Antenna House PDF Tool API (C++) 8.0
PdfTk::PtlParamStream クラスabstract

#include <PtlParamStream.h>

PdfTk::PtlParamStream の継承関係図
Inheritance graph
[凡例]

公開メンバ関数

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

限定公開変数類

bool m_canRead
bool m_canWrite

詳解

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

PtlParamStream.h の 18 行目に定義があります。

構築子と解体子

◆ PtlParamStream()

PdfTk::PtlParamStream::PtlParamStream ( )
inline

コンストラクタ

PtlParamStream.h の 28 行目に定義があります。

◆ ~PtlParamStream()

virtual PdfTk::PtlParamStream::~PtlParamStream ( )
inlinevirtual

デストラクタ

PtlParamStream.h の 33 行目に定義があります。

関数詳解

◆ canRead()

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

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

戻り値
可能な場合はtrue

PtlParamStream.h の 40 行目に定義があります。

◆ canWrite()

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

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

戻り値
可能な場合はtrue

PtlParamStream.h の 46 行目に定義があります。

◆ close()

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

ストリームをクローズ。

例外
PtlException

PdfTk::PtlParamInput, PdfTk::PtlParamOutputで再実装されています。

PtlParamStream.h の 59 行目に定義があります。

◆ getPath()

virtual const PtlParamString & PdfTk::PtlParamStream::getPath ( )
pure virtual

パスの取得。

PdfTk::PtlParamInput, PdfTk::PtlParamOutputで実装されています。

◆ open()

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

ストリームをオープン。

戻り値
オープンできた場合はtrue
例外
PtlException

PdfTk::PtlParamInput, PdfTk::PtlParamOutputで実装されています。

◆ read()

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

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

引数
pBuf読み込んだデータを格納するバッファ
len読み込むサイズ
戻り値
読み込んだサイズ
読み込みに失敗した時は-1
例外
PtlException

PdfTk::PtlParamInputで再実装されています。

PtlParamStream.h の 69 行目に定義があります。

◆ seekoff()

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

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

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

PdfTk::PtlParamInputで再実装されています。

PtlParamStream.h の 92 行目に定義があります。

◆ write()

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

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

引数
pBuf書き込むデータ
lenデータ長
戻り値
書き込んだ長さ
移動に失敗した時は-1

PdfTk::PtlParamOutputで再実装されています。

PtlParamStream.h の 78 行目に定義があります。

メンバ詳解

◆ m_canRead

bool PdfTk::PtlParamStream::m_canRead
protected

PtlParamStream.h の 21 行目に定義があります。

◆ m_canWrite

bool PdfTk::PtlParamStream::m_canWrite
protected

PtlParamStream.h の 22 行目に定義があります。