torque Torque Game Engine Documentation
TGE Version 1.5.2

FilterStream Class Reference

#include <filterStream.h>

Inheritance diagram for FilterStream:

Inheritance graph
[legend]

Public Member Functions

virtual ~FilterStream ()
virtual bool attachStream (Stream *io_pSlaveStream)=0
virtual void detachStream ()=0
virtual StreamgetStream ()=0
bool hasCapability (const Capability) const
 Checks to see if this stream has the capability of a given function.
U32 getPosition () const
 Gets the position in the stream.
bool setPosition (const U32 in_newPosition)
 Sets the position of the stream. Returns if the new position is valid or not.
U32 getStreamSize ()
 Gets the size of the stream.

Protected Member Functions

bool _read (const U32 in_numBytes, void *out_pBuffer)
bool _write (const U32 in_numBytes, const void *in_pBuffer)

Constructor & Destructor Documentation

virtual FilterStream::~FilterStream (  )  [virtual]


Member Function Documentation

virtual bool FilterStream::attachStream ( Stream io_pSlaveStream  )  [pure virtual]

virtual void FilterStream::detachStream (  )  [pure virtual]

virtual Stream* FilterStream::getStream (  )  [pure virtual]

bool FilterStream::_read ( const U32  in_numBytes,
void out_pBuffer 
) [protected, virtual]

Implements Stream.

Reimplemented in ResizeFilterStream, ZipSubRStream, and ZipSubWStream.

bool FilterStream::_write ( const U32  in_numBytes,
const void in_pBuffer 
) [protected, virtual]

Implements Stream.

Reimplemented in ZipSubWStream.

bool FilterStream::hasCapability ( const   Capability  )  const [virtual]

Checks to see if this stream has the capability of a given function.

Implements Stream.

Reimplemented in ZipSubRStream, and ZipSubWStream.

U32 FilterStream::getPosition (  )  const [virtual]

Gets the position in the stream.

Implements Stream.

Reimplemented in ResizeFilterStream, ZipSubRStream, and ZipSubWStream.

bool FilterStream::setPosition ( const U32  in_newPosition  )  [virtual]

Sets the position of the stream. Returns if the new position is valid or not.

Implements Stream.

Reimplemented in ResizeFilterStream, ZipSubRStream, and ZipSubWStream.

U32 FilterStream::getStreamSize (  )  [virtual]

Gets the size of the stream.

Implements Stream.

Reimplemented in ResizeFilterStream, ZipSubRStream, and ZipSubWStream.




All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen