FS_Reader Class Reference

Class for reading files. More...

#include <FS_Reader.h>

List of all members.

Public Member Functions
	FS_Reader ()
	FS_Reader (const char *source)
	FS_Reader (FS_ReaderStream *sourcestream)
virtual	~FS_Reader ()
void	close ()
bool	isGood ()
	This function is used to check if the file was successfully opened.
UT_IStream *	getStream () const
FS_ReaderStream *	shareDataAndGetSubstream (int64 stream_offset, int64 sub_stream_size, int64 sub_data_size, const FS_IStreamFilterFactory *f=NULL) const
int	getModTime () const
int	getLength () const
void	getFilename (UT_String &filename) const
FS_IStreamFilterFactory *	getSubStreamReadFilterFactory () const
FS_WriteFilterFactory *	getSubStreamWriteFilterFactory () const
Static Public Member Functions
static void	addReaderHelper (FS_ReaderHelper *helper)
static void	removeReaderHelper (FS_ReaderHelper *helper)

---

Detailed Description

Class for reading files.

Definition at line 33 of file FS_Reader.h.

---

Constructor & Destructor Documentation

FS_Reader::FS_Reader

(

)

FS_Reader::FS_Reader

(

const char *

source

)

Use this constructor to create a new reader. The specified file is opened immediately.

FS_Reader::FS_Reader

(

FS_ReaderStream *

sourcestream

)

virtual FS_Reader::~FS_Reader

(

)

[virtual]

---

Member Function Documentation

static void FS_Reader::addReaderHelper

(

FS_ReaderHelper *

helper

)

[static]

void FS_Reader::close

(

)

Closes the stream. After calling this function, the getStream() function will always return NULL.

void FS_Reader::getFilename

(

UT_String &

filename

)

const

int FS_Reader::getLength

(

)

const

int FS_Reader::getModTime

(

)

const

UT_IStream* FS_Reader::getStream

(

)

const

This function retrieves the C++ stream object which you can interact with in the normal ways. If this function returns NULL, the file specified in the constructor could not be found.

FS_IStreamFilterFactory* FS_Reader::getSubStreamReadFilterFactory

(

)

const

FS_WriteFilterFactory* FS_Reader::getSubStreamWriteFilterFactory

(

)

const

bool FS_Reader::isGood

(

)

[inline]

This function is used to check if the file was successfully opened.

Definition at line 50 of file FS_Reader.h.

static void FS_Reader::removeReaderHelper

(

FS_ReaderHelper *

helper

)

[static]

FS_ReaderStream* FS_Reader::shareDataAndGetSubstream	(	int64	stream_offset,
		int64	sub_stream_size,
		int64	sub_data_size,
		const FS_IStreamFilterFactory *	f = NULL
	)			const

---

The documentation for this class was generated from the following file:

• FS/FS_Reader.h