FX::FXFileStream Class Reference

File Store Definition. More...

#include <FXFileStream.h>

Inheritance diagram for FX::FXFileStream:

Public Member Functions
	FXFileStream (const FXObject *cont=nullptr)
	Create file stream.
	FXFileStream (const FXString &filename, FXStreamDirection save_or_load=FXStreamLoad, FXuval size=8192UL)
	Create and open file stream.
FXbool	open (const FXString &filename, FXStreamDirection save_or_load=FXStreamLoad, FXuval size=8192UL)
	Open binary data file stream; allocate a buffer of the given size for the file I/O; the buffer must be at least 16 bytes.
virtual FXbool	close ()
	Close file stream.
FXlong	position () const
	Get position.
virtual FXbool	position (FXlong offset, FXWhence whence=FXFromStart)
	Move to position.
FXFileStream &	operator<< (const FXuchar &v)
	Save single items to stream.
FXFileStream &	operator<< (const FXchar &v)
FXFileStream &	operator<< (const FXbool &v)
FXFileStream &	operator<< (const FXushort &v)
FXFileStream &	operator<< (const FXshort &v)
FXFileStream &	operator<< (const FXuint &v)
FXFileStream &	operator<< (const FXint &v)
FXFileStream &	operator<< (const FXfloat &v)
FXFileStream &	operator<< (const FXdouble &v)
FXFileStream &	operator<< (const FXlong &v)
FXFileStream &	operator<< (const FXulong &v)
FXFileStream &	save (const FXuchar *p, FXuval n)
	Save arrays of items to stream.
FXFileStream &	save (const FXchar *p, FXuval n)
FXFileStream &	save (const FXbool *p, FXuval n)
FXFileStream &	save (const FXushort *p, FXuval n)
FXFileStream &	save (const FXshort *p, FXuval n)
FXFileStream &	save (const FXuint *p, FXuval n)
FXFileStream &	save (const FXint *p, FXuval n)
FXFileStream &	save (const FXfloat *p, FXuval n)
FXFileStream &	save (const FXdouble *p, FXuval n)
FXFileStream &	save (const FXlong *p, FXuval n)
FXFileStream &	save (const FXulong *p, FXuval n)
FXFileStream &	operator>> (FXuchar &v)
	Load single items from stream.
FXFileStream &	operator>> (FXchar &v)
FXFileStream &	operator>> (FXbool &v)
FXFileStream &	operator>> (FXushort &v)
FXFileStream &	operator>> (FXshort &v)
FXFileStream &	operator>> (FXuint &v)
FXFileStream &	operator>> (FXint &v)
FXFileStream &	operator>> (FXfloat &v)
FXFileStream &	operator>> (FXdouble &v)
FXFileStream &	operator>> (FXlong &v)
FXFileStream &	operator>> (FXulong &v)
FXFileStream &	load (FXuchar *p, FXuval n)
	Load arrays of items from stream.
FXFileStream &	load (FXchar *p, FXuval n)
FXFileStream &	load (FXbool *p, FXuval n)
FXFileStream &	load (FXushort *p, FXuval n)
FXFileStream &	load (FXshort *p, FXuval n)
FXFileStream &	load (FXuint *p, FXuval n)
FXFileStream &	load (FXint *p, FXuval n)
FXFileStream &	load (FXfloat *p, FXuval n)
FXFileStream &	load (FXdouble *p, FXuval n)
FXFileStream &	load (FXlong *p, FXuval n)
FXFileStream &	load (FXulong *p, FXuval n)
FXFileStream &	saveObject (const FXObject *v)
	Save object.
FXFileStream &	loadObject (FXObject *&v)
	Load object.
template<class TYPE >
FXFileStream &	operator>> (TYPE *&obj)
	Load object.
template<class TYPE >
FXFileStream &	operator<< (const TYPE *obj)
	Save object.
virtual	~FXFileStream ()
	Destructor.
Public Member Functions inherited from FX::FXStream
	FXStream (const FXObject *cont=nullptr)
	Construct stream with given container object. More...
FXbool	open (FXStreamDirection save_or_load, FXuchar *data=nullptr, FXuval size=8192UL, FXbool owned=false)
	Open stream for reading (FXStreamLoad) or for writing (FXStreamSave). More...
virtual FXbool	flush ()
	Flush buffer.
FXuval	getSpace () const
	Get available buffer space.
void	setSpace (FXuval sp)
	Set available buffer space.
void	setOwned (FXbool owned)
	Set buffer ownership flag.
FXbool	isOwned () const
	Get buffer ownership flag.
FXStreamStatus	status () const
	Get status code.
FXbool	eof () const
	Return true if at end of file or error.
void	setError (FXStreamStatus err)
	Set status code.
FXStreamDirection	direction () const
	Obtain stream direction.
const FXObject *	container () const
	Get parent object.
FXlong	position () const
	Get position.
void	swapBytes (FXbool s)
	Change swap bytes flag.
FXbool	swapBytes () const
	Get state of the swap bytes flag.
void	setBigEndian (FXbool big)
	Set stream to big endian mode if true. More...
FXbool	isBigEndian () const
	Return true if big endian mode.
FXStream &	operator<< (const FXuchar &v)
	Save single items to stream.
FXStream &	operator<< (const FXchar &v)
FXStream &	operator<< (const FXbool &v)
FXStream &	operator<< (const FXushort &v)
FXStream &	operator<< (const FXshort &v)
FXStream &	operator<< (const FXuint &v)
FXStream &	operator<< (const FXint &v)
FXStream &	operator<< (const FXfloat &v)
FXStream &	operator<< (const FXdouble &v)
FXStream &	operator<< (const FXlong &v)
FXStream &	operator<< (const FXulong &v)
FXStream &	save (const FXuchar *p, FXuval n)
	Save arrays of items to stream.
FXStream &	save (const FXchar *p, FXuval n)
FXStream &	save (const FXbool *p, FXuval n)
FXStream &	save (const FXushort *p, FXuval n)
FXStream &	save (const FXshort *p, FXuval n)
FXStream &	save (const FXuint *p, FXuval n)
FXStream &	save (const FXint *p, FXuval n)
FXStream &	save (const FXfloat *p, FXuval n)
FXStream &	save (const FXdouble *p, FXuval n)
FXStream &	save (const FXlong *p, FXuval n)
FXStream &	save (const FXulong *p, FXuval n)
FXStream &	operator>> (FXuchar &v)
	Load single items from stream.
FXStream &	operator>> (FXchar &v)
FXStream &	operator>> (FXbool &v)
FXStream &	operator>> (FXushort &v)
FXStream &	operator>> (FXshort &v)
FXStream &	operator>> (FXuint &v)
FXStream &	operator>> (FXint &v)
FXStream &	operator>> (FXfloat &v)
FXStream &	operator>> (FXdouble &v)
FXStream &	operator>> (FXlong &v)
FXStream &	operator>> (FXulong &v)
FXStream &	load (FXuchar *p, FXuval n)
	Load arrays of items from stream.
FXStream &	load (FXchar *p, FXuval n)
FXStream &	load (FXbool *p, FXuval n)
FXStream &	load (FXushort *p, FXuval n)
FXStream &	load (FXshort *p, FXuval n)
FXStream &	load (FXuint *p, FXuval n)
FXStream &	load (FXint *p, FXuval n)
FXStream &	load (FXfloat *p, FXuval n)
FXStream &	load (FXdouble *p, FXuval n)
FXStream &	load (FXlong *p, FXuval n)
FXStream &	load (FXulong *p, FXuval n)
FXStream &	saveObject (const FXObject *v)
	Save object.
FXStream &	loadObject (FXObject *&v)
	Load object.
FXStream &	addObject (const FXObject *v)
	Add object without saving or loading.
template<class TYPE >
FXStream &	operator>> (TYPE *&obj)
	Load object.
template<class TYPE >
FXStream &	operator<< (const TYPE *obj)
	Save object.
virtual	~FXStream ()
	Destructor.

Protected Member Functions
virtual FXuval	writeBuffer (FXuval count)
	Write at least count bytes from the buffer; returns number of bytes available to be written.
virtual FXuval	readBuffer (FXuval count)
	Read at least count bytes into the buffer; returns number of bytes available to be read.

Protected Attributes
FXFile	file
Protected Attributes inherited from FX::FXStream
FXHash	hash
const FXObject *	parent
FXuchar *	begptr
FXuchar *	endptr
FXuchar *	wrptr
FXuchar *	rdptr
FXlong	pos
FXStreamDirection	dir
FXStreamStatus	code
FXuint	seq
FXbool	owns
FXbool	swap

Detailed Description

File Store Definition.

---

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

• /home/jeroen/FOX/fox/fox-1.7.85/include/FXFileStream.h