PxDefaultFileInputData Class Reference

default implementation of a file read stream More...

#include <PxDefaultStreams.h>

Inheritance diagram for PxDefaultFileInputData:

Collaboration diagram for PxDefaultFileInputData:

Public Member Functions
	PxDefaultFileInputData (const char *name)
virtual	~PxDefaultFileInputData ()
virtual PxU32	read (void *dest, PxU32 count)
	read from the stream. The number of bytes read may be less than the number requested. More...
virtual void	seek (PxU32 pos)
	seek to the given offset from the start of the data. More...
virtual PxU32	tell () const
	return the current offset from the start of the data More...
virtual PxU32	getLength () const
	return the length of the input data More...
bool	isValid () const
Public Member Functions inherited from PxInputData
virtual	~PxInputData ()
Public Member Functions inherited from PxInputStream
virtual	~PxInputStream ()

Private Attributes
PxFileHandle	mFile
PxU32	mLength

Detailed Description

default implementation of a file read stream

See also

PxInputData

Constructor & Destructor Documentation

PxDefaultFileInputData()

PxDefaultFileInputData::PxDefaultFileInputData

(

const char *

name

)

~PxDefaultFileInputData()

virtual PxDefaultFileInputData::~PxDefaultFileInputData ( )

virtual

Member Function Documentation

getLength()

virtual PxU32 PxDefaultFileInputData::getLength ( ) const

virtual

return the length of the input data

Returns

size in bytes of the input data

Implements PxInputData.

isValid()

bool PxDefaultFileInputData::isValid

(

)

const

read()

virtual PxU32 PxDefaultFileInputData::read ( void *  dest, PxU32  count  )

virtual

read from the stream. The number of bytes read may be less than the number requested.

Parameters

[in]	dest	the destination address to which the data will be read
[in]	count	the number of bytes requested

Returns

the number of bytes read from the stream.

Implements PxInputStream.

seek()

virtual void PxDefaultFileInputData::seek ( PxU32  offset )

virtual

seek to the given offset from the start of the data.

Parameters

[in]

offset

the offset to seek to. If greater than the length of the data, this call is equivalent to seek(length);

Implements PxInputData.

tell()

virtual PxU32 PxDefaultFileInputData::tell ( ) const

virtual

return the current offset from the start of the data

Returns

the offset to seek to.

Implements PxInputData.

Member Data Documentation

mFile

PxFileHandle PxDefaultFileInputData::mFile

private

mLength

PxU32 PxDefaultFileInputData::mLength

private

---

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

• PxDefaultStreams.h