HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FS_ReaderStream Class Reference

#include <FS_ReaderStream.h>

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, const UT_Options *options=NULL)
 
 FS_ReaderStream (const char *data, int len, int modtime, const char *file=nullptr)
 
 FS_ReaderStream (UT_WorkBuffer &buffer, int modtime, const char *file=nullptr)
 
virtual ~FS_ReaderStream ()
 
virtual int64 getMemoryUsage (bool inclusive) const
 Get the amount of memory owned by this FS_ReaderStream. More...
 
UT_IStreamgetStream () const
 Returns the actual input stream to read the data from. More...
 
bool isGood () const
 
time_t getModTime () const
 
void getFilename (UT_String &filename) const
 
int64 getLength () const
 
void setModTime (time_t modtime)
 Sets the modification time on the stream. More...
 
void setSubStreamReadFilterFactory (FS_IStreamFilterFactory *f)
 
FS_IStreamFilterFactorygetSubStreamReadFilterFactory () const
 
void setSubStreamWriteFilterFactory (FS_WriteFilterFactory *f)
 
FS_WriteFilterFactorygetSubStreamWriteFilterFactory () const
 

Protected Attributes

FS_IStreamFilterFactorymySubStreamReadFilterFactory
 
FS_WriteFilterFactorymySubStreamWriteFilterFactory
 
UT_IStreammyStream
 
UT_String myFile
 
int64 myDataSize
 
time_t myModTime
 
UT_WorkBuffer myMemBuffer
 

Detailed Description

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

Definition at line 32 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,
const UT_Options options = NULL 
)
FS_ReaderStream::FS_ReaderStream ( const char *  data,
int  len,
int  modtime,
const char *  file = nullptr 
)
FS_ReaderStream::FS_ReaderStream ( UT_WorkBuffer buffer,
int  modtime,
const char *  file = nullptr 
)
virtual FS_ReaderStream::~FS_ReaderStream ( )
virtual

Member Function Documentation

void FS_ReaderStream::getFilename ( UT_String filename) const
int64 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.

virtual int64 FS_ReaderStream::getMemoryUsage ( bool  inclusive) const
virtual

Get the amount of memory owned by this FS_ReaderStream.

time_t 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 ( time_t  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)

Member Data Documentation

int64 FS_ReaderStream::myDataSize
protected

Definition at line 109 of file FS_ReaderStream.h.

UT_String FS_ReaderStream::myFile
protected

Definition at line 108 of file FS_ReaderStream.h.

UT_WorkBuffer FS_ReaderStream::myMemBuffer
protected

Definition at line 111 of file FS_ReaderStream.h.

time_t FS_ReaderStream::myModTime
protected

Definition at line 110 of file FS_ReaderStream.h.

UT_IStream* FS_ReaderStream::myStream
protected

Definition at line 107 of file FS_ReaderStream.h.

FS_IStreamFilterFactory* FS_ReaderStream::mySubStreamReadFilterFactory
protected

Definition at line 104 of file FS_ReaderStream.h.

FS_WriteFilterFactory* FS_ReaderStream::mySubStreamWriteFilterFactory
protected

Definition at line 105 of file FS_ReaderStream.h.


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