torque Torque Game Engine Documentation
TGE Version 1.5.2

MemStream Class Reference

#include <memstream.h>

Inheritance diagram for MemStream:

Inheritance graph
[legend]

Public Member Functions

 MemStream (const U32 in_bufferSize, void *io_pBuffer, const bool in_allowRead=true, const bool in_allowWrite=true)
 ~MemStream ()
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)

Protected Attributes

U32 const cm_bufferSize
voidm_pBufferBase
U32 m_instCaps
U32 m_currentPosition

Private Types

typedef Stream Parent

Member Typedef Documentation

typedef Stream MemStream::Parent [private]


Constructor & Destructor Documentation

MemStream::MemStream ( const U32  in_bufferSize,
void io_pBuffer,
const bool  in_allowRead = true,
const bool  in_allowWrite = true 
)

MemStream::~MemStream (  ) 


Member Function Documentation

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

Implements Stream.

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

Implements Stream.

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

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

Implements Stream.

U32 MemStream::getPosition (  )  const [virtual]

Gets the position in the stream.

Implements Stream.

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

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

Implements Stream.

U32 MemStream::getStreamSize (  )  [virtual]

Gets the size of the stream.

Implements Stream.


Field Documentation

U32 const MemStream::cm_bufferSize [protected]




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