Interface class for output (write) streams. More...

#include <datastream.h>

Inheritance diagram for Mezzanine::Resource::iOutStream:

Collaboration diagram for Mezzanine::Resource::iOutStream:

Public Member Functions
	iOutStream ()
	Class constructor.

virtual	~iOutStream ()
	Class destructor.

virtual StreamPos	GetWritePosition ()=0
	Gets the current write position in this stream. More...

virtual void	SetWritePosition (StreamPos Position)=0
	Sets the position of the write cursor explicitly. More...

virtual void	SetWritePosition (StreamOff Offset, SeekOrigin Origin)=0
	Sets the position of the write cursor. More...

virtual size_t	Write (const void *Buffer, StreamSize Size)=0
	Writes data to the stream. More...

Public Member Functions inherited from Mezzanine::Resource::iStreamBase
	iStreamBase ()
	Class constructor.

virtual	~iStreamBase ()
	Class destructor.

virtual Boole	Bad () const =0
	Gets whether or not a critical error was detected in a previous operation in the stream. More...

virtual void	ClearErrors ()=0
	Clears any stored error state on the stream. More...

virtual Boole	EoF () const =0
	Gets whether or not the current position is at the end of the stream. More...

virtual Boole	Fail () const =0
	Gets whether or not an otherwise silent and recoverable error was detected in a previous operation in the stream. More...

virtual StreamSize	GetSize () const =0
	Gets the size of the stream. More...

virtual Boole	IsValid () const =0
	Gets whether or not this stream is intact and ready for operations. More...

Detailed Description

Interface class for output (write) streams.

Definition at line 151 of file datastream.h.

Member Function Documentation

virtual StreamPos Mezzanine::Resource::iOutStream::GetWritePosition ( )

pure virtual

Gets the current write position in this stream.

virtual void Mezzanine::Resource::iOutStream::SetWritePosition ( StreamPos Position )

pure virtual

Sets the position of the write cursor explicitly.

Parameters

Position The position to be set.

virtual void Mezzanine::Resource::iOutStream::SetWritePosition	(	StreamOff	Offset,
		SeekOrigin	Origin
	)

pure virtual

Sets the position of the write cursor.

Parameters

Offset	The number of bytes to move the write cursor back(if negative) or forward(if positive).
Origin	The starting point to be considered for the offset.

virtual size_t Mezzanine::Resource::iOutStream::Write	(	const void *	Buffer,
		StreamSize	Size
	)

pure virtual

Writes data to the stream.

Parameters

Buffer	The memory buffer to write to this stream.
Size	The size of the buffer being passed in.

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