FS_ReaderStream Class Reference

#include <FS_ReaderStream.h>

List of all members.

Public Member Functions
	FS_ReaderStream ()
	FS_ReaderStream (FS_ReaderStream &src, int64 stream_offset, int64 stream_size, int64 data_size, const FS_IStreamFilterFactory *factory)
	FS_ReaderStream (const char *file)
	FS_ReaderStream (const char *data, int len, int modtime)
virtual	~FS_ReaderStream ()
UT_IStream *	getStream () const
	Returns the actual input stream to read the data from.
bool	isGood () const
int	getModTime () const
void	getFilename (UT_String &filename) const
int	getLength () const
void	setModTime (int modtime)
	Sets the modification time on the stream.
void	setSubStreamReadFilterFactory (FS_IStreamFilterFactory *f)
FS_IStreamFilterFactory *	getSubStreamReadFilterFactory () const
void	setSubStreamWriteFilterFactory (FS_WriteFilterFactory *f)
FS_WriteFilterFactory *	getSubStreamWriteFilterFactory () const

---

Detailed Description

Examples:

FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 37 of file FS_ReaderStream.h.

---

Constructor & Destructor Documentation

FS_ReaderStream::FS_ReaderStream

(

)

FS_ReaderStream::FS_ReaderStream	(	FS_ReaderStream &	src,
		int64	stream_offset,
		int64	stream_size,
		int64	data_size,
		const FS_IStreamFilterFactory *	factory
	)

FS_ReaderStream::FS_ReaderStream

(

const char *

file

)

FS_ReaderStream::FS_ReaderStream	(	const char *	data,
		int	len,
		int	modtime
	)

virtual FS_ReaderStream::~FS_ReaderStream

(

)

[virtual]

---

Member Function Documentation

void FS_ReaderStream::getFilename

(

UT_String &

filename

)

const

int FS_ReaderStream::getLength

(

)

const

Returns the size of the data (ie, after filtering the raw stream). If no filtering is performed, this is the same as raw stream size.

int FS_ReaderStream::getModTime

(

)

const

UT_IStream* FS_ReaderStream::getStream

(

)

const

Returns the actual input stream to read the data from.

FS_IStreamFilterFactory* FS_ReaderStream::getSubStreamReadFilterFactory

(

)

const

FS_WriteFilterFactory* FS_ReaderStream::getSubStreamWriteFilterFactory

(

)

const

bool FS_ReaderStream::isGood

(

)

const

void FS_ReaderStream::setModTime

(

int

modtime

)

Sets the modification time on the stream.

void FS_ReaderStream::setSubStreamReadFilterFactory

(

FS_IStreamFilterFactory *

f

)

Sets the factory that should be used for this stream's substreams (but not for the whole stream). It is a way to piggyback the filter info to potential substream readers.

void FS_ReaderStream::setSubStreamWriteFilterFactory

(

FS_WriteFilterFactory *

f

)

---

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

• FS/FS_ReaderStream.h