Assimp  v3.0 (July 2012)
Public Member Functions | Protected Member Functions
Assimp::IOStream Class Reference

CPP-API: Class to handle file I/O for C++. More...

List of all members.

Public Member Functions

virtual size_t FileSize () const =0
 Returns filesize Returns the filesize.
virtual void Flush ()=0
 Flush the contents of the file buffer (for writers) See fflush() for more details.
virtual size_t Read (void *pvBuffer, size_t pSize, size_t pCount)=0
 Read from the file.
virtual aiReturn Seek (size_t pOffset, aiOrigin pOrigin)=0
 Set the read/write cursor of the file.
virtual size_t Tell () const =0
 Get the current position of the read/write cursor.
virtual size_t Write (const void *pvBuffer, size_t pSize, size_t pCount)=0
 Write to the file.
virtual ~IOStream ()
 Destructor.

Protected Member Functions

 IOStream (void)
 Constructor protected, use IOSystem::Open() to create an instance.

Detailed Description

CPP-API: Class to handle file I/O for C++.

Derive an own implementation from this interface to provide custom IO handling to the Importer. If you implement this interface, be sure to also provide an implementation for IOSystem that creates instances of your custom IO class.


Constructor & Destructor Documentation

Assimp::IOStream::IOStream ( void  )
inlineprotected

Constructor protected, use IOSystem::Open() to create an instance.

class IOStream

Assimp::IOStream::~IOStream ( )
inlinevirtual

Destructor.

Deleting the object closes the underlying file, alternatively you may use IOSystem::Close() to release the file.


Member Function Documentation

virtual size_t Assimp::IOStream::FileSize ( ) const
pure virtual

Returns filesize Returns the filesize.

virtual void Assimp::IOStream::Flush ( )
pure virtual

Flush the contents of the file buffer (for writers) See fflush() for more details.

virtual size_t Assimp::IOStream::Read ( void *  pvBuffer,
size_t  pSize,
size_t  pCount 
)
pure virtual

Read from the file.

See fread() for more details This fails for write-only files

virtual aiReturn Assimp::IOStream::Seek ( size_t  pOffset,
aiOrigin  pOrigin 
)
pure virtual

Set the read/write cursor of the file.

Note that the offset is negative for aiOrigin_END. See fseek() for more details

virtual size_t Assimp::IOStream::Tell ( ) const
pure virtual

Get the current position of the read/write cursor.

See ftell() for more details

virtual size_t Assimp::IOStream::Write ( const void *  pvBuffer,
size_t  pSize,
size_t  pCount 
)
pure virtual

Write to the file.

See fwrite() for more details This fails for read-only files


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