OmniPvdFileReadStream Class Reference

Used to abstract a file read stream. More...

#include <OmniPvdFileReadStream.h>

Inheritance diagram for OmniPvdFileReadStream:

Collaboration diagram for OmniPvdFileReadStream:

Public Member Functions
virtual void OMNI_PVD_CALL	setFileName (const char *fileName)=0
	Sets the file name of the file to read from.
virtual bool OMNI_PVD_CALL	openFile ()=0
	Opens the file.
virtual bool OMNI_PVD_CALL	closeFile ()=0
	Closes the file.
Public Member Functions inherited from OmniPvdReadStream
virtual uint64_t OMNI_PVD_CALL	readBytes (uint8_t *bytes, const uint64_t nbrBytes)=0
	Read n bytes from the shared memory buffer.
virtual uint64_t OMNI_PVD_CALL	skipBytes (const uint64_t nbrBytes)=0
	Skip n bytes from the shared memory buffer.
virtual bool OMNI_PVD_CALL	openStream ()=0
	Opens the read stream.
virtual bool OMNI_PVD_CALL	closeStream ()=0
	Closes the read stream.

Detailed Description

Used to abstract a file read stream.

Used to set the filename, opening and closing it.

Member Function Documentation

closeFile()

virtual bool OMNI_PVD_CALL OmniPvdFileReadStream::closeFile ( )

pure virtual

Closes the file.

Returns

True if the file closing was successfull

Implemented in OmniPvdFileReadStreamImpl.

openFile()

virtual bool OMNI_PVD_CALL OmniPvdFileReadStream::openFile ( )

pure virtual

Opens the file.

Returns

True if the file opening was successfull

Implemented in OmniPvdFileReadStreamImpl.

setFileName()

virtual void OMNI_PVD_CALL OmniPvdFileReadStream::setFileName ( const char *  fileName )

pure virtual

Sets the file name of the file to read from.

Parameters

fileName

The file name of the file to open

Implemented in OmniPvdFileReadStreamImpl.

---

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

• RavEngine/deps/physx/physx/pvdruntime/include/OmniPvdFileReadStream.h