PdfTk::PtlParamInput クラス

#include <PtlParamInput.h>

PdfTk::PtlParamInput の継承関係図

PdfTk::PtlParamInput 連携図

公開メンバ関数
int	getHandle () const
	PtlParamInput ()
	コンストラクタ
	PtlParamInput (const PtlParamString &path)
	コンストラクタ
	PtlParamInput (const PtlParamString &path, InputStream *inStream)
	コンストラクタ
	PtlParamInput (const PtlParamInput &obj)
	コピーコンストラクタ
	~PtlParamInput ()
	デストラクタ
PtlParamInput &	operator= (const PtlParamInput &obj)
	コピーオペレータ
bool	open ()
	入力ストリームのオープン。
void	close ()
	ストリームのクローズ。
int	read (char *pBuf, int len)
	入力ストリームの読み込み。
long	seekoff (long off, int way, int which)
	入力ストリーム内の移動。
const PtlParamString &	getPath ()
	パスを取得。
InputStream &	getStream () const
	InputStreamを取得。
基底クラス PdfTk::PtlParamStream に属する継承公開メンバ関数
	PtlParamStream ()
	コンストラクタ
virtual	~PtlParamStream ()
	デストラクタ
bool	canRead () const
	入力ストリームの読み込み可能かを取得。
bool	canWrite () const
	出力ストリームの書き込み可能かを取得。
virtual int	write (char *pBuf, int len)
	出力ストリームの書き込み。

その他の継承メンバ
基底クラス PdfTk::PtlParamStream に属する継承限定公開変数類
bool	m_canRead
bool	m_canWrite

詳解

ファイルやストリームの入力指定に使うパラメータクラスです。

パス(ファイル)名を指定して、ストリームを指定しない場合、パス(ファイル)名を使って、ストリームをオープンします。
ストリームを指定した場合、パス(ファイル)名はエラーメッセージの表示などに使われる情報として扱われ、 パス(ファイル)名でストリームをオープンすることはありません。

PtlParamInput.h の 24 行目に定義があります。

構築子と解体子

PtlParamInput() [1/4]

PdfTk::PtlParamInput::PtlParamInput

(

)

コンストラクタ

例外

PtlException

PtlParamInput() [2/4]

PdfTk::PtlParamInput::PtlParamInput

(

const PtlParamString &

path

)

コンストラクタ

引数

path

パス。

例外

PtlException

PtlParamInput() [3/4]

PdfTk::PtlParamInput::PtlParamInput	(	const PtlParamString &	path,
		InputStream *	inStream )

コンストラクタ

引数

path	パス。
inStream	ストリーム。

例外

PtlException

PtlParamInput() [4/4]

PdfTk::PtlParamInput::PtlParamInput

(

const PtlParamInput &

obj

)

コピーコンストラクタ

引数

obj	コピー元オブジェクト。

例外

PtlException

関数詳解

close()

void PdfTk::PtlParamInput::close ( )

virtual

ストリームのクローズ。

例外

PtlException

PdfTk::PtlParamStreamを再実装しています。

getPath()

const PtlParamString & PdfTk::PtlParamInput::getPath ( )

virtual

パスを取得。

PdfTk::PtlParamStreamを実装しています。

getStream()

InputStream & PdfTk::PtlParamInput::getStream

(

)

const

InputStreamを取得。

戻り値

InputStream

例外

PtlException

open()

bool PdfTk::PtlParamInput::open ( )

virtual

入力ストリームのオープン。

戻り値

オープンできた場合はtrue

例外

PtlException

PdfTk::PtlParamStreamを実装しています。

operator=()

PtlParamInput & PdfTk::PtlParamInput::operator=

(

const PtlParamInput &

obj

)

コピーオペレータ

引数

obj	コピー元オブジェクト。

read()

int PdfTk::PtlParamInput::read ( char * pBuf, int len )

virtual

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

引数

pBuf	読み込んだデータを格納するバッファ
len	読み込むサイズ

戻り値

読み込んだサイズ
読み込みに失敗した時は-1

例外

PtlException

PdfTk::PtlParamStreamを再実装しています。

seekoff()

long PdfTk::PtlParamInput::seekoff ( long off, int way, int which )

virtual

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

引数

off	基準位置からのオフセット
way	基準位置 0:入力ストリームの先頭を基準とします。 1:現在の位置を基準とします。 2:入力ストリームの末尾を基準とします。
which	未使用

戻り値

現在の位置
移動に失敗した時は-1

例外

PtlException

PdfTk::PtlParamStreamを再実装しています。