KFbxStream Class Reference

#include <kfbxstream.h>

List of all members.

---

Detailed Description

Generic base class for streamable data.

Currently it is only used for the Unload/Load of objects content when using the Peripheral objects.

Definition at line 49 of file kfbxstream.h.

Public Member Functions
virtual eStreamState	State ()
	Query the current state of the stream.
virtual bool	Open ()
	Open the stream.
virtual bool	Close ()
	Close the stream.
virtual bool	Flush ()
	Empties the internal data of the stream.
virtual int	Write (const void *pData, int pSize)
	Writes a memory block.
virtual int	Read (void *pData, int pSize) const
	Read bytes from the stream and store them in the memory block.

---

Member Function Documentation

virtual eStreamState State

(

)

[inline, virtual]

Query the current state of the stream.

Definition at line 63 of file kfbxstream.h.

virtual bool Open

(

)

[inline, virtual]

Open the stream.

Returns:

True if successful.

Definition at line 68 of file kfbxstream.h.

virtual bool Close

(

)

[inline, virtual]

Close the stream.

Returns:

True if successful.

Definition at line 73 of file kfbxstream.h.

virtual bool Flush

(

)

[inline, virtual]

Empties the internal data of the stream.

Returns:

True if successful.

Definition at line 78 of file kfbxstream.h.

virtual int Write	(	const void *	pData,
		int	pSize
	)			[inline, virtual]

Writes a memory block.

Parameters:

	pData	Pointer to the memory block to write.
	pSize	Size (in bytes) of the memory block to write.

Returns:

The number of bytes written in the stream.

Definition at line 85 of file kfbxstream.h.

virtual int Read	(	void *	pData,
		int	pSize
	)			const [inline, virtual]

Read bytes from the stream and store them in the memory block.

Parameters:

	pData	Pointer to the memory block where the read bytes are stored.
	pSize	Number of bytes read from the stream.

Returns:

The actual number of bytes successfully read from the stream.

Definition at line 95 of file kfbxstream.h.